d29734f24cce765f15bd4eaa1e60437792010d16
[openafs-wiki.git] / TWiki / ATasteOfTWiki.mdwn
1 This is a short introduction training course for TWiki beginners (newbies).
2
3 <a name="StartPresentation"></a> <span>[[Main/WebHome?slideshow=on;skin=print#GoSlide1]]</span>
4
5 ## <a name="Slide 1: A Taste of TWiki"></a> Slide 1: A Taste of TWiki
6
7 The basic function of TWiki is a Wiki (if that helps!)
8
9 A Wiki is like a normal web site, except that you can edit the content in your browser
10
11 <table width="100%">
12   <tr>
13     <td>
14       <ul>
15         <li> "Wiki" is short for "wiki wiki", the Hawaiian for "Quick" </li>
16         <li> The idea originates from <a href="http://www.hyperdictionary.com/computing/hypercard" target="_top">Macintosh Hypercard</a>, via <a href="http://www.c2.com/cgi/wiki?WardCunningham" target="_top">Ward Cunningham</a></li>
17         <li> In Ward's words, Wiki is <em>"the simplest online database that could possibly work"</em></li>
18         <li> A Wiki is basically a shared, online, persistant whiteboard </li>
19       </ul>
20     </td>
21     <td align="right"><img alt="" height="112" src="http://www.dementia.org/twiki//view/hula.gif" width="88" /></td>
22   </tr>
23 </table>
24
25 ## <a name="Slide 2: TWiki Wiki"></a> Slide 2: TWiki Wiki
26
27 TWiki implements the basic Wiki idea of a shared whiteboard
28
29 <table width="100%">
30   <tr>
31     <td>
32       <ul>
33         <li> Anyone can add content<br />... or change what is written<br />... or change the organisation of the content </li>
34         <li> Whatever what you write is<br />... nicely presented<br />... remembered<br />... and never forgotten </li>
35       </ul>
36     </td>
37     <td align="right"><img alt="" height="112" src="http://www.dementia.org/twiki//view/anarchy.gif" width="112" /></td>
38   </tr>
39 </table>
40
41 TWiki also acts as an "application platform" to integrate a number of other functions.
42
43 TWiki is an Open-Source development on [TWiki.org](http://twiki.org/)
44
45 - led by TWiki:Main.PeterThoeny
46 - with over 100 regular contributors in many countries
47
48 ## <a name="Slide 3: Where is it used?"></a> Slide 3: Where is it used?
49
50 - TWiki is mainly used in commercial environments, often on corporate intranets
51   - Examples: Disney, SAP, British Telecom, Wind River, Motorola, [Epic Games](http://udn.epicgames.com/Main/WebHome)
52 - A number of public Wiki sites also use TWiki
53   - Examples: <br /><http://www.trommetter.com/cgi-bin/view.cgi/><br /><http://csci.mrs.umn.edu/twiki/view><br />
54
55 ## <a name="Slide 4: TWiki Features"></a> Slide 4: TWiki Features
56
57 TWiki builds on the original Wiki concept and adds a number of features that make it very useful in a business environment.
58
59 - TWiki pages are fully revision controlled, so a record of every change to every page is kept <font><table border="0" cellpadding="3" cellspacing="0">
60   <tr>
61     <td bgcolor="#D0D0D0">r1.6 <a>&gt;</a> r1.5 <a>&gt;</a> r1.4</td>
62   </tr>
63 </table>
64 </font>
65 - The look-and-feel is highly configurable, through use of templates
66
67 <table width="100%">
68   <tr>
69     <td valign="top">
70       <ul>
71         <li> A "plugins" interface eases <ul>
72             <li> customisation </li>
73             <li> extension </li>
74             <li> application integration </li>
75           </ul>
76         </li>
77       </ul>
78     </td>
79     <td align="right"><img alt="" src="http://www.dementia.org/twiki//view/lego.gif" /></td>
80   </tr>
81 </table>
82
83 ## <a name="Slide 5: Applications of basic T"></a> Slide 5: Applications of basic TWiki
84
85 Basic TWiki can be used as:
86
87 - A whiteboard
88 - A document repository
89 - A collaborative authoring environment
90 - A notebook / scrapbook
91 - A chat room
92
93 ## <a name="Slide 6: Extended applications"></a> Slide 6: Extended applications
94
95 TWiki-with-extensions has been used as:
96
97 - A Content Management System (CMS) for websites
98 - A presentation development tool
99 - A Blog
100 - A database
101 - A project management system
102 - A tracking tool
103 - (_truth is, we don't really know it's limits!_)
104
105 ## <a name="Slide 7: Structure of a TWiki pa"></a> Slide 7: Structure of a TWiki page
106
107 TWiki pages are usually organised into three parts:
108
109 - A header
110 - A body
111 - A footer
112
113 - The header and the footer are generated by the system
114 - The body contains the text of the page, as entered by you
115
116 TWiki is very configurable, and the look can change. However the essentials will all be there on the page (somewhere!)
117
118 ## <a name="Slide 8: The Page Header"></a> Slide 8: The Page Header
119
120 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. <font> </font>
121
122 <table bgcolor="white" border="0" cellpadding="3" cellspacing="0" width="90%">
123   <tr>
124     <td bgcolor="#D0D0D0" rowspan="2" valign="top" width="1%"><img alt="TWiki home" border="0" height="63" src="http://www.dementia.org/twiki//view/myco.gif" width="62" /></td>
125     <td><font size="+0"> MyCo.MyTopic </font></td>
126     <td align="right">
127       <dl>
128         <dt> Webs</dt>
129         <dd>
130           <br /><a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a></dd>
131       </dl>
132     </td>
133   </tr>
134   <tr bgcolor="#D0D0D0">
135     <td colspan="2">[[Main/WebChanges]] | [[Main/WebIndex]] | [[Main/WebSearch]] | Go <input name="topic" size="16" type="text" /></td>
136   </tr>
137 </table>
138
139 It will also usually contain a number of 'links' that you can click on. You will generally see:
140
141 - [[Changes|Main/WebChanges]] - gives you a list of recent changes
142 - [[Index|Main/WebIndex]] - gives you a full index
143 - [[Search|Main/WebSearch]] - takes you to a search page, where you can search all the text
144 - Go <input name="topic" size="16" type="text" />
145  - lets you type in the name of a page you already know
146
147 ## <a name="Slide 9: The Page Header"></a> Slide 9: The Page Header
148
149 <font> </font>
150
151 <table bgcolor="white" border="0" cellpadding="3" cellspacing="0" width="90%">
152   <tr>
153     <td bgcolor="#D0D0D0" rowspan="2" valign="top" width="1%"><img alt="TWiki home" border="0" height="63" src="http://www.dementia.org/twiki//view/myco.gif" width="62" /></td>
154     <td><font size="+0"> MyCo.MyTopic </font></td>
155     <td align="right">
156       <dl>
157         <dt> Webs</dt>
158         <dd>
159           <br /><a href="non">Myco</a> | <a href="non">Main</a> | <a href="non">TWiki</a> | <a href="non">Sandbox</a></dd>
160       </dl>
161     </td>
162   </tr>
163   <tr bgcolor="#D0D0D0">
164     <td colspan="2">[[Main/WebChanges]] | [[Main/WebIndex]] | [[Main/WebSearch]] | Go <input name="topic" size="16" type="text" /></td>
165   </tr>
166 </table>
167
168 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
169
170 - For example, we might have a web called "Enemies", where we keep all we know about our enemies, and another called "Friends"
171 - There's usually a safe play web called something like "Sandbox" or "Scratch", where you can create pages just to try things out
172 - And some admin areas, like "Main" and "TWiki"
173
174 ## <a name="Slide 10: The Page Footer"></a> Slide 10: The Page Footer
175
176 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. <font> </font>
177
178 <table bgcolor="white" border="0" cellpadding="3" cellspacing="0" width="90%">
179   <tr bgcolor="#D0D0D0">
180     <td colspan="2" valign="top"><a href="none"><b>Edit</b></a> | <a href="none">Attach</a> | <a href="none">Diffs</a> | r1.2 <a href="none">&gt;</a> r1.1 | <a href="none">More</a></td>
181   </tr>
182   <tr>
183     <td valign="top"> Revision r1.2 - 13 Feb 2004 - 09:09 GMT - <a href="none">TWikiPresenter</a></td>
184     <td valign="top" width="40%"><font size="-2">%WEBCOPYRIGHT% </font></td>
185   </tr>
186 </table>
187
188 - The [Edit]() link takes you to an interactive page where you can change the page content
189 - The [Attach]() link lets you attach files
190 - The other links invoke other, more complex, functions, mainly to do with revision tracking - they can safely be ignored for now
191
192 ## <a name="Slide 11: Editing Pages"></a> Slide 11: Editing Pages
193
194 - You've read a page, and you disagree with it violently! It says:<br />_Everyone_ **knows** that `the world` is an <font><u>OblateSpheroid</u></font><br />But you know for a fact it is flat! ;-)
195 - 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!
196
197     _Everyone_ *knows* that =the world= is an OblateSpheroid
198
199 - Now what?
200
201 ## <a name="Slide 12: What&#39;s in a page"></a> Slide 12: What's in a page
202
203 - The hieroglyphics are what's known as "TWiki Markup" or "formatting"
204 - They are a really simple way of telling the browser how you want the page to look
205 - You don't have to use them
206   - TWiki understands pages in plain text just fine.<br />    Actually it is perfectly and absolutely flat appears as
207     Actually it is perfectly and absolutely flat
208
209 ## <a name="Slide 13: Formatting just makes"></a><a name="Slide 13: Formatting just makes "></a> Slide 13: Formatting just makes pages prettier, and easier to read
210
211     _Actually_ it is *perfectly* and __absolutely__ flat
212
213 appears as
214
215 _Actually_ it is **perfectly** and **_absolutely_** flat
216
217 - A full description of all the formatting can be found in the [[TextFormattingRules]] and [[TextFormattingFAQ]]
218 - The best thing to do is just to type until you get stuck
219   - then follow the link on the edit page to the help.
220
221 ## <a name="Slide 14: Commonly used formatti"></a> Slide 14: Commonly used formatting
222
223 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:
224
225 - ---+ indicates a heading. Add more +'s for a deeper heading. <br /><font> </font>
226
227 <table border="1" cellpadding="0" cellspacing="0">
228   <tr>
229     <th bgcolor="#99CCCC"><strong> You type </strong></th>
230     <th bgcolor="#99CCCC"><strong> You see </strong></th>
231   </tr>
232   <tr>
233     <td><code>---+ This is a heading</code></td>
234     <td>
235       <h1>This is a heading</h1>
236     </td>
237   </tr>
238   <tr>
239     <td><code>---++ And so is this</code></td>
240     <td>
241       <h2>And so is this</h2>
242     </td>
243   </tr>
244 </table>
245
246 - %TOC% will insert a table of contents<br />
247
248 ## <a name="Slide 15: More common formatting"></a> Slide 15: More common formatting
249
250 - A blank line gives a paragraph break<br />
251 - --- on a line of it's own gives a horizontal bar
252 - Text in stars \*like this\* looks **like this**<br />
253 - Text in underscores \_like this\_ looks _like this_<br />
254 - Text in equals signs =like this= looks `like this`<br />
255 - Bulleted lists use three spaces followed by an asterisk (`*`) at the start of the line
256   - The depth of the bullet is given by the number of spaces, in multiples of three
257
258 <font> </font>
259
260 <table border="1" cellpadding="0" cellspacing="0">
261   <tr>
262     <th bgcolor="#99CCCC"><strong> You type </strong></th>
263     <th bgcolor="#99CCCC"><strong> You see </strong></th>
264   </tr>
265   <tr>
266     <td><code>   * Bullet</code><br /><code>      * Sub-bullet</code></td>
267     <td>
268       <ul>
269         <li>Bullet<ul>
270             <li>Sub-bullet</li>
271           </ul>
272         </li>
273       </ul>
274     </td>
275   </tr>
276 </table>
277
278 - Numbered lists use a number in place of the `*`. The list is numbered automatically, so you can just use a `1`<br />
279
280 ## <a name="Slide 16: Even more....."></a> Slide 16: Even more.....
281
282 - You can create a table using vertical bars:
283
284     | Cat | Feline |
285     | Bear | Ursine |
286     | Wolf | Vulpine |
287
288 appears as
289
290 <table border="1" cellpadding="0" cellspacing="0">
291   <tr>
292     <td> Cat </td>
293     <td> Feline </td>
294   </tr>
295   <tr>
296     <td> Bear </td>
297     <td> Ursine </td>
298   </tr>
299   <tr>
300     <td> Wolf </td>
301     <td> Vulpine </td>
302   </tr>
303 </table>
304
305 - %RED% .... %ENDCOLOR% will change the color of the enclosed text. Lots of colours are available (%GREEN% etc)
306
307 ## <a name="Slide 17: &lt;a href=">WikiWords</a>"&gt; Slide 17: WikiWords
308
309 - One special hieroglyph that is **very important** is a [[BumpyWord]]
310   - a word that starts with uppercase, then some lowercase, then more uppercase
311 - 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.
312 - If there is no such page, then the word is highlighted and a question mark is put after the word, [[LikeThis]]
313 - If you click on the question mark, then TWiki will invite you to create that page.
314
315 - This lets you enter the names of topics you _think_ should exist, but don't yet
316   - You, or someone else, can always come along later and click on the question mark!
317
318 ## <a name="Slide 18: Referencing other page"></a> Slide 18: Referencing other pages and URLs
319
320 - [[BumpyWords]] automatically link to the target page
321   - You can make these links easier to read using square brackets:
322     - <code>\[[BumpyWords]\[bumpy words]] appears as [[bumpy words|Main/BumpyWords]]</code>
323 - An ordinary URL pasted into text will appear as a link - <http://www.google.com>
324   - You can also prettify URLs using square brackets:
325     - `[[http://www..google.com][google]]` appears as [google](http://www.google.com)
326 - Use %SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See [[TWikiVariables]] for full details.
327
328 ## <a name="Slide 19: More formatting"></a> Slide 19: More formatting
329
330 - There's **lots** more formatting available, see [[TextFormattingRules]] and [[TextFormattingFAQ]]
331 - _If you are a real masochist, you can even enter raw HTML tags!_
332 - **Important** to _disable_ unwanted formatting, use `<nop>`
333   - `<nop>_word_` appears as \_word\_
334
335 ## <a name="Slide 20: Creating new pages"></a> Slide 20: Creating new pages
336
337 - Alternative ways:
338   - Click on the question mark after a [[BumpyWord]]
339   - Type in the name of the topic in the "Go:" box
340   - Type in the name of the topic in the URL
341 - Any time you try to visit a page that doesn't exist, TWiki will invite you to create it.
342 - Make sure the names of topics are always [[BumpyWords]].
343
344 ## <a name="Slide 21: Attachments"></a> Slide 21: Attachments
345
346 - Attachments are files which have been uploaded and attached to a TWiki page using the 'Attach' function in the footer.
347
348 <font> </font>
349
350 <table bgcolor="white" border="0" cellpadding="1" cellspacing="2">
351   <tr>
352     <th align="center" bgcolor="#0c2577" valign="top"><a href="none"><font color="#FFFF99">Attachment</font> <img alt="sort" border="0" src="http://TWiki.org/p/pub/TWiki/TablePlugin/diamond.gif" /></a></th>
353     <th align="center" bgcolor="#0c2577" valign="top"><a href="none"><font color="#FFFF99"> Action</font></a></th>
354     <th align="center" bgcolor="#0c2577" valign="top"><a href="none"><font color="#FFFF99"> Size</font></a></th>
355     <th align="center" bgcolor="#0c2577" valign="top"><a href="none"><font color="#FFFF99"> Date</font></a></th>
356     <th align="center" bgcolor="#0c2577" valign="top"><a href="none"><font color="#FFFF99"> Who</font></a></th>
357     <th align="center" bgcolor="#0c2577" valign="top"><a href="none"><font color="#FFFF99"> Comment</font></a></th>
358   </tr>
359   <tr>
360     <td bgcolor="#F8F8F8" valign="top"><img align="top" alt="" border="0" height="16" src="http://TWiki.org/p/pub/icn/zip.gif" width="16" /> <a href="none">myco.gif</a></td>
361     <td align="center" bgcolor="#F8F8F8" valign="top"><a href="none">manage</a></td>
362     <td align="right" bgcolor="#F8F8F8" valign="top"> 9.6 K </td>
363     <td bgcolor="#F8F8F8" valign="top"> 13 Feb 2004 - 18:41 </td>
364     <td bgcolor="#F8F8F8" valign="top"><a href="none">MushroomMagicMan</a></td>
365     <td bgcolor="#F8F8F8" valign="top"> Attached image file </td>
366   </tr>
367 </table>
368
369 - Attachments are simply files, in whatever format you want.
370 - TWiki recognises some file formats, notably image files (.gif)
371   - Write %ATTACHURLPATH%/myco.gif to see this: ![myco.gif](http://www.dementia.org/twiki//view/myco.gif)
372
373 ## <a name="Slide 22: Wiki Culture"></a> Slide 22: Wiki Culture
374
375 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:
376
377 - What can I edit?
378   - Anything. But it's good etiquette to sign your contributions
379   - If someone doesn't want you to edit a page, it's up to them to say so, clearly, on the page
380 - But what if somebody doesn't like my edits?
381   - In TWiki, they can always recover the old revision and re-instate it if they really want to
382   - Otherwise they should regard your changes as an opportunity for discussion
383 - Pages in wiki are (usually) in one of three "modes"
384   - DocumentMode
385   - ThreadMode
386   - StructuredMode
387
388 TWiki doesn't automatically distinguish between these modes; they are purely semantic.
389
390 ## <a name="Slide 23: &lt;a href=">DocumentMode</a>"&gt; Slide 23: DocumentMode
391
392 - A page in DocumentMode usually comprises a contribution which is written in the third person and left unsigned.
393 - The piece of text is community property
394   - It may have multiple and changing authors as it is updated to reflect the community consensus.
395
396 ## <a name="Slide 24: &lt;a href=">ThreadMode</a>"&gt; Slide 24: ThreadMode
397
398 - Thread mode is a form of discussion where the community holds a conversation
399 - The discussion usually starts out with a statement, at the top of the page, that is subsequently discussed
400 - The page may be periodically "refactored" (edited) to remove some of the comments
401   - As long as the comment is accurately reflected in what replaces it, nobody usually minds.
402   - Remember to always maintain a complete list of contributors, though!
403
404 You may see a comment box on a page in ThreadMode 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" ;-)
405
406 - ThreadMode is rather like an e-mail thread
407   - Except that new comments are usually added to the end
408 - ThreadMode pages often get refactored into DocumentMode
409
410 ## <a name="Slide 25: &lt;a href=">StructuredMode</a>"&gt; Slide 25: StructuredMode
411
412 - A page in StructuredMode follows some predefined structure for example
413   - An agenda
414   - A set of meeting minutes
415   - A requirement description.
416 - Pages in StructuredMode will usually have rules governing how they are edited.
417
418 ## <a name="Slide 26: Other Wiki tricks - Ca"></a> Slide 26: Other Wiki tricks - Categories
419
420 - A Wiki trick for grouping pages together
421 - Example: to group together a set of pages all relating to the weather:
422   1. Create a page called 'CategoryWeather'
423   2. Put a SEARCH that contain the word 'CategoryWeather' into it
424     - %SEARCH\{"CategoryWeather" nosearch="on" nosummary="on"\}%
425   3. Put the [[BumpyWord]] 'CategoryWeather' on all the pages relating to the weather<br />(usually at the bottom, below a horizontal bar)
426
427 ## <a name="Slide 27: Contributed features"></a> Slide 27: Contributed features
428
429 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).
430
431 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.
432
433 - ActionTrackerPlugin: Support **action tags** in topics, with **automatic notification** of action statii `%ACTION...`
434 - CalendarPlugin: Show a **monthly calendar** with highlighted events `%CALENDAR...%`
435 - CommentPlugin: Support **rapid entry of short comments** (also known as **blogging**) `%COMMENT...`
436 - ChartPlugin: Create PNG or GIF **charts to visualize data in TWiki tables** `%CHART...`
437 - EditTablePlugin: Edit TWiki tables using **edit fields and drop down boxes** `%EDITTABLE...`
438 - InterwikiPlugin: Define **shortcuts** for links to **common external sites**
439
440 ## <a name="Slide 28: More plugins"></a> Slide 28: More plugins
441
442 - RenderListPlugin: Render **bullet lists in a variety of formats** `%RENDERLIST...`
443 - SlideShowPlugin: **Create web based presentations** based on topics with headings `%SLIDESHOWSTART...`
444 - SpreadSheetPlugin: Add **spreadsheet calculations** like "$SUM( $ABOVE() )" to tables located in TWiki topics `%CALC...`
445 - TablePlugin: Control **presentation and sorting of tables** `%TABLE...`
446 - TWikiDrawPlugin: Add **quick sketches** to pages `%DRAWING...`
447
448 The following plugins are installed on this TWiki: %INSTALLEDPLUGINS%
449
450 There are many other plugins, see <http://www.twiki.org/cgi-bin/view/Plugins>
451
452 ## <a name="Slide 29: Credits and Acknowledg"></a> Slide 29: Credits and Acknowledgements
453
454 - This training was developed by TWiki:Main.CrawfordCurrie on behalf of [Oxamer](http://www.oxamer.com/), one of the companies in the [Oxford Gene Technology](http://www.ogt.com/) group.
455 - Valuable contributions were also received from the TWiki Open Source community; special mentions go to:
456   - TWiki:Main.WalterMundt
457   - TWiki:Main.SvenDowideit
458 - The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback
459
460 **_Related topics:_** [[WelcomeGuest]], [[TWikiTutorial]], [[ATasteOfTWikiTemplate]]
461
462 -- TWiki:Main.CrawfordCurrie - 17 Feb 2004