|
TWIKI DOCS FEEDBACK: Please help in maintaining high quality documentation: fix this topic if you find errors or incomplete content. Post questions, error notes, and suggestions concerning the documentation on this page in the comments section below! To solve problems you are having using this part of TWiki, see the Support web, rather than commenting here. For more on TWiki feature development, see the Codev web. The docs on TWiki.org reflect the latest development release, not the latest beta and production releases.
|
This is a short introduction training course for TWiki beginners (newbies).
|
|
- "Wiki" is short for "wiki wiki", the Hawaiian for "Quick"
- The idea originates from Macintosh Hypercard, via Ward Cunningham
- In Ward's words, Wiki is "the simplest online database that could possibly work"
|
|
<
< |
- A Wiki is basically a shared, online, persistent whiteboard
|
>
> |
- A Wiki is basically a shared, online, persistant whiteboard
|
|
TWiki Wiki
|
|
- The look-and-feel is highly configurable, through use of templates
- A "plugins" interface eases
|
|
|
<
< |
|
>
> |
|
|
-
- extension
- application integration
 |
|
|
-
- An ordinary URL pasted into text will appear as a link - http://www.google.com
- You can also prettify URLs using square brackets:
|
|
<
< |
-
-
-
[[http://www.google.com][google]] appears as google
|
>
> |
-
-
-
[[http://www..google.com][google]] appears as google
|
|
- 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.
More formatting
|
|
- Attachments are simply files, in whatever format you want.
- TWiki recognises some file formats, notably image files (.gif)
|
|
<
< |
-
- Write
%ATTACHURL%/myco.gif to see this: 
|
>
> |
-
- Write
%ATTACHURL%/myco.gif to see this: /p/pub/TWiki/ATasteOfTWiki/myco.gif
|
|
Wiki Culture
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:
|
|
- A Wiki trick for grouping pages together
- Example: to group together a set of pages all relating to the weather:
- Create a page called 'CategoryWeather'
|
|
<
< |
-
- Put a SEARCH that contains the word 'CategoryWeather' into it
|
>
> |
-
- Put a SEARCH that contain the word 'CategoryWeather' into it
|
|
-
-
-
%SEARCH{"CategoryWeather" nosearch="on" nosummary="on"}%
- Put the BumpyWord 'CategoryWeather' on all the pages relating to the weather
(usually at the bottom, below a horizontal bar)
|
|
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).
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.
|
|
<
< |
- ActionTrackerPlugin: Support action tags in topics, with automatic notification of action statii
- CalendarPlugin: Show a monthly calendar with highlighted events
- CommentPlugin: Support rapid entry of short comments (also known as blogging)
- ChartPlugin: Create PNG or GIF charts to visualize data in TWiki tables
- EditTablePlugin: Edit TWiki tables using edit fields and drop down boxes
|
>
> |
- ActionTrackerPlugin: Support action tags in topics, with automatic notification of action statii
%ACTION...
- CalendarPlugin: Show a monthly calendar with highlighted events
%CALENDAR...%
- CommentPlugin: Support rapid entry of short comments (also known as blogging)
%COMMENT...
- ChartPlugin: Create PNG or GIF charts to visualize data in TWiki tables
%CHART...
- EditTablePlugin: Edit TWiki tables using edit fields and drop down boxes
%EDITTABLE...
|
|
- InterwikiPlugin: Define shortcuts for links to common external sites
More plugins
|
|
<
< |
- RenderListPlugin: Render bullet lists in a variety of formats
- SlideShowPlugin: Create web based presentations based on topics with headings
- SpreadSheetPlugin: Add spreadsheet calculations like "$SUM( $ABOVE() )" to tables located in TWiki topics
- TablePlugin: Control presentation and sorting of tables
- TWikiDrawPlugin: Add quick sketches to pages
|
>
> |
- RenderListPlugin: Render bullet lists in a variety of formats
%RENDERLIST...
- SlideShowPlugin: Create web based presentations based on topics with headings
%SLIDESHOWSTART...
- SpreadSheetPlugin: Add spreadsheet calculations like "$SUM( $ABOVE() )" to tables located in TWiki topics
%CALC...
- TablePlugin: Control presentation and sorting of tables
%TABLE...
- TWikiDrawPlugin: Add quick sketches to pages
%DRAWING...
|
|
The following plugins are installed on this TWiki: DefaultPlugin, SpreadSheetPlugin, BlackListPlugin, ChartPlugin, CommentPlugin, EditTablePlugin, GaugePlugin, InterwikiPlugin, LocalCityTimePlugin, PerlDocPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, TWikiDrawPlugin, TablePlugin, VarCachePlugin
There are many other plugins, see http://www.twiki.org/cgi-bin/view/Plugins
|
|
-- PeterThoeny - 14 Aug 2004
|
|
<
< |
As a Twiki newbie, I would suggest that slides 27 and 28 should have the trailing %FEATURENAME...% removed. It tells me nothing about the syntax, and it doesn't provide a link to more details. The descriptions are fine on their own.
-- NeilHerber - 18 Nov 2004
For some reason the inclusion of the GIF is not working properly at slide 21 on this page.
It says "type {this} to see {this}" and {this} is exactly what is displayed (instead of the GIF)
-- MartinGregory - 13 Jan 2005
Neil and Martin, thanks for the feedback, is now changed. Since it is a Wiki you could do that yourself 
-- PeterThoeny - 07 Oct 2005
|
|
| META FILEATTACHMENT | hula.gif | attr="h" comment="" date="1077116600" moveby="PeterThoeny" movedto="TWiki.ATasteOfTWiki" movedwhen="1079596746" movefrom="Codev.ATasteOfTWiki" path="hula.gif" size="8780" user="CrawfordCurrie" version="1.1" |
|---|
| META FILEATTACHMENT | anarchy.gif | attr="h" comment="" date="1077116710" moveby="PeterThoeny" movedto="TWiki.ATasteOfTWiki" movedwhen="1079596727" movefrom="Codev.ATasteOfTWiki" path="anarchy.gif" size="10363" user="CrawfordCurrie" version="1.1" |
|---|
| META FILEATTACHMENT | lego.gif | attr="h" comment="" date="1077116745" moveby="PeterThoeny" movedto="TWiki.ATasteOfTWiki" movedwhen="1079596980" movefrom="Codev.ATasteOfTWiki" path="lego.gif" size="4084" user="CrawfordCurrie" version="1.1" |
|---|
|
