|
This is a short introduction training course for TWiki beginners (newbies).
|
|
|
|
<
< |
- In Ward's words, Wiki is "the simplest online database that could possibly work"
|
>
> |
- In Ward"s words, Wiki is "the simplest online database that could possibly work"
|
|
- A Wiki is basically a shared, online, persistant whiteboard
 |
|
|
- A database
- A project management system
- A tracking tool
|
|
<
< |
- (truth is, we don't really know its limits!)
|
>
> |
- (truth is, we don"t really know its limits!)
|
|
Structure of a TWiki page
TWiki pages are usually organised into three parts:
|
|
|
|
<
< |
It will also usually contain a number of 'links' that you can click on. You will generally see:
|
>
> |
It will also usually contain a number of "links" that you can click on. You will generally see:
|
|
- Changes - gives you a list of recent changes
- Index - gives you a full index
- Search - takes you to a search page, where you can search all the text
|
|
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
- For example, we might have a web called "Enemies", where we keep all we know about our enemies, and another called "Friends"
|
|
<
< |
- There's usually a safe play web called something like "Sandbox" or "Scratch", where you can create pages just to try things out
|
>
> |
- There"s usually a safe play web called something like "Sandbox" or "Scratch", where you can create pages just to try things out
|
|
- And some admin areas, like "Main" and "TWiki"
The Page Footer
|
|
- The other links invoke other, more complex, functions, mainly to do with revision tracking - they can safely be ignored for now
Editing Pages
|
|
<
< |
- You've read a page, and you disagree with it violently! It says:
Everyone knows that the world is an OblateSpheroid
But you know for a fact it is flat! 
- 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!
|
>
> |
- You"ve read a page, and you disagree with it violently! It says:
Everyone knows that the world is an OblateSpheroid
But you know for a fact it is flat!
- 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!
|
|
_Everyone_ *knows* that =the world= is an OblateSpheroid
|
|
<
< |
What's in a page
- The hieroglyphics are what's known as "TWiki Markup" or "formatting"
|
>
> |
What"s in a page
- The hieroglyphics are what"s known as "TWiki Markup" or "formatting"
|
|
- They are a really simple way of telling the browser how you want the page to look
|
|
<
< |
- You don't have to use them
|
>
> |
- You don"t have to use them
|
|
-
- TWiki understands pages in plain text just fine.
Actually it is perfectly and absolutely flat
appears as
Actually it is perfectly and absolutely flat
Formatting just makes pages prettier
|
|
Commonly used formatting
TWiki understands pages in plain text just fine, but you can jazz them up using some simple formatting shortcuts. Here are some of the more commonly used ones:
|
|
<
< |
- ---+ indicates a heading. Add more +'s for a deeper heading.
|
>
> |
- ---+ indicates a heading. Add more +"s for a deeper heading.
|
|
| You type | You see |
|---|
---+ This is a heading | This is a heading |
---++ And so is this | And so is this |
|
|
- If there is no such page, then the word is highlighted and a question mark is put after the word, LikeThis?
- If you click on the question mark, then TWiki will invite you to create that page.
|
|
<
< |
- This lets you enter the names of topics you think should exist, but don't yet
|
>
> |
- This lets you enter the names of topics you think should exist, but don"t yet
|
|
-
- You, or someone else, can always come along later and click on the question mark!
Referencing other pages and URLs
|
|
- 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
|
|
<
< |
|
>
> |
|
|
- If you are a real masochist, you can even enter raw HTML tags!
- Important to disable unwanted formatting, use
<nop>
-
<nop>_word_ appears as _word_
|
|
-
- Click on the question mark after a BumpyWord
- Type in the name of the topic in the "Go:" box
- Type in the name of the topic in the URL
|
|
<
< |
- Any time you try to visit a page that doesn't exist, TWiki will invite you to create it.
|
>
> |
- Any time you try to visit a page that doesn"t exist, TWiki will invite you to create it.
|
|
- Make sure the names of topics are always BumpyWords.
Attachments
|
|
<
< |
- Attachments are files which have been uploaded and attached to a TWiki page using the 'Attach' function in the footer.
|
>
> |
- Attachments are files which have been uploaded and attached to a TWiki page using the "Attach" function in the footer.
|
|
|
|
-
- Write
%ATTACHURL%/myco.gif to see this: /twiki/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:
|
>
> |
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:
|
|
|
|
<
< |
-
- Anything. But it's good etiquette to sign your contributions
- If someone doesn't want you to edit a page, it's up to them to say so, clearly, on the page
- But what if somebody doesn't like my edits?
|
>
> |
-
- Anything. But it"s good etiquette to sign your contributions
- If someone doesn"t want you to edit a page, it"s up to them to say so, clearly, on the page
- But what if somebody doesn"t like my edits?
|
|
-
- In TWiki, they can always recover the old revision and re-instantiate it if they really want to
- Otherwise they should regard your changes as an opportunity for discussion
- Pages in wiki are (usually) in one of three "modes"
- DocumentMode
- ThreadMode
- StructuredMode
|
|
<
< |
TWiki doesn't automatically distinguish between these modes; they are purely semantic.
|
>
> |
TWiki doesn"t automatically distinguish between these modes; they are purely semantic.
|
|
DocumentMode
- A page in DocumentMode usually comprises a contribution which is written in the third person and left unsigned.
|
|
Other Wiki tricks - Categories
- 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 contain the word 'CategoryWeather' into it
|
>
> |
-
- Create a page called "CategoryWeather"
- 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)
|
>
> |
-
- Put the BumpyWord "CategoryWeather" on all the pages relating to the weather
(usually at the bottom, below a horizontal bar)
|
|
Contributed features
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.
|
>
> |
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
%ACTION...
- CalendarPlugin: Show a monthly calendar with highlighted events
%CALENDAR...%
- CommentPlugin: Support rapid entry of short comments (also known as blogging)
%COMMENT...
|
|
-- TWiki:Main.CrawfordCurrie - 17 Feb 2004
|
|
>
> |
][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]
[[[[[[[[[[][]]][]]][]]][]]][]]
[[[[[[[[][]]][]]][]]][]]
[[[[[[][]]][]]][]]
[[[[][]]][]]
[[][]]
][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]][]]
[[[[[[[[[[[[][]]][]]][]]][]]][]]][]]
[[[[[[[[[[][]]][]]][]]][]]][]]
[[[[[[[[][]]][]]][]]][]]
[[[[[[][]]][]]][]]
[[[[][]]][]]
[[][]]
|
|
| META FILEATTACHMENT | hula.gif | attr="h" comment="" date="1079599072" path="C:\Data\Temp\hula.gif" size="8780" user="PeterThoeny" version="1.1" |
|---|
| META FILEATTACHMENT | anarchy.gif | attr="h" comment="" date="1079598796" path="C:\Data\Temp\anarchy.gif" size="10363" user="PeterThoeny" version="1.1" |
|---|
| META FILEATTACHMENT | lego.gif | attr="h" comment="" date="1079599120" path="C:\Data\Temp\lego.gif" size="4084" user="PeterThoeny" version="1.1" |
|---|
|
