data/TWiki/ATasteOfTWiki.txt,v
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
head	1.7;
colas@0
     2
access;
colas@0
     3
symbols;
colas@0
     4
locks; strict;
colas@0
     5
comment	@# @;
colas@0
     6
colas@0
     7
colas@0
     8
1.7
colas@0
     9
date	2008.01.22.03.21.33;	author TWikiContributor;	state Exp;
colas@0
    10
branches;
colas@0
    11
next	1.6;
colas@0
    12
colas@0
    13
1.6
colas@0
    14
date	2007.01.16.04.12.04;	author TWikiContributor;	state Exp;
colas@0
    15
branches;
colas@0
    16
next	1.5;
colas@0
    17
colas@0
    18
1.5
colas@0
    19
date	2006.04.01.05.55.03;	author TWikiContributor;	state Exp;
colas@0
    20
branches;
colas@0
    21
next	1.4;
colas@0
    22
colas@0
    23
1.4
colas@0
    24
date	2006.02.01.12.01.15;	author TWikiContributor;	state Exp;
colas@0
    25
branches;
colas@0
    26
next	1.3;
colas@0
    27
colas@0
    28
1.3
colas@0
    29
date	2004.08.22.21.49.01;	author PeterThoeny;	state Exp;
colas@0
    30
branches;
colas@0
    31
next	1.2;
colas@0
    32
colas@0
    33
1.2
colas@0
    34
date	2004.08.15.05.05.25;	author PeterThoeny;	state Exp;
colas@0
    35
branches;
colas@0
    36
next	1.1;
colas@0
    37
colas@0
    38
1.1
colas@0
    39
date	2004.03.18.08.31.00;	author PeterThoeny;	state Exp;
colas@0
    40
branches;
colas@0
    41
next	;
colas@0
    42
colas@0
    43
colas@0
    44
desc
colas@0
    45
@none
colas@0
    46
@
colas@0
    47
colas@0
    48
colas@0
    49
1.7
colas@0
    50
log
colas@0
    51
@buildrelease
colas@0
    52
@
colas@0
    53
text
colas@0
    54
@%META:TOPICINFO{author="TWikiContributor" date="1199519964" format="1.1" version="7"}%
colas@0
    55
This is a short introductory training course for TWiki beginners.
colas@0
    56
colas@0
    57
%SLIDESHOWSTART%
colas@0
    58
colas@0
    59
---++ A Taste of TWiki
colas@0
    60
<img src="%ATTACHURL%/hula.gif" alt="Hula girl"  width="113" height="111" align="right" />
colas@0
    61
The basic function of TWiki is a Wiki (if that helps!)
colas@0
    62
colas@0
    63
A Wiki is like a web site, except that you can edit the content in your browser
colas@0
    64
colas@0
    65
   * "Wiki" is short for "wiki wiki", the Hawaiian for "Quick"
colas@0
    66
   * The idea originates from [[http://www.hyperdictionary.com/computing/hypercard][Macintosh Hypercard]], via [[http://www.c2.com/cgi/wiki?WardCunningham][Ward Cunningham]]
colas@0
    67
   * In Ward's words, Wiki is _"the simplest online database that could possibly work"_
colas@0
    68
   * A Wiki is basically a shared, online, persistent whiteboard
colas@0
    69
colas@0
    70
---++ TWiki Wiki
colas@0
    71
<img src="%ATTACHURL%/whiteboard.gif" alt="Whiteboard" width="240" height="160" align="right" />
colas@0
    72
TWiki implements the basic Wiki idea of a shared whiteboard
colas@0
    73
colas@0
    74
   * Anyone can add content<br />... or change what is written<br />... or change the organisation of the content
colas@0
    75
   * Whatever what you write is<br />... nicely presented<br />... remembered... and never forgotten
colas@0
    76
colas@0
    77
TWiki also acts as an "application platform" to integrate a number of other functions.
colas@0
    78
colas@0
    79
TWiki is an Open-Source development on [[http://twiki.org/][TWiki.org]]
colas@0
    80
   * led by TWiki:Main.PeterThoeny
colas@0
    81
   * with over 100 regular contributors in many countries
colas@0
    82
colas@0
    83
---++ Where is it used?
colas@0
    84
TWiki is mainly used in commercial environments, often on corporate intranets
colas@0
    85
   * Examples: Disney, British Telecom, SAP, Wind River, Motorola, <a href="http://udn.epicgames.com/Main/WebHome">Epic Games</a><br />
colas@0
    86
     <table cellspacing="20"><tr>
colas@0
    87
     <td><img src="%ATTACHURL%/Disney_logo.gif" alt="Disney logo"  width="80" height="31" /></td>
colas@0
    88
     <td><img src="%ATTACHURL%/BT_logo.gif" alt="British Telecom logo"  width="80" height="41" /></td>
colas@0
    89
     <td><img src="%ATTACHURL%/SAP_logo.gif" alt="SAP logo"  width="80" height="40" /></td>
colas@0
    90
     <td><img src="%ATTACHURL%/Motorola_logo.gif" alt="Motorola logo"  width="80" height="65" /></td>
colas@0
    91
     <td><img src="%ATTACHURL%/EpicGames_logo.gif" alt="Epic Games logo"  width="80" height="65" /></td>
colas@0
    92
     </tr></table>
colas@0
    93
colas@0
    94
A number of public Wiki sites also use TWiki
colas@0
    95
   * Examples: <br /> https://twiki.cern.ch/twiki/bin/view/ <br /> http://csci.mrs.umn.edu/twiki/view
colas@0
    96
colas@0
    97
---++ TWiki Features
colas@0
    98
TWiki builds on the original Wiki concept and adds a number of features that make it very useful in a business environment.
colas@0
    99
   * TWiki pages are fully revision controlled, so a record of every change to every page is kept <table border="0" cellpadding="3" cellspacing="0"><tr><td bgcolor="#D0D0D0"><font color="black" size="-1">r6 <a>&lt;</a> r5 <a>&lt;</a> r4</font></td></tr></table>
colas@0
   100
   * The look-and-feel is highly configurable, through use of templates
colas@0
   101
<table width="100%"><tr><td valign="top">
colas@0
   102
   * A "plugins" interface eases
colas@0
   103
      * customisation
colas@0
   104
      * extension
colas@0
   105
      * application integration
colas@0
   106
</td><td align="right"><img src="%ATTACHURL%/lego.gif" alt="" /></td></tr></table>
colas@0
   107
colas@0
   108
---++ Applications of basic TWiki
colas@0
   109
Basic TWiki can be used as:
colas@0
   110
   * A whiteboard
colas@0
   111
   * A document repository
colas@0
   112
   * A collaborative authoring environment
colas@0
   113
   * A notebook / scrapbook
colas@0
   114
   * A chat room   
colas@0
   115
colas@0
   116
---++ Extended applications
colas@0
   117
TWiki-with-extensions has been used as:
colas@0
   118
   * A Content Management System (CMS) for websites
colas@0
   119
   * A presentation development tool
colas@0
   120
   * A Blog
colas@0
   121
   * A database
colas@0
   122
   * A project management system
colas@0
   123
   * A tracking tool
colas@0
   124
   * (<i>truth is, we don't really know its limits!</i>)
colas@0
   125
colas@0
   126
---++ Structure of a TWiki page
colas@0
   127
TWiki pages are usually organised into three parts:
colas@0
   128
   * A header
colas@0
   129
   * A body
colas@0
   130
   * A footer
colas@0
   131
colas@0
   132
   * The header and the footer are generated by the system
colas@0
   133
   * The body contains the text of the page, as entered by you
colas@0
   134
TWiki is very configurable, and the look can change. However the essentials will all be there on the page (somewhere!)
colas@0
   135
colas@0
   136
---++ The Page Header
colas@0
   137
The header of a TWiki page is generally highlighted in colour, and will usually contain an icon that gives you an idea of where you are, such as a company logo.
colas@0
   138
<table width="90%" border="0" cellpadding="3" cellspacing="0" bgcolor="white">
colas@0
   139
 <tr>
colas@0
   140
  <td bgcolor="#D0D0D0" rowspan="2" valign="top" width="1%">
colas@0
   141
    <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="TWiki home" />
colas@0
   142
   </td><td>
colas@0
   143
   <font size="+0"> My<nop>Co.My<nop>Topic </font>
colas@0
   144
  </td><td align="right">
colas@0
   145
    <font size="-1" color="black">Webs:<br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a></font>
colas@0
   146
  </td>
colas@0
   147
 </tr>
colas@0
   148
 <tr bgcolor="#D0D0D0">
colas@0
   149
  <td colspan="2">
colas@0
   150
    <font size="-1" color="black">[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go <input type="text" name="topic" size="16" /></font>
colas@0
   151
  </td>
colas@0
   152
 </tr>
colas@0
   153
</table>
colas@0
   154
It will also usually contain a number of 'links' that you can click on. You will generally see:
colas@0
   155
   * [[WebChanges][Changes]] - gives you a list of recent changes
colas@0
   156
   * [[WebIndex][Index]] - gives you a full index
colas@0
   157
   * [[WebSearch][Search]] - takes you to a search page, where you can search all the text
colas@0
   158
   * Go <input type="text" name="topic" size="16" /> - lets you type in the name of a page you already know
colas@0
   159
colas@0
   160
---++ The Page Header ... continued
colas@0
   161
<table width="90%" border="0" cellpadding="3" cellspacing="0" bgcolor="white">
colas@0
   162
 <tr>
colas@0
   163
  <td bgcolor="#D0D0D0" rowspan="2" valign="top" width="1%">
colas@0
   164
    <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="TWiki home" />
colas@0
   165
   </td><td>
colas@0
   166
    <font size="+0"> My<nop>Co.My<nop>Topic </font>
colas@0
   167
  </td><td align="right">
colas@0
   168
    <font size="-1" color="black">Webs:<br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a></font>
colas@0
   169
  </td>
colas@0
   170
 </tr>
colas@0
   171
 <tr bgcolor="#D0D0D0">
colas@0
   172
  <td colspan="2">
colas@0
   173
    <font size="-1" color="black">[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go <input type="text" name="topic" size="16" /></font>
colas@0
   174
  </td>
colas@0
   175
 </tr>
colas@0
   176
</table>
colas@0
   177
You may also see in the header (usually at the top right) a list of the TWiki "webs". A web is a collection of pages that are related closely together
colas@0
   178
   * For example, we might have a web called "Enemies", where we keep all we know about our enemies, and another called "Friends"
colas@0
   179
   * There's usually a safe play web called something like "Sandbox" or "Scratch", where you can create pages just to try things out
colas@0
   180
   * And some admin areas, like "%USERSWEB%" and "%SYSTEMWEB%"
colas@0
   181
colas@0
   182
---++ The Page Footer
colas@0
   183
The footer of the page is also highlighted in colour, and is usually where you will find the links that let you change the content.
colas@0
   184
<table bgcolor="white" width="90%" border="0" cellpadding="3" cellspacing="0">
colas@0
   185
 <tr bgcolor="#D0D0D0">
colas@0
   186
  <td valign="top" colspan="2">
colas@0
   187
    <font size="-1" color="black"> <a href="none"><b>Edit</b></a>
colas@0
   188
    |  <a href="none">Attach</a>
colas@0
   189
    |  <a href="none">Diffs</a>  | r2 <a href="none">&gt;</a> r1
colas@0
   190
    |  <a href="none">More</a> </font>
colas@0
   191
  </td>
colas@0
   192
 </tr>
colas@0
   193
 <tr>
colas@0
   194
  <td valign="top">
colas@0
   195
    <font size="-1" color="black">Revision r1.2 - 13 Feb 2004 - 09:09 GMT - <a href="none">TWikiPresenter</a> </font>
colas@0
   196
  </td>
colas@0
   197
  <td width="40%" valign="top">
colas@0
   198
   <font size="-2">%WEBCOPYRIGHT% </font>
colas@0
   199
  </td>
colas@0
   200
 </tr>
colas@0
   201
</table>
colas@0
   202
   * The <a>Edit</a> link takes you to an interactive page where you can change the page content
colas@0
   203
   * The <a>Attach</a> link lets you attach files
colas@0
   204
   * The other links invoke other, more complex, functions, mainly to do with revision tracking - they can safely be ignored for now
colas@0
   205
colas@0
   206
---++ Editing Pages
colas@0
   207
   * You've read a page, and you disagree with it violently! It says:<br /> _Everyone_ *knows* that =the world= is an <font color="blue"><u>OblateSpheroid</u></font><br />But you know for a fact it is flat! ;-)
colas@0
   208
   * You've clicked the edit link, and an edit page has appeared. But it doesn't look much like what was on the page before - it's full of strange hieroglyphics!
colas@0
   209
<code>_Everyone_ <nop>*knows* that <nop>=the world= is an Oblate<nop>Spheroid</code>
colas@0
   210
   * Now what?
colas@0
   211
colas@0
   212
---++ What's in a page
colas@0
   213
   * The hieroglyphics are what's known as "TWiki Markup" or "formatting"
colas@0
   214
   * They are a really simple way of telling the browser how you want the page to look
colas@0
   215
   * You don't have to use them
colas@0
   216
      * TWiki understands pages in plain text just fine.<br /><br /> <code>Actually it is perfectly and absolutely flat</code><br /><br /> appears as <br /><br /> Actually it is perfectly and absolutely flat
colas@0
   217
colas@0
   218
---++ Formatting just makes pages prettier
colas@0
   219
... and easier to read<br /><br />
colas@0
   220
<code>_Actually_ it is <nop>*perfectly* and <nop>__absolutely__ flat</code><br /><br /> appears as <br /><br /> _Actually_ it is *perfectly* and __absolutely__ flat
colas@0
   221
   * A full description of all the formatting can be found in the %SYSTEMWEB%.TextFormattingRules and %SYSTEMWEB%.TextFormattingFAQ
colas@0
   222
   * The best thing to do is just to type until you get stuck
colas@0
   223
      * then follow the link on the edit page to the help.
colas@0
   224
colas@0
   225
---++ Commonly used formatting
colas@0
   226
TWiki understands pages in plain text just fine, but you can %RED% __jazz__ %ENDCOLOR%%GREEN% _them_ %ENDCOLOR%%BLUE% *up* %ENDCOLOR% using some simple formatting shortcuts. Here are some of the more commonly used ones:
colas@0
   227
   * <nop>---+ indicates a heading. Add more +'s for a deeper heading.
colas@0
   228
    | *You type* | *You see* |
colas@0
   229
    | %BLACK%<code>---+ This is a heading</code>%ENDCOLOR% | <h1>%BLACK%This is a heading%ENDCOLOR%</h1> |
colas@0
   230
    | %BLACK%<code>---++ And so is this</code>%ENDCOLOR% | <h2>%BLACK%And so is this%ENDCOLOR%</h2> |
colas@0
   231
   * %<nop>TOC% will insert a table of contents<br />
colas@0
   232
colas@0
   233
---++ More common formatting
colas@0
   234
   * A blank line gives a paragraph break<br />
colas@0
   235
   * <nop>--- on a line of its own gives a horizontal bar
colas@0
   236
   * Text in stars <nop>*like this* looks *like this* <br />
colas@0
   237
   * Text in underscores <nop>_like this_ looks _like this_ <br />
colas@0
   238
   * Text in equals signs <nop>=like this= looks =like this= <br />
colas@0
   239
   * Bulleted lists use three spaces followed by an asterisk (<tt>*</tt>) at the start of the line
colas@0
   240
      * The depth of the bullet is given by the number of spaces, in multiples of three
colas@0
   241
| *You type* | *You see* |
colas@0
   242
| <font color="black"><code>&nbsp;&nbsp;&nbsp;* Bullet</code><br /><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Sub-bullet</code></font> | <ul><li><font color="black">Bullet</font><ul><li><font color="black">Sub-bullet</font></li></ul></li></ul> |
colas@0
   243
   * Numbered lists use a number in place of the <tt>*</tt>.  The list is numbered automatically, so you can just use a =1=
colas@0
   244
colas@0
   245
---++ Even more.....
colas@0
   246
   * You can create a table using vertical bars:
colas@0
   247
<verbatim>
colas@0
   248
     | Cat | Feline |
colas@0
   249
     | Bear | Ursine |
colas@0
   250
     | Wolf | Lupine |
colas@0
   251
</verbatim>
colas@0
   252
   * appears as
colas@0
   253
     | <font color="black">Cat</font> | <font color="black">Feline</font> |
colas@0
   254
     | <font color="black">Bear</font> | <font color="black">Ursine</font> |
colas@0
   255
     | <font color="black">Wolf</font> | <font color="black">Lupine</font> |
colas@0
   256
   * %<nop>RED% .... %<nop>ENDCOLOR% will change the colour of the enclosed text. Lots of colours are available (%RED%%<nop>RED%%ENDCOLOR%, %GREEN%%<nop>GREEN%%ENDCOLOR%, %BLUE%%<nop>BLUE%%ENDCOLOR% etc)
colas@0
   257
colas@0
   258
---++ Wiki<nop>Words
colas@0
   259
   * One special hieroglyph that is *very important* is a BumpyWord
colas@0
   260
      * a word that starts with uppercase, then some lowercase, then more uppercase (a.k.a <nop>CamelCase)
colas@0
   261
   * This has a special meaning to TWiki; if it matches the name of another topic, TWiki will automatically create a link to that page for you.
colas@0
   262
   * If there is no such page, then the word is highlighted and a question mark is put after the word, LikeThis
colas@0
   263
   * If you click on the question mark, then TWiki will invite you to create that page.
colas@0
   264
colas@0
   265
   * This lets you enter the names of topics you _think_ should exist, but don't yet
colas@0
   266
      * You, or someone else, can always come along later and click on the question mark!
colas@0
   267
colas@0
   268
---++ Referencing other pages and URLs
colas@0
   269
   * BumpyWords automatically link to the target page
colas@0
   270
      * You can make these links easier to read using square brackets:
colas@0
   271
         * <code>[<nop>[BumpyWords][bumpy words]] appears as [[BumpyWords][bumpy words]]</code>
colas@0
   272
   * An ordinary URL pasted into text will appear as a link - http://www.google.com
colas@0
   273
      * You can also prettify URLs using square brackets:
colas@0
   274
         * <code>[<nop>[http://www.google.com/][Google]]</code> appears as [[http://www.google.com/][Google]]
colas@0
   275
   * Use %<nop>SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See %SYSTEMWEB%.TWikiVariables for full details.
colas@0
   276
colas@0
   277
---++ More formatting
colas@0
   278
   * There's *lots* more formatting available, see %SYSTEMWEB%.TextFormattingRules and %SYSTEMWEB%.TextFormattingFAQ
colas@0
   279
   * _If you are a real masochist, you can even enter raw HTML tags!_
colas@0
   280
   * *Important* to _disable_ unwanted formatting, use =&lt;nop&gt;=
colas@0
   281
      * <code>&lt;nop&gt;_word_</code> appears as <nop>_word_
colas@0
   282
colas@0
   283
---++ Creating new pages
colas@0
   284
   * Alternative ways:
colas@0
   285
      * Click on the question mark after a BumpyWord
colas@0
   286
      * Type in the name of the topic in the "Go:" box
colas@0
   287
      * Type in the name of the topic in the URL
colas@0
   288
   * Any time you try to visit a page that doesn't exist, TWiki will invite you to create it.
colas@0
   289
   * Make sure the names of topics are always BumpyWords.
colas@0
   290
colas@0
   291
---++ Attachments
colas@0
   292
   * Attachments are files which have been uploaded and attached to a TWiki page using the 'Attach' function in the footer.
colas@0
   293
<table border="0" cellspacing="2" cellpadding="1" bgcolor="white">
colas@0
   294
 <tr>
colas@0
   295
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99">Attachment</font> <img src="http://TWiki.org/p/pub/TWiki/TablePlugin/diamond.gif" border="0" alt="sort" /></a></th>
colas@0
   296
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Action</font></a> </th>
colas@0
   297
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Size</font></a> </th>
colas@0
   298
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Date</font></a> </th>
colas@0
   299
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Who</font></a> </th>
colas@0
   300
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Comment</font></a> </th>
colas@0
   301
 </tr>
colas@0
   302
 <tr>
colas@0
   303
  <td valign="top" bgcolor="#F8F8F8">
colas@0
   304
   <img src="http://TWiki.org/p/pub/icn/zip.gif" width="16" height="16" align="top" alt="" border="0" />
colas@0
   305
   <font color="black"><a href="none">myco.gif</a></font>
colas@0
   306
  </td>
colas@0
   307
  <td align="center" valign="top" bgcolor="#F8F8F8">
colas@0
   308
   <font color="black"><a href="none">manage</a></font>
colas@0
   309
  </td>
colas@0
   310
  <td align="right" valign="top" bgcolor="#F8F8F8"><font color="black"> 9.6&nbsp;K </font></td>
colas@0
   311
  <td valign="top" bgcolor="#F8F8F8"> <font color="black"> 13 Feb 2004 - 18:41 </font></td>
colas@0
   312
  <td valign="top" bgcolor="#F8F8F8"> <font color="black"> <a href="none">MushroomMagicMan</a> </font></td>
colas@0
   313
  <td valign="top" bgcolor="#F8F8F8"> <font color="black">Attached image file </font></td></tr>
colas@0
   314
</table>
colas@0
   315
   * Attachments are simply files, in whatever format you want.
colas@0
   316
   * TWiki recognises some file formats, notably image files (.gif)
colas@0
   317
      * Write =%<nop>ATTACHURL%/myco.gif= to see this: %ATTACHURL%/myco.gif
colas@0
   318
colas@0
   319
---++ Wiki Culture
colas@0
   320
Enough about mechanics; how is a wiki actually _used_ ? Well, that's really up to you, but there are a number of tricks that the wiki community has developed for collaborative writing that work pretty well:
colas@0
   321
   * What can I edit?
colas@0
   322
      * Anything. But it's good etiquette to sign your contributions
colas@0
   323
      * If someone doesn't want you to edit a page, it's up to them to say so, clearly, on the page
colas@0
   324
   * But what if somebody doesn't like my edits?
colas@0
   325
      * In TWiki, they can always recover the old revision and re-instantiate it if they really want to
colas@0
   326
      * Otherwise they should regard your changes as an opportunity for discussion
colas@0
   327
   * Pages in wiki are (usually) in one of three "modes"
colas@0
   328
      * Document<nop>Mode
colas@0
   329
      * Thread<nop>Mode
colas@0
   330
      * Structured<nop>Mode
colas@0
   331
TWiki doesn't automatically distinguish between these modes; they are purely semantic.
colas@0
   332
colas@0
   333
---++ Document<nop>Mode
colas@0
   334
   * A page in Document<nop>Mode usually comprises a contribution which is written in the third person and left unsigned.
colas@0
   335
   * The piece of text is community property
colas@0
   336
      * It may have multiple and changing authors as it is updated to reflect the community consensus.
colas@0
   337
colas@0
   338
---++ Thread<nop>Mode
colas@0
   339
   * Thread mode is a form of discussion where the community holds a conversation
colas@0
   340
   * The discussion usually starts out with a statement, at the top of the page, that is subsequently discussed
colas@0
   341
   * The page may be periodically "refactored" (edited) to remove some of the comments
colas@0
   342
      * As long as the comment is accurately reflected in what replaces it, nobody usually minds.
colas@0
   343
      * Remember to always maintain a complete list of contributors, though!
colas@0
   344
You may see a comment box on a page in Thread<nop>Mode that makes it easy to quickly add your inputs. Typing in a comment and adding it to a page this way is known as "blogging" ;-)
colas@0
   345
   * Thread<nop>Mode is rather like an e-mail thread
colas@0
   346
      * Except that new comments are usually added to the end
colas@0
   347
   * Thread<nop>Mode pages often get refactored into Document<nop>Mode
colas@0
   348
colas@0
   349
---++ Structured<nop>Mode
colas@0
   350
   * A page in Structured<nop>Mode follows some predefined structure for example
colas@0
   351
      * An agenda
colas@0
   352
      * A set of meeting minutes
colas@0
   353
      * A requirement description.
colas@0
   354
   * Pages in Structured<nop>Mode will usually have rules governing how they are edited.
colas@0
   355
colas@0
   356
---++ Other Wiki tricks - Categories
colas@0
   357
   * A Wiki trick for grouping pages together
colas@0
   358
   * Example: to group together a set of pages all relating to the weather:
colas@0
   359
      1 Create a page called 'Category<nop>Weather'
colas@0
   360
      1 Put a SEARCH that contains the word 'Category<nop>Weather' into it
colas@0
   361
         * <code>%<nop>SEARCH{"Category<nop>Weather" nosearch="on" nosummary="on"}%</code>
colas@0
   362
      1 Put the BumpyWord 'Category<nop>Weather' on all the pages relating to the weather<br />(usually at the bottom, below a horizontal bar)
colas@0
   363
colas@0
   364
---++ Contributed features
colas@0
   365
Basic TWiki is rich with features, but is enriched even further by the addition of optional plug-in modules that may (or may not!) be installed in your TWiki. These are classified as either __skins__ (modules that change the look-and-feel) and __plugins__ (modules that enhance functionality).
colas@0
   366
colas@0
   367
Here's a brief description of some of the more common plugins, together with the tags you might expect to see in topics if they are used. You can find out more by visiting the plugin pages.
colas@0
   368
   * Action<nop>TrackerPlugin: Support *action tags* in topics, with *automatic notification* of action statuses <code>%ACTION...</code>
colas@0
   369
   * Calendar<nop>Plugin: Show a *monthly calendar* with highlighted events <code>%CALENDAR...%</code>
colas@0
   370
   * Comment<nop>Plugin: Support *rapid entry of short comments* (also known as <b>blogging</b>) <code>%COMMENT...</code>
colas@0
   371
   * Chart<nop>Plugin: Create PNG or GIF *charts to visualize data in TWiki tables* <code>%CHART...</code>
colas@0
   372
   * Edit<nop>TablePlugin: Edit TWiki tables using *edit fields and drop down boxes* <code>%EDITTABLE...</code>
colas@0
   373
   * Interwiki<nop>Plugin: Define *shortcuts* for links to *common external sites*
colas@0
   374
colas@0
   375
---++ More plugins
colas@0
   376
   * Render<nop>ListPlugin: Render *bullet lists in a variety of formats* <code>%RENDERLIST...</code>
colas@0
   377
   * Slide<nop>ShowPlugin: *Create web based presentations* based on topics with headings <code>%SLIDESHOWSTART...</code>
colas@0
   378
   * Spread<nop>SheetPlugin: Add *spreadsheet calculations* like "$SUM( $ABOVE() )" to tables located in TWiki topics <code>%CALC...</code>
colas@0
   379
   * Table<nop>Plugin: Control *presentation and sorting of tables* <code>%TABLE...</code>
colas@0
   380
   * TWiki<nop>DrawPlugin: Add *quick sketches* to pages <code>%DRAWING...</code>
colas@0
   381
The following plugins are installed on this TWiki: %ACTIVATEDPLUGINS%
colas@0
   382
colas@0
   383
There are many other plugins, see http://TWiki.org/cgi-bin/view/Plugins
colas@0
   384
colas@0
   385
---++ Credits and Acknowledgements
colas@0
   386
   * This training was developed by TWiki:Main.CrawfordCurrie on behalf of [[http://www.oxamer.com/][Oxamer]], one of the companies in the [[http://www.ogt.co.uk/][Oxford Gene Technology]] group.
colas@0
   387
   * Valuable contributions were also received from the TWiki Open Source community; special mentions go to:
colas@0
   388
      * TWiki:Main.WalterMundt
colas@0
   389
      * TWiki:Main.SvenDowideit
colas@0
   390
   * The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback
colas@0
   391
%SLIDESHOWEND%
colas@0
   392
colas@0
   393
__Related topics:__ WelcomeGuest, TWikiTutorial, ATasteOfTWikiTemplate
colas@0
   394
colas@0
   395
@
colas@0
   396
colas@0
   397
colas@0
   398
1.6
colas@0
   399
log
colas@0
   400
@buildrelease
colas@0
   401
@
colas@0
   402
text
colas@0
   403
@d1 1
colas@0
   404
a1 1
colas@0
   405
%META:TOPICINFO{author="TWikiContributor" date="1163993253" format="1.1" version="6"}%
colas@0
   406
d127 1
colas@0
   407
a127 1
colas@0
   408
   * And some admin areas, like "%MAINWEB%" and "%TWIKIWEB%"
colas@0
   409
d168 1
colas@0
   410
a168 1
colas@0
   411
   * A full description of all the formatting can be found in the %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
colas@0
   412
d197 1
colas@0
   413
a197 1
colas@0
   414
     | Wolf | Vulpine |
colas@0
   415
d202 1
colas@0
   416
a202 1
colas@0
   417
     | <font color="black">Wolf</font> | <font color="black">Vulpine</font> |
colas@0
   418
d222 1
colas@0
   419
a222 1
colas@0
   420
   * Use %<nop>SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See %TWIKIWEB%.TWikiVariables for full details.
colas@0
   421
d225 1
colas@0
   422
a225 1
colas@0
   423
   * There's *lots* more formatting available, see %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
colas@0
   424
@
colas@0
   425
colas@0
   426
colas@0
   427
1.5
colas@0
   428
log
colas@0
   429
@buildrelease
colas@0
   430
@
colas@0
   431
text
colas@0
   432
@d1 1
colas@0
   433
a1 1
colas@0
   434
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="5"}%
colas@0
   435
d4 1
colas@0
   436
a4 1
colas@0
   437
%SLIDESHOWSTART{template="ATasteOfTWikiTemplate"}%
colas@0
   438
d7 1
colas@0
   439
a7 3
colas@0
   440
<table cellspacing="10"><tr><td>
colas@0
   441
<img src="%ATTACHURL%/hula.gif" alt="Hula girl"  width="113" height="111" /></td>
colas@0
   442
<td>
colas@0
   443
a15 1
colas@0
   444
</td></tr></table>
colas@0
   445
d18 2
colas@0
   446
a19 4
colas@0
   447
<table cellspacing="10"><tr><td>
colas@0
   448
<img src="%ATTACHURL%/whiteboard.gif" alt="Whiteboard" width="240" height="160" />
colas@0
   449
</td>
colas@0
   450
<td>TWiki implements the basic Wiki idea of a shared whiteboard
colas@0
   451
a22 1
colas@0
   452
</td></tr></table>
colas@0
   453
d42 1
colas@0
   454
a42 1
colas@0
   455
   * Examples: <br /> https://uimon.cern.ch/twiki/bin/view/ <br /> http://csci.mrs.umn.edu/twiki/view
colas@0
   456
d315 1
colas@0
   457
a315 1
colas@0
   458
   * Action<nop>TrackerPlugin: Support *action tags* in topics, with *automatic notification* of action statii <code>%ACTION...</code>
colas@0
   459
d341 1
colas@0
   460
@
colas@0
   461
colas@0
   462
colas@0
   463
1.4
colas@0
   464
log
colas@0
   465
@buildrelease
colas@0
   466
@
colas@0
   467
text
colas@0
   468
@d1 1
colas@0
   469
a1 2
colas@0
   470
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="4"}%
colas@0
   471
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="4"}%
colas@0
   472
d14 4
colas@0
   473
a17 4
colas@0
   474
	* "Wiki" is short for "wiki wiki", the Hawaiian for "Quick"
colas@0
   475
	* The idea originates from [[http://www.hyperdictionary.com/computing/hypercard][Macintosh Hypercard]], via [[http://www.c2.com/cgi/wiki?WardCunningham][Ward Cunningham]]
colas@0
   476
	* In Ward's words, Wiki is _"the simplest online database that could possibly work"_
colas@0
   477
	* A Wiki is basically a shared, online, persistent whiteboard
colas@0
   478
d26 2
colas@0
   479
a27 2
colas@0
   480
	* Anyone can add content<br />... or change what is written<br />... or change the organisation of the content
colas@0
   481
	* Whatever what you write is<br />... nicely presented<br />... remembered... and never forgotten
colas@0
   482
d33 2
colas@0
   483
a34 2
colas@0
   484
	* led by TWiki:Main.PeterThoeny
colas@0
   485
	* with over 100 regular contributors in many countries
colas@0
   486
d38 8
colas@0
   487
a45 8
colas@0
   488
	* Examples: Disney, British Telecom, SAP, Wind River, Motorola, <a href="http://udn.epicgames.com/Main/WebHome">Epic Games</a><br />
colas@0
   489
	  <table cellspacing="20"><tr>
colas@0
   490
	  <td><img src="%ATTACHURL%/Disney_logo.gif" alt="Disney logo"  width="80" height="31" /></td>
colas@0
   491
	  <td><img src="%ATTACHURL%/BT_logo.gif" alt="British Telecom logo"  width="80" height="41" /></td>
colas@0
   492
	  <td><img src="%ATTACHURL%/SAP_logo.gif" alt="SAP logo"  width="80" height="40" /></td>
colas@0
   493
	  <td><img src="%ATTACHURL%/Motorola_logo.gif" alt="Motorola logo"  width="80" height="65" /></td>
colas@0
   494
	  <td><img src="%ATTACHURL%/EpicGames_logo.gif" alt="Epic Games logo"  width="80" height="65" /></td>
colas@0
   495
	  </tr></table>
colas@0
   496
d48 1
colas@0
   497
a48 1
colas@0
   498
	* Examples: <br /> https://uimon.cern.ch/twiki/bin/view/ <br /> http://csci.mrs.umn.edu/twiki/view
colas@0
   499
d52 2
colas@0
   500
a53 2
colas@0
   501
	* TWiki pages are fully revision controlled, so a record of every change to every page is kept <table border="0" cellpadding="3" cellspacing="0"><tr><td bgcolor="#D0D0D0"><font color="black" size="-1">r6 <a>&lt;</a> r5 <a>&lt;</a> r4</font></td></tr></table>
colas@0
   502
	* The look-and-feel is highly configurable, through use of templates
colas@0
   503
d55 4
colas@0
   504
a58 4
colas@0
   505
	* A "plugins" interface eases
colas@0
   506
		* customisation
colas@0
   507
		* extension
colas@0
   508
		* application integration
colas@0
   509
d63 5
colas@0
   510
a67 5
colas@0
   511
	* A whiteboard
colas@0
   512
	* A document repository
colas@0
   513
	* A collaborative authoring environment
colas@0
   514
	* A notebook / scrapbook
colas@0
   515
	* A chat room	
colas@0
   516
d71 7
colas@0
   517
a77 7
colas@0
   518
	* A Content Management System (CMS) for websites
colas@0
   519
	* A presentation development tool
colas@0
   520
	* A Blog
colas@0
   521
	* A database
colas@0
   522
	* A project management system
colas@0
   523
	* A tracking tool
colas@0
   524
	* (<i>truth is, we don't really know its limits!</i>)
colas@0
   525
d81 3
colas@0
   526
a83 3
colas@0
   527
	* A header
colas@0
   528
	* A body
colas@0
   529
	* A footer
colas@0
   530
d85 2
colas@0
   531
a86 2
colas@0
   532
	* The header and the footer are generated by the system
colas@0
   533
	* The body contains the text of the page, as entered by you
colas@0
   534
d94 3
colas@0
   535
a96 3
colas@0
   536
	 <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="TWiki home" />
colas@0
   537
	</td><td>
colas@0
   538
	<font size="+0"> My<nop>Co.My<nop>Topic </font>
colas@0
   539
d98 1
colas@0
   540
a98 1
colas@0
   541
	 <font size="-1" color="black">Webs:<br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a></font>
colas@0
   542
d103 1
colas@0
   543
a103 1
colas@0
   544
	 <font size="-1" color="black">[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go <input type="text" name="topic" size="16" /></font>
colas@0
   545
d108 4
colas@0
   546
a111 4
colas@0
   547
	* [[WebChanges][Changes]] - gives you a list of recent changes
colas@0
   548
	* [[WebIndex][Index]] - gives you a full index
colas@0
   549
	* [[WebSearch][Search]] - takes you to a search page, where you can search all the text
colas@0
   550
	* Go <input type="text" name="topic" size="16" /> - lets you type in the name of a page you already know
colas@0
   551
d117 3
colas@0
   552
a119 3
colas@0
   553
	 <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="TWiki home" />
colas@0
   554
	</td><td>
colas@0
   555
	 <font size="+0"> My<nop>Co.My<nop>Topic </font>
colas@0
   556
d121 1
colas@0
   557
a121 1
colas@0
   558
	 <font size="-1" color="black">Webs:<br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a></font>
colas@0
   559
d126 1
colas@0
   560
a126 1
colas@0
   561
	 <font size="-1" color="black">[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go <input type="text" name="topic" size="16" /></font>
colas@0
   562
d131 3
colas@0
   563
a133 3
colas@0
   564
	* For example, we might have a web called "Enemies", where we keep all we know about our enemies, and another called "Friends"
colas@0
   565
	* There's usually a safe play web called something like "Sandbox" or "Scratch", where you can create pages just to try things out
colas@0
   566
	* And some admin areas, like "%MAINWEB%" and "%TWIKIWEB%"
colas@0
   567
d140 4
colas@0
   568
a143 4
colas@0
   569
	 <font size="-1" color="black"> <a href="none"><b>Edit</b></a>
colas@0
   570
	 |  <a href="none">Attach</a>
colas@0
   571
	 |  <a href="none">Diffs</a>  | r2 <a href="none">&gt;</a> r1
colas@0
   572
	 |  <a href="none">More</a> </font>
colas@0
   573
d148 1
colas@0
   574
a148 1
colas@0
   575
	 <font size="-1" color="black">Revision r1.2 - 13 Feb 2004 - 09:09 GMT - <a href="none">TWikiPresenter</a> </font>
colas@0
   576
d151 1
colas@0
   577
a151 1
colas@0
   578
	<font size="-2">%WEBCOPYRIGHT% </font>
colas@0
   579
d155 3
colas@0
   580
a157 3
colas@0
   581
	* The <a>Edit</a> link takes you to an interactive page where you can change the page content
colas@0
   582
	* The <a>Attach</a> link lets you attach files
colas@0
   583
	* The other links invoke other, more complex, functions, mainly to do with revision tracking - they can safely be ignored for now
colas@0
   584
d160 2
colas@0
   585
a161 2
colas@0
   586
	* You've read a page, and you disagree with it violently! It says:<br /> _Everyone_ *knows* that =the world= is an <font color="blue"><u>OblateSpheroid</u></font><br />But you know for a fact it is flat! ;-)
colas@0
   587
	* You've clicked the edit link, and an edit page has appeared. But it doesn't look much like what was on the page before - it's full of strange hieroglyphics!
colas@0
   588
d163 1
colas@0
   589
a163 1
colas@0
   590
	* Now what?
colas@0
   591
d166 4
colas@0
   592
a169 4
colas@0
   593
	* The hieroglyphics are what's known as "TWiki Markup" or "formatting"
colas@0
   594
	* They are a really simple way of telling the browser how you want the page to look
colas@0
   595
	* You don't have to use them
colas@0
   596
		* TWiki understands pages in plain text just fine.<br /><br /> <code>Actually it is perfectly and absolutely flat</code><br /><br /> appears as <br /><br /> Actually it is perfectly and absolutely flat
colas@0
   597
d174 3
colas@0
   598
a176 3
colas@0
   599
	* A full description of all the formatting can be found in the %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
colas@0
   600
	* The best thing to do is just to type until you get stuck
colas@0
   601
		* then follow the link on the edit page to the help.
colas@0
   602
d180 5
colas@0
   603
a184 5
colas@0
   604
	* <nop>---+ indicates a heading. Add more +'s for a deeper heading.
colas@0
   605
	 | *You type* | *You see* |
colas@0
   606
	 | %BLACK%<code>---+ This is a heading</code>%ENDCOLOR% | <h1>%BLACK%This is a heading%ENDCOLOR%</h1> |
colas@0
   607
	 | %BLACK%<code>---++ And so is this</code>%ENDCOLOR% | <h2>%BLACK%And so is this%ENDCOLOR%</h2> |
colas@0
   608
	* %<nop>TOC% will insert a table of contents<br />
colas@0
   609
d187 7
colas@0
   610
a193 7
colas@0
   611
	* A blank line gives a paragraph break<br />
colas@0
   612
	* <nop>--- on a line of its own gives a horizontal bar
colas@0
   613
	* Text in stars <nop>*like this* looks *like this* <br />
colas@0
   614
	* Text in underscores <nop>_like this_ looks _like this_ <br />
colas@0
   615
	* Text in equals signs <nop>=like this= looks =like this= <br />
colas@0
   616
	* Bulleted lists use three spaces followed by an asterisk (<tt>*</tt>) at the start of the line
colas@0
   617
		* The depth of the bullet is given by the number of spaces, in multiples of three
colas@0
   618
d196 1
colas@0
   619
a196 1
colas@0
   620
	* Numbered lists use a number in place of the <tt>*</tt>.  The list is numbered automatically, so you can just use a =1=
colas@0
   621
d199 1
colas@0
   622
a199 1
colas@0
   623
	* You can create a table using vertical bars:
colas@0
   624
d201 3
colas@0
   625
a203 3
colas@0
   626
	  | Cat | Feline |
colas@0
   627
	  | Bear | Ursine |
colas@0
   628
	  | Wolf | Vulpine |
colas@0
   629
d205 5
colas@0
   630
a209 5
colas@0
   631
	* appears as
colas@0
   632
	  | <font color="black">Cat</font> | <font color="black">Feline</font> |
colas@0
   633
	  | <font color="black">Bear</font> | <font color="black">Ursine</font> |
colas@0
   634
	  | <font color="black">Wolf</font> | <font color="black">Vulpine</font> |
colas@0
   635
	* %<nop>RED% .... %<nop>ENDCOLOR% will change the colour of the enclosed text. Lots of colours are available (%RED%%<nop>RED%%ENDCOLOR%, %GREEN%%<nop>GREEN%%ENDCOLOR%, %BLUE%%<nop>BLUE%%ENDCOLOR% etc)
colas@0
   636
d212 5
colas@0
   637
a216 5
colas@0
   638
	* One special hieroglyph that is *very important* is a BumpyWord
colas@0
   639
		* a word that starts with uppercase, then some lowercase, then more uppercase (a.k.a <nop>CamelCase)
colas@0
   640
	* This has a special meaning to TWiki; if it matches the name of another topic, TWiki will automatically create a link to that page for you.
colas@0
   641
	* If there is no such page, then the word is highlighted and a question mark is put after the word, LikeThis
colas@0
   642
	* If you click on the question mark, then TWiki will invite you to create that page.
colas@0
   643
d218 2
colas@0
   644
a219 2
colas@0
   645
	* This lets you enter the names of topics you _think_ should exist, but don't yet
colas@0
   646
		* You, or someone else, can always come along later and click on the question mark!
colas@0
   647
d222 7
colas@0
   648
a228 7
colas@0
   649
	* BumpyWords automatically link to the target page
colas@0
   650
		* You can make these links easier to read using square brackets:
colas@0
   651
			* <code>[<nop>[BumpyWords][bumpy words]] appears as [[BumpyWords][bumpy words]]</code>
colas@0
   652
	* An ordinary URL pasted into text will appear as a link - http://www.google.com
colas@0
   653
		* You can also prettify URLs using square brackets:
colas@0
   654
			* <code>[<nop>[http://www.google.com/][Google]]</code> appears as [[http://www.google.com/][Google]]
colas@0
   655
	* Use %<nop>SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See %TWIKIWEB%.TWikiVariables for full details.
colas@0
   656
d231 4
colas@0
   657
a234 4
colas@0
   658
	* There's *lots* more formatting available, see %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
colas@0
   659
	* _If you are a real masochist, you can even enter raw HTML tags!_
colas@0
   660
	* *Important* to _disable_ unwanted formatting, use =&lt;nop&gt;=
colas@0
   661
		* <code>&lt;nop&gt;_word_</code> appears as <nop>_word_
colas@0
   662
d237 6
colas@0
   663
a242 6
colas@0
   664
	* Alternative ways:
colas@0
   665
		* Click on the question mark after a BumpyWord
colas@0
   666
		* Type in the name of the topic in the "Go:" box
colas@0
   667
		* Type in the name of the topic in the URL
colas@0
   668
	* Any time you try to visit a page that doesn't exist, TWiki will invite you to create it.
colas@0
   669
	* Make sure the names of topics are always BumpyWords.
colas@0
   670
d245 1
colas@0
   671
a245 1
colas@0
   672
	* Attachments are files which have been uploaded and attached to a TWiki page using the 'Attach' function in the footer.
colas@0
   673
d257 2
colas@0
   674
a258 2
colas@0
   675
	<img src="http://TWiki.org/p/pub/icn/zip.gif" width="16" height="16" align="top" alt="" border="0" />
colas@0
   676
	<font color="black"><a href="none">myco.gif</a></font>
colas@0
   677
d261 1
colas@0
   678
a261 1
colas@0
   679
	<font color="black"><a href="none">manage</a></font>
colas@0
   680
d268 3
colas@0
   681
a270 3
colas@0
   682
	* Attachments are simply files, in whatever format you want.
colas@0
   683
	* TWiki recognises some file formats, notably image files (.gif)
colas@0
   684
		* Write =%<nop>ATTACHURL%/myco.gif= to see this: %ATTACHURL%/myco.gif
colas@0
   685
d274 10
colas@0
   686
a283 10
colas@0
   687
	* What can I edit?
colas@0
   688
		* Anything. But it's good etiquette to sign your contributions
colas@0
   689
		* If someone doesn't want you to edit a page, it's up to them to say so, clearly, on the page
colas@0
   690
	* But what if somebody doesn't like my edits?
colas@0
   691
		* In TWiki, they can always recover the old revision and re-instantiate it if they really want to
colas@0
   692
		* Otherwise they should regard your changes as an opportunity for discussion
colas@0
   693
	* Pages in wiki are (usually) in one of three "modes"
colas@0
   694
		* Document<nop>Mode
colas@0
   695
		* Thread<nop>Mode
colas@0
   696
		* Structured<nop>Mode
colas@0
   697
d287 3
colas@0
   698
a289 3
colas@0
   699
	* A page in Document<nop>Mode usually comprises a contribution which is written in the third person and left unsigned.
colas@0
   700
	* The piece of text is community property
colas@0
   701
		* It may have multiple and changing authors as it is updated to reflect the community consensus.
colas@0
   702
d292 5
colas@0
   703
a296 5
colas@0
   704
	* Thread mode is a form of discussion where the community holds a conversation
colas@0
   705
	* The discussion usually starts out with a statement, at the top of the page, that is subsequently discussed
colas@0
   706
	* The page may be periodically "refactored" (edited) to remove some of the comments
colas@0
   707
		* As long as the comment is accurately reflected in what replaces it, nobody usually minds.
colas@0
   708
		* Remember to always maintain a complete list of contributors, though!
colas@0
   709
d298 3
colas@0
   710
a300 3
colas@0
   711
	* Thread<nop>Mode is rather like an e-mail thread
colas@0
   712
		* Except that new comments are usually added to the end
colas@0
   713
	* Thread<nop>Mode pages often get refactored into Document<nop>Mode
colas@0
   714
d303 5
colas@0
   715
a307 5
colas@0
   716
	* A page in Structured<nop>Mode follows some predefined structure for example
colas@0
   717
		* An agenda
colas@0
   718
		* A set of meeting minutes
colas@0
   719
		* A requirement description.
colas@0
   720
	* Pages in Structured<nop>Mode will usually have rules governing how they are edited.
colas@0
   721
d310 6
colas@0
   722
a315 6
colas@0
   723
	* A Wiki trick for grouping pages together
colas@0
   724
	* Example: to group together a set of pages all relating to the weather:
colas@0
   725
		1 Create a page called 'Category<nop>Weather'
colas@0
   726
		1 Put a SEARCH that contains the word 'Category<nop>Weather' into it
colas@0
   727
			* <code>%<nop>SEARCH{"Category<nop>Weather" nosearch="on" nosummary="on"}%</code>
colas@0
   728
		1 Put the BumpyWord 'Category<nop>Weather' on all the pages relating to the weather<br />(usually at the bottom, below a horizontal bar)
colas@0
   729
d321 6
colas@0
   730
a326 6
colas@0
   731
	* Action<nop>TrackerPlugin: Support *action tags* in topics, with *automatic notification* of action statii <code>%ACTION...</code>
colas@0
   732
	* Calendar<nop>Plugin: Show a *monthly calendar* with highlighted events <code>%CALENDAR...%</code>
colas@0
   733
	* Comment<nop>Plugin: Support *rapid entry of short comments* (also known as <b>blogging</b>) <code>%COMMENT...</code>
colas@0
   734
	* Chart<nop>Plugin: Create PNG or GIF *charts to visualize data in TWiki tables* <code>%CHART...</code>
colas@0
   735
	* Edit<nop>TablePlugin: Edit TWiki tables using *edit fields and drop down boxes* <code>%EDITTABLE...</code>
colas@0
   736
	* Interwiki<nop>Plugin: Define *shortcuts* for links to *common external sites*
colas@0
   737
d329 5
colas@0
   738
a333 5
colas@0
   739
	* Render<nop>ListPlugin: Render *bullet lists in a variety of formats* <code>%RENDERLIST...</code>
colas@0
   740
	* Slide<nop>ShowPlugin: *Create web based presentations* based on topics with headings <code>%SLIDESHOWSTART...</code>
colas@0
   741
	* Spread<nop>SheetPlugin: Add *spreadsheet calculations* like "$SUM( $ABOVE() )" to tables located in TWiki topics <code>%CALC...</code>
colas@0
   742
	* Table<nop>Plugin: Control *presentation and sorting of tables* <code>%TABLE...</code>
colas@0
   743
	* TWiki<nop>DrawPlugin: Add *quick sketches* to pages <code>%DRAWING...</code>
colas@0
   744
d339 5
colas@0
   745
a343 5
colas@0
   746
	* This training was developed by TWiki:Main.CrawfordCurrie on behalf of [[http://www.oxamer.com/][Oxamer]], one of the companies in the [[http://www.ogt.co.uk/][Oxford Gene Technology]] group.
colas@0
   747
	* Valuable contributions were also received from the TWiki Open Source community; special mentions go to:
colas@0
   748
		* TWiki:Main.WalterMundt
colas@0
   749
		* TWiki:Main.SvenDowideit
colas@0
   750
	* The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback
colas@0
   751
@
colas@0
   752
colas@0
   753
colas@0
   754
1.3
colas@0
   755
log
colas@0
   756
@none
colas@0
   757
@
colas@0
   758
text
colas@0
   759
@d1 3
colas@0
   760
a3 2
colas@0
   761
%META:TOPICINFO{author="PeterThoeny" date="1093211341" format="1.0" version="1.3"}%
colas@0
   762
This is a short introduction training course for TWiki beginners (newbies).
colas@0
   763
d8 3
colas@0
   764
d13 2
colas@0
   765
a14 2
colas@0
   766
A Wiki is like a normal web site, except that you can edit the content in your browser
colas@0
   767
<table width="100%"><tr><td>
colas@0
   768
d18 2
colas@0
   769
a19 2
colas@0
   770
	* A Wiki is basically a shared, online, persistant whiteboard
colas@0
   771
</td><td align="right"><img src="%ATTACHURL%/hula.gif" alt=""  width="88" height="112" /></td></tr></table>
colas@0
   772
d22 5
colas@0
   773
a26 2
colas@0
   774
TWiki implements the basic Wiki idea of a shared whiteboard
colas@0
   775
<table width="100%"><tr><td>
colas@0
   776
d29 2
colas@0
   777
a30 1
colas@0
   778
</td><td align="right"><img src="%ATTACHURL%/anarchy.gif" alt=""  width="112" height="112" /></td></tr></table>
colas@0
   779
d38 12
colas@0
   780
a49 4
colas@0
   781
	* TWiki is mainly used in commercial environments, often on corporate intranets
colas@0
   782
		* Examples: Disney, SAP, British Telecom, Wind River, Motorola, <a href="http://udn.epicgames.com/Main/WebHome">Epic Games</a>
colas@0
   783
	* A number of public Wiki sites also use TWiki
colas@0
   784
		* Examples: <br /> http://www.trommetter.com/cgi-bin/view.cgi/ <br /> http://csci.mrs.umn.edu/twiki/view <br /> 
colas@0
   785
d53 1
colas@0
   786
a53 1
colas@0
   787
	* TWiki pages are fully revision controlled, so a record of every change to every page is kept <table border="0" cellpadding="3" cellspacing="0"><tr><td bgcolor="#D0D0D0"><font color="black" size="-1">r1.6 <a>&gt;</a> r1.5 <a>&gt;</a> r1.4</font></td></tr></table>
colas@0
   788
d60 1
colas@0
   789
a60 1
colas@0
   790
</td><td align="right"><img src="%ATTACHURL%/lego.gif" alt=""/></td></tr></table>
colas@0
   791
d68 1
colas@0
   792
a68 1
colas@0
   793
	* A chat room
colas@0
   794
d114 1
colas@0
   795
a114 1
colas@0
   796
---++ The Page Header
colas@0
   797
d143 1
colas@0
   798
a143 1
colas@0
   799
	 |  <a href="none">Diffs</a>  | r1.2 <a href="none">&gt;</a> r1.1
colas@0
   800
d228 1
colas@0
   801
a228 1
colas@0
   802
			* <code>[<nop>[http://www.<nop>.google.com][google]]</code> appears as [[http://www.google.com][google]]
colas@0
   803
d271 1
colas@0
   804
a271 1
colas@0
   805
		* Write =%<nop>ATTACHURL%/myco.gif= to see this: %ATTACHURLPATH%/myco.gif
colas@0
   806
d314 1
colas@0
   807
a314 1
colas@0
   808
		1 Put a SEARCH that contain the word 'Category<nop>Weather' into it
colas@0
   809
d337 1
colas@0
   810
a337 1
colas@0
   811
There are many other plugins, see http://www.twiki.org/cgi-bin/view/Plugins
colas@0
   812
a347 7
colas@0
   813
colas@0
   814
-- TWiki:Main.CrawfordCurrie - 17 Feb 2004
colas@0
   815
colas@0
   816
%META:FILEATTACHMENT{name="hula.gif" attr="h" comment="" date="1079599072" path="C:\Data\Temp\hula.gif" size="8780" user="PeterThoeny" version="1.1"}%
colas@0
   817
%META:FILEATTACHMENT{name="anarchy.gif" attr="h" comment="" date="1079598796" path="C:\Data\Temp\anarchy.gif" size="10363" user="PeterThoeny" version="1.1"}%
colas@0
   818
%META:FILEATTACHMENT{name="lego.gif" attr="h" comment="" date="1079599120" path="C:\Data\Temp\lego.gif" size="4084" user="PeterThoeny" version="1.1"}%
colas@0
   819
%META:FILEATTACHMENT{name="myco.gif" attr="h" comment="" date="1079599121" path="C:\Data\Temp\myco.gif" size="1833" user="PeterThoeny" version="1.1"}%
colas@0
   820
@
colas@0
   821
colas@0
   822
colas@0
   823
1.2
colas@0
   824
log
colas@0
   825
@none
colas@0
   826
@
colas@0
   827
text
colas@0
   828
@d1 1
colas@0
   829
a1 1
colas@0
   830
%META:TOPICINFO{author="PeterThoeny" date="1092546325" format="1.0" version="1.2"}%
colas@0
   831
d62 1
colas@0
   832
a62 1
colas@0
   833
	* (<i>truth is, we don't really know it's limits!</i>)
colas@0
   834
d173 1
colas@0
   835
a173 1
colas@0
   836
	* <nop>--- on a line of it's own gives a horizontal bar
colas@0
   837
@
colas@0
   838
colas@0
   839
colas@0
   840
1.1
colas@0
   841
log
colas@0
   842
@none
colas@0
   843
@
colas@0
   844
text
colas@0
   845
@d1 334
colas@0
   846
a334 345
colas@0
   847
%META:TOPICINFO{author="PeterThoeny" date="1079598660" format="1.0" version="1.1"}%
colas@0
   848
This is a short introduction training course for TWiki beginners (newbies).
colas@0
   849
colas@0
   850
%SLIDESHOWSTART{template="ATasteOfTWikiTemplate"}%
colas@0
   851
---++ A Taste of TWiki
colas@0
   852
The basic function of TWiki is a Wiki (if that helps!)
colas@0
   853
colas@0
   854
A Wiki is like a normal web site, except that you can edit the content in your browser
colas@0
   855
<table width="100%"><tr><td>
colas@0
   856
	* "Wiki" is short for "wiki wiki", the Hawaiian for "Quick"
colas@0
   857
	* The idea originates from [[http://www.hyperdictionary.com/computing/hypercard][Macintosh Hypercard]], via [[http://www.c2.com/cgi/wiki?WardCunningham][Ward Cunningham]]
colas@0
   858
	* In Ward's words, Wiki is _"the simplest online database that could possibly work"_
colas@0
   859
	* A Wiki is basically a shared, online, persistant whiteboard
colas@0
   860
</td><td align=right><img src="%ATTACHURL%/hula.gif" alt=""  width="88" height="112" /></td></tr></table>
colas@0
   861
---++ TWiki Wiki
colas@0
   862
TWiki implements the basic Wiki idea of a shared whiteboard
colas@0
   863
<table width="100%"><tr><td>
colas@0
   864
	* Anyone can add content<br>... or change what is written<br>... or change the organisation of the content
colas@0
   865
	* Whatever what you write is<br>... nicely presented<br>... remembered<br>... and never forgotten
colas@0
   866
</td><td align=right><img src="%ATTACHURL%/anarchy.gif" alt=""  width="112" height="112" /></td></tr></table>
colas@0
   867
TWiki also acts as an "application platform" to integrate a number of other functions.
colas@0
   868
colas@0
   869
TWiki is an Open-Source development on [[http://twiki.org/][TWiki.org]]
colas@0
   870
	* led by TWiki:Main.PeterThoeny
colas@0
   871
	* with over 100 regular contributors in many countries
colas@0
   872
colas@0
   873
---++ Where is it used?
colas@0
   874
	* TWiki is mainly used in commercial environments, often on corporate intranets
colas@0
   875
		* Examples: Disney, SAP, British Telecom, Wind River, Motorola, <a href="http://udn.epicgames.com/Main/WebHome">Epic Games</a>
colas@0
   876
	* A number of public Wiki sites also use TWiki
colas@0
   877
		* Examples: <br> http://www.trommetter.com/cgi-bin/view.cgi/ <br> http://csci.mrs.umn.edu/twiki/view <br> 
colas@0
   878
colas@0
   879
---++ TWiki Features
colas@0
   880
TWiki builds on the original Wiki concept and adds a number of features that make it very useful in a business environment.
colas@0
   881
	* TWiki pages are fully revision controlled, so a record of every change to every page is kept <font color=black size="-1"><table border="0" cellpadding="3" cellspacing="0"><tr><td bgcolor="#D0D0D0">r1.6 <a>&gt;</a> r1.5 <a>&gt;</a> r1.4</td></tr></table></font>
colas@0
   882
	* The look-and-feel is highly configurable, through use of templates
colas@0
   883
<table width=100%><tr><td valign="top">
colas@0
   884
	* A "plugins" interface eases
colas@0
   885
		* customisation
colas@0
   886
		* extension
colas@0
   887
		* application integration
colas@0
   888
</td><td align=right><img src="%ATTACHURL%/lego.gif" alt=""/></td></tr></table>
colas@0
   889
colas@0
   890
---++ Applications of basic TWiki
colas@0
   891
Basic TWiki can be used as:
colas@0
   892
	* A whiteboard
colas@0
   893
	* A document repository
colas@0
   894
	* A collaborative authoring environment
colas@0
   895
	* A notebook / scrapbook
colas@0
   896
	* A chat room
colas@0
   897
colas@0
   898
---++ Extended applications
colas@0
   899
TWiki-with-extensions has been used as:
colas@0
   900
	* A Content Management System (CMS) for websites
colas@0
   901
	* A presentation development tool
colas@0
   902
	* A Blog
colas@0
   903
	* A database
colas@0
   904
	* A project management system
colas@0
   905
	* A tracking tool
colas@0
   906
	* (<i>truth is, we don't really know it's limits!</i>)
colas@0
   907
colas@0
   908
---++ Structure of a TWiki page
colas@0
   909
TWiki pages are usually organised into three parts:
colas@0
   910
	* A header
colas@0
   911
	* A body
colas@0
   912
	* A footer
colas@0
   913
colas@0
   914
	* The header and the footer are generated by the system
colas@0
   915
	* The body contains the text of the page, as entered by you
colas@0
   916
colas@0
   917
TWiki is very configurable, and the look can change. However the essentials will all be there on the page (somewhere!)
colas@0
   918
colas@0
   919
---++ The Page Header
colas@0
   920
The header of a TWiki page is generally highlighted in colour, and will usually contain an icon that gives you an idea of where you are, such as a company logo.
colas@0
   921
<font size="-1" color=black>
colas@0
   922
<table width="90%" border="0" cellpadding="3" cellspacing="0" bgcolor="white">
colas@0
   923
 <tr>
colas@0
   924
  <td bgcolor="#D0D0D0" rowspan="2" valign="top" width="1%">
colas@0
   925
	 <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="TWiki home" />
colas@0
   926
	</td><td>
colas@0
   927
	<font size="+0"> My<nop>Co.My<nop>Topic </font>
colas@0
   928
  </td><td align="right">
colas@0
   929
	Webs: <br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a>
colas@0
   930
  </td>
colas@0
   931
 </tr>
colas@0
   932
 <tr bgcolor="#D0D0D0">
colas@0
   933
  <td colspan="2">
colas@0
   934
	 [[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go <input type="text" name="topic" size="16" /> 
colas@0
   935
  </td>
colas@0
   936
 </tr>
colas@0
   937
</table>
colas@0
   938
</font>
colas@0
   939
It will also usually contain a number of 'links' that you can click on. You will generally see:
colas@0
   940
	* [[WebChanges][Changes]] - gives you a list of recent changes
colas@0
   941
	* [[WebIndex][Index]] - gives you a full index
colas@0
   942
	* [[WebSearch][Search]] - takes you to a search page, where you can search all the text
colas@0
   943
	* Go <input type="text" name="topic" size="16" /> - lets you type in the name of a page you already know
colas@0
   944
colas@0
   945
---++ The Page Header
colas@0
   946
<font size="-1" color=black>
colas@0
   947
<table width="90%" border="0" cellpadding="3" cellspacing="0" bgcolor="white">
colas@0
   948
 <tr>
colas@0
   949
  <td bgcolor="#D0D0D0" rowspan="2" valign="top" width="1%">
colas@0
   950
	 <img src="%ATTACHURL%/myco.gif" width="62" height="63" border="0" alt="TWiki home" />
colas@0
   951
	</td><td>
colas@0
   952
	<font size="+0"> My<nop>Co.My<nop>Topic </font>
colas@0
   953
  </td><td align="right">
colas@0
   954
	Webs: <br /> <a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a>
colas@0
   955
  </td>
colas@0
   956
 </tr>
colas@0
   957
 <tr bgcolor="#D0D0D0">
colas@0
   958
  <td colspan="2">
colas@0
   959
	 [[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go <input type="text" name="topic" size="16" /> 
colas@0
   960
  </td>
colas@0
   961
 </tr>
colas@0
   962
</table>
colas@0
   963
</font>
colas@0
   964
You may also see in the header (usually at the top right) a list of the TWiki "webs". A web is a collection of pages that are related closely together
colas@0
   965
	* For example, we might have a web called "Enemies", where we keep all we know about our enemies, and another called "Friends"
colas@0
   966
	* There's usually a safe play web called something like "Sandbox" or "Scratch", where you can create pages just to try things out
colas@0
   967
	* And some admin areas, like "%MAINWEB%" and "%TWIKIWEB%"
colas@0
   968
colas@0
   969
---++ The Page Footer
colas@0
   970
The footer of the page is also highlighted in colour, and is usually where you will find the links that let you change the content.
colas@0
   971
<font size="-1" color=black>
colas@0
   972
<table bgcolor="white" width="90%" border="0" cellpadding="3" cellspacing="0">
colas@0
   973
 <tr bgcolor="#D0D0D0">
colas@0
   974
  <td valign="top" colspan=2>
colas@0
   975
	  <a href="none"><b>Edit</b></a>
colas@0
   976
	|  <a href="none">Attach</a>
colas@0
   977
	|  <a href="none">Diffs</a>  | r1.2 <a href="none">&gt;</a> r1.1
colas@0
   978
	|  <a href="none">More</a> 
colas@0
   979
  </td>
colas@0
   980
 </tr>
colas@0
   981
 <tr>
colas@0
   982
  <td valign="top">
colas@0
   983
	Revision r1.2 - 13 Feb 2004 - 09:09 GMT - <a href="none">TWikiPresenter</a> 
colas@0
   984
  </td>
colas@0
   985
  <td width="40%" valign="top">
colas@0
   986
	<font size="-2">%WEBCOPYRIGHT% </font>
colas@0
   987
  </td>
colas@0
   988
 </tr>
colas@0
   989
</table>
colas@0
   990
</font>
colas@0
   991
	* The <a>Edit</a> link takes you to an interactive page where you can change the page content
colas@0
   992
	* The <a>Attach</a> link lets you attach files
colas@0
   993
	* The other links invoke other, more complex, functions, mainly to do with revision tracking - they can safely be ignored for now
colas@0
   994
colas@0
   995
---++ Editing Pages
colas@0
   996
	* You've read a page, and you disagree with it violently! It says:<br> _Everyone_ *knows* that =the world= is an <font color=blue><u>OblateSpheroid</u></font><br>But you know for a fact it is flat! ;-)
colas@0
   997
	* You've clicked the edit link, and an edit page has appeared. But it doesn't look much like what was on the page before - it's full of strange hieroglyphics!
colas@0
   998
<pre>_Everyone_ <nop>*knows* that <nop>=the world= is an Oblate<nop>Spheroid</pre>
colas@0
   999
	* Now what?
colas@0
  1000
colas@0
  1001
---++ What's in a page
colas@0
  1002
	* The hieroglyphics are what's known as "TWiki Markup" or "formatting"
colas@0
  1003
	* They are a really simple way of telling the browser how you want the page to look
colas@0
  1004
	* You don't have to use them
colas@0
  1005
		* TWiki understands pages in plain text just fine.<br><pre>Actually it is perfectly and absolutely flat</pre> appears as <p><p> Actually it is perfectly and absolutely flat <p><p>
colas@0
  1006
colas@0
  1007
---++ Formatting just makes pages prettier, and easier to read
colas@0
  1008
<pre>_Actually_ it is <nop>*perfectly* and <nop>__absolutely__ flat</pre> appears as <p><p> _Actually_ it is *perfectly* and __absolutely__ flat
colas@0
  1009
colas@0
  1010
	* A full description of all the formatting can be found in the %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
colas@0
  1011
	* The best thing to do is just to type until you get stuck
colas@0
  1012
		* then follow the link on the edit page to the help.
colas@0
  1013
colas@0
  1014
---++ Commonly used formatting
colas@0
  1015
TWiki understands pages in plain text just fine, but you can %RED% __jazz__ %ENDCOLOR%%GREEN% _them_ %ENDCOLOR%%BLUE% *up* %ENDCOLOR% using some simple formatting shortcuts. Here are some of the more commonly used ones:
colas@0
  1016
	* <nop>---+ indicates a heading. Add more +'s for a deeper heading. <br><font color=black>
colas@0
  1017
| *You type* | *You see* |
colas@0
  1018
| <code>---+ This is a heading</code> | <h1>This is a heading</h1> |
colas@0
  1019
| <code>---++ And so is this</code> | <h2>And so is this</h2> |
colas@0
  1020
</font>
colas@0
  1021
	* %<nop>TOC% will insert a table of contents<br>
colas@0
  1022
colas@0
  1023
---++ More common formatting
colas@0
  1024
	* A blank line gives a paragraph break<br>
colas@0
  1025
	* <nop>--- on a line of it's own gives a horizontal bar
colas@0
  1026
	* Text in stars <nop>*like this* looks *like this* <br>
colas@0
  1027
	* Text in underscores <nop>_like this_ looks _like this_ <br>
colas@0
  1028
	* Text in equals signs <nop>=like this= looks =like this= <br>
colas@0
  1029
	* Bulleted lists use three spaces followed by an asterisk (<tt>*</tt>) at the start of the line
colas@0
  1030
		* The depth of the bullet is given by the number of spaces, in multiples of three
colas@0
  1031
<font color=black>
colas@0
  1032
| *You type* | *You see* |
colas@0
  1033
| <code>&nbsp;&nbsp;&nbsp;* Bullet</code><br><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Sub-bullet</code> | <ul><li>Bullet<ul><li>Sub-bullet</li></ul></li></ul> |
colas@0
  1034
</font>
colas@0
  1035
	* Numbered lists use a number in place of the <tt>*</tt>.  The list is numbered automatically, so you can just use a =1= <br>
colas@0
  1036
colas@0
  1037
---++ Even more.....
colas@0
  1038
	* You can create a table using vertical bars:
colas@0
  1039
<verbatim>
colas@0
  1040
| Cat | Feline |
colas@0
  1041
| Bear | Ursine |
colas@0
  1042
| Wolf | Vulpine |
colas@0
  1043
</verbatim>
colas@0
  1044
appears as
colas@0
  1045
| Cat | Feline |
colas@0
  1046
| Bear | Ursine |
colas@0
  1047
| Wolf | Vulpine |
colas@0
  1048
	* %<nop>RED% .... %<nop>ENDCOLOR% will change the color of the enclosed text. Lots of colours are available (%<nop>GREEN% etc)
colas@0
  1049
colas@0
  1050
---++ Wiki<nop>Words
colas@0
  1051
	* One special hieroglyph that is *very important* is a BumpyWord
colas@0
  1052
		* a word that starts with uppercase, then some lowercase, then more uppercase
colas@0
  1053
	* This has a special meaning to TWiki; if it matches the name of another topic, TWiki will automatically create a link to that page for you.
colas@0
  1054
	* If there is no such page, then the word is highlighted and a question mark is put after the word, LikeThis
colas@0
  1055
	* If you click on the question mark, then TWiki will invite you to create that page.
colas@0
  1056
colas@0
  1057
	* This lets you enter the names of topics you _think_ should exist, but don't yet
colas@0
  1058
		* You, or someone else, can always come along later and click on the question mark!
colas@0
  1059
colas@0
  1060
---++ Referencing other pages and URLs
colas@0
  1061
	* BumpyWords automatically link to the target page
colas@0
  1062
		* You can make these links easier to read using square brackets:
colas@0
  1063
			* <code>[<nop>[BumpyWords][bumpy words]] appears as [[BumpyWords][bumpy words]]</code>
colas@0
  1064
	* An ordinary URL pasted into text will appear as a link - http://www.google.com
colas@0
  1065
		* You can also prettify URLs using square brackets:
colas@0
  1066
			* <code>[<nop>[http://www.<nop>.google.com][google]]</code> appears as [[http://www.google.com][google]]
colas@0
  1067
	* Use %<nop>SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See %TWIKIWEB%.TWikiVariables for full details.
colas@0
  1068
colas@0
  1069
---++ More formatting
colas@0
  1070
	* There's *lots* more formatting available, see %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
colas@0
  1071
	* _If you are a real masochist, you can even enter raw HTML tags!_
colas@0
  1072
	* *Important* to _disable_ unwanted formatting, use =&lt;nop&gt;=
colas@0
  1073
		* <code>&lt;nop&gt;_word_</code> appears as <nop>_word_
colas@0
  1074
colas@0
  1075
---++ Creating new pages
colas@0
  1076
	* Alternative ways:
colas@0
  1077
		* Click on the question mark after a BumpyWord
colas@0
  1078
		* Type in the name of the topic in the "Go:" box
colas@0
  1079
		* Type in the name of the topic in the URL
colas@0
  1080
	* Any time you try to visit a page that doesn't exist, TWiki will invite you to create it.
colas@0
  1081
	* Make sure the names of topics are always BumpyWords.
colas@0
  1082
colas@0
  1083
---++ Attachments
colas@0
  1084
	* Attachments are files which have been uploaded and attached to a TWiki page using the 'Attach' function in the footer.
colas@0
  1085
<font color=black>
colas@0
  1086
<table border="0" cellspacing="2" cellpadding="1" bgcolor=white>
colas@0
  1087
 <tr>
colas@0
  1088
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99">Attachment</font> <img src="http://TWiki.org/p/pub/TWiki/TablePlugin/diamond.gif" border="0" alt="sort" /></a></th>
colas@0
  1089
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Action</font></a> </th>
colas@0
  1090
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Size</font></a> </th>
colas@0
  1091
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Date</font></a> </th>
colas@0
  1092
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Who</font></a> </th>
colas@0
  1093
  <th align="center" valign="top" bgcolor="#0c2577"><a href="none"><font color="#FFFF99"> Comment</font></a> </th>
colas@0
  1094
 </tr>
colas@0
  1095
 <tr>
colas@0
  1096
  <td valign="top" bgcolor="#F8F8F8">
colas@0
  1097
	<img src="http://TWiki.org/p/pub/icn/zip.gif" width="16" height="16" align="top" alt="" border="0" />
colas@0
  1098
	<a href="none">myco.gif</a>
colas@0
  1099
  </td>
colas@0
  1100
  <td align="center" valign="top" bgcolor="#F8F8F8">
colas@0
  1101
	<a href="none">manage</a>
colas@0
  1102
  </td>
colas@0
  1103
  <td align="right" valign="top" bgcolor="#F8F8F8"> 9.6&nbsp;K </td>
colas@0
  1104
  <td valign="top" bgcolor="#F8F8F8"> 13 Feb 2004 - 18:41 </td>
colas@0
  1105
  <td valign="top" bgcolor="#F8F8F8"> <a href="none">MushroomMagicMan</a> </td>
colas@0
  1106
  <td valign="top" bgcolor="#F8F8F8"> Attached image file </td></tr>
colas@0
  1107
</table></font>
colas@0
  1108
	* Attachments are simply files, in whatever format you want.
colas@0
  1109
	* TWiki recognises some file formats, notably image files (.gif)
colas@0
  1110
		* Write %<nop>ATTACHURLPATH%/myco.gif to see this: %ATTACHURLPATH%/myco.gif
colas@0
  1111
colas@0
  1112
---++ Wiki Culture
colas@0
  1113
Enough about mechanics; how is a wiki actually _used_ ? Well, that's really up to you, but there are a number of tricks that the wiki community has developed for collaborative writing that work pretty well:
colas@0
  1114
	* What can I edit?
colas@0
  1115
		* Anything. But it's good etiquette to sign your contributions
colas@0
  1116
		* If someone doesn't want you to edit a page, it's up to them to say so, clearly, on the page
colas@0
  1117
	* But what if somebody doesn't like my edits?
colas@0
  1118
		* In TWiki, they can always recover the old revision and re-instate it if they really want to
colas@0
  1119
		* Otherwise they should regard your changes as an opportunity for discussion
colas@0
  1120
	* Pages in wiki are (usually) in one of three "modes"
colas@0
  1121
		* Document<nop>Mode
colas@0
  1122
		* Thread<nop>Mode
colas@0
  1123
		* Structured<nop>Mode
colas@0
  1124
colas@0
  1125
TWiki doesn't automatically distinguish between these modes; they are purely semantic.
colas@0
  1126
colas@0
  1127
---++ Document<nop>Mode
colas@0
  1128
	* A page in Document<nop>Mode usually comprises a contribution which is written in the third person and left unsigned.
colas@0
  1129
	* The piece of text is community property
colas@0
  1130
		* It may have multiple and changing authors as it is updated to reflect the community consensus.
colas@0
  1131
colas@0
  1132
---++ Thread<nop>Mode
colas@0
  1133
	* Thread mode is a form of discussion where the community holds a conversation
colas@0
  1134
	* The discussion usually starts out with a statement, at the top of the page, that is subsequently discussed
colas@0
  1135
	* The page may be periodically "refactored" (edited) to remove some of the comments
colas@0
  1136
		* As long as the comment is accurately reflected in what replaces it, nobody usually minds.
colas@0
  1137
		* Remember to always maintain a complete list of contributors, though!
colas@0
  1138
You may see a comment box on a page in Thread<nop>Mode that makes it easy to quickly add your inputs. Typing in a comment and adding it to a page this way is known as "blogging" ;-)
colas@0
  1139
	* Thread<nop>Mode is rather like an e-mail thread
colas@0
  1140
		* Except that new comments are usually added to the end
colas@0
  1141
	* Thread<nop>Mode pages often get refactored into Document<nop>Mode
colas@0
  1142
colas@0
  1143
---++ Structured<nop>Mode
colas@0
  1144
	* A page in Structured<nop>Mode follows some predefined structure for example
colas@0
  1145
		* An agenda
colas@0
  1146
		* A set of meeting minutes
colas@0
  1147
		* A requirement description.
colas@0
  1148
	* Pages in Structured<nop>Mode will usually have rules governing how they are edited.
colas@0
  1149
colas@0
  1150
---++ Other Wiki tricks - Categories
colas@0
  1151
	* A Wiki trick for grouping pages together
colas@0
  1152
	* Example: to group together a set of pages all relating to the weather:
colas@0
  1153
		1 Create a page called 'Category<nop>Weather'
colas@0
  1154
		1 Put a SEARCH that contain the word 'Category<nop>Weather' into it
colas@0
  1155
			* %<nop>SEARCH{"Category<nop>Weather" nosearch="on" nosummary="on"}%</code>
colas@0
  1156
		1 Put the BumpyWord 'Category<nop>Weather' on all the pages relating to the weather<br>(usually at the bottom, below a horizontal bar)
colas@0
  1157
colas@0
  1158
---++ Contributed features
colas@0
  1159
Basic TWiki is rich with features, but is enriched even further by the addition of optional plug-in modules that may (or may not!) be installed in your TWiki. These are classified as either __skins__ (modules that change the look-and-feel) and __plugins__ (modules that enhance functionality).
colas@0
  1160
colas@0
  1161
Here's a brief description of some of the more common plugins, together with the tags you might expect to see in topics if they are used. You can find out more by visiting the plugin pages.
colas@0
  1162
	* Action<nop>TrackerPlugin: Support *action tags* in topics, with *automatic notification* of action statii <code>%ACTION...</code>
colas@0
  1163
	* Calendar<nop>Plugin: Show a *monthly calendar* with highlighted events <code>%CALENDAR...%</code>
colas@0
  1164
	* Comment<nop>Plugin: Support *rapid entry of short comments* (also known as <b>blogging</b>) <code>%COMMENT...</code>
colas@0
  1165
	* Chart<nop>Plugin: Create PNG or GIF *charts to visualize data in TWiki tables* <code>%CHART...</code>
colas@0
  1166
	* Edit<nop>TablePlugin: Edit TWiki tables using *edit fields and drop down boxes* <code>%EDITTABLE...</code>
colas@0
  1167
	* Interwiki<nop>Plugin: Define *shortcuts* for links to *common external sites*
colas@0
  1168
colas@0
  1169
---++ More plugins
colas@0
  1170
	* Render<nop>ListPlugin: Render *bullet lists in a variety of formats* <code>%RENDERLIST...</code>
colas@0
  1171
	* Slide<nop>ShowPlugin: *Create web based presentations* based on topics with headings <code>%SLIDESHOWSTART...</code>
colas@0
  1172
	* Spread<nop>SheetPlugin: Add *spreadsheet calculations* like "$SUM( $ABOVE() )" to tables located in TWiki topics <code>%CALC...</code></dd>
colas@0
  1173
	* Table<nop>Plugin: Control *presentation and sorting of tables* <code>%TABLE...</code>
colas@0
  1174
	* TWiki<nop>DrawPlugin: Add *quick sketches* to pages <code>%DRAWING...</code>
colas@0
  1175
colas@0
  1176
The following plugins are installed on this TWiki: %INSTALLEDPLUGINS%
colas@0
  1177
colas@0
  1178
There are many other plugins, see http://www.twiki.org/cgi-bin/view/Plugins
colas@0
  1179
colas@0
  1180
---++ Credits and Acknowledgements
colas@0
  1181
	* This training was developed by TWiki:Main.CrawfordCurrie on behalf of [[http://www.oxamer.com/][Oxamer]], one of the companies in the [[http://www.ogt.com/][Oxford Gene Technology]] group.
colas@0
  1182
	* Valuable contributions were also received from the TWiki Open Source community; special mentions go to:
colas@0
  1183
		* TWiki:Main.WalterMundt
colas@0
  1184
		* TWiki:Main.SvenDowideit
colas@0
  1185
	* The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback
colas@0
  1186
colas@0
  1187
%SLIDESHOWEND%
colas@0
  1188
colas@0
  1189
__Related topics:__ WelcomeGuest, TWikiTutorial, ATasteOfTWikiTemplate
colas@0
  1190
colas@0
  1191
-- TWiki:Main.CrawfordCurrie - 17 Feb 2004
colas@0
  1192
@