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