head 1.6;
access;
symbols;
locks; strict;
comment @# @;
1.6
date 2007.01.16.04.12.04; author TWikiContributor; state Exp;
branches;
next 1.5;
1.5
date 2006.04.01.05.55.03; author TWikiContributor; state Exp;
branches;
next 1.4;
1.4
date 2006.02.01.12.01.15; author TWikiContributor; state Exp;
branches;
next 1.3;
1.3
date 2004.08.22.21.49.01; author PeterThoeny; state Exp;
branches;
next 1.2;
1.2
date 2004.08.15.05.05.25; author PeterThoeny; state Exp;
branches;
next 1.1;
1.1
date 2004.03.18.08.31.00; author PeterThoeny; state Exp;
branches;
next ;
desc
@none
@
1.6
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1163993253" format="1.1" version="6"}%
This is a short introductory training course for TWiki beginners.
%SLIDESHOWSTART%
---++ A Taste of TWiki
The basic function of TWiki is a Wiki (if that helps!)
A Wiki is like a web site, except that you can edit the content in your browser
* "Wiki" is short for "wiki wiki", the Hawaiian for "Quick"
* The idea originates from [[http://www.hyperdictionary.com/computing/hypercard][Macintosh Hypercard]], via [[http://www.c2.com/cgi/wiki?WardCunningham][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
---++ TWiki Wiki
TWiki implements the basic Wiki idea of a shared whiteboard
* Anyone can add content ... or change what is written ... or change the organisation of the content
* Whatever what you write is ... nicely presented ... remembered... and never forgotten
TWiki also acts as an "application platform" to integrate a number of other functions.
TWiki is an Open-Source development on [[http://twiki.org/][TWiki.org]]
* led by TWiki:Main.PeterThoeny
* with over 100 regular contributors in many countries
---++ Where is it used?
TWiki is mainly used in commercial environments, often on corporate intranets
* Examples: Disney, British Telecom, SAP, Wind River, Motorola, Epic Games
A number of public Wiki sites also use TWiki
* Examples: https://twiki.cern.ch/twiki/bin/view/ http://csci.mrs.umn.edu/twiki/view
---++ TWiki Features
TWiki builds on the original Wiki concept and adds a number of features that make it very useful in a business environment.
* TWiki pages are fully revision controlled, so a record of every change to every page is kept
---++ Applications of basic TWiki
Basic TWiki can be used as:
* A whiteboard
* A document repository
* A collaborative authoring environment
* A notebook / scrapbook
* A chat room
---++ Extended applications
TWiki-with-extensions has been used as:
* A Content Management System (CMS) for websites
* A presentation development tool
* A Blog
* A database
* A project management system
* A tracking tool
* (truth is, we don't really know its limits!)
---++ Structure of a TWiki page
TWiki pages are usually organised into three parts:
* A header
* A body
* A footer
* The header and the footer are generated by the system
* The body contains the text of the page, as entered by you
TWiki is very configurable, and the look can change. However the essentials will all be there on the page (somewhere!)
---++ The Page Header
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.
[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go
It will also usually contain a number of 'links' that you can click on. You will generally see:
* [[WebChanges][Changes]] - gives you a list of recent changes
* [[WebIndex][Index]] - gives you a full index
* [[WebSearch][Search]] - takes you to a search page, where you can search all the text
* Go - lets you type in the name of a page you already know
---++ The Page Header ... continued
[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go
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
* And some admin areas, like "%MAINWEB%" and "%TWIKIWEB%"
---++ The Page Footer
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.
* The Edit link takes you to an interactive page where you can change the page content
* The Attach link lets you attach files
* 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!
_Everyone_ *knows* that =the world= is an OblateSpheroid
* Now what?
---++ 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
* 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
... and easier to read
_Actually_ it is *perfectly* and __absolutely__ flat
appears as
_Actually_ it is *perfectly* and __absolutely__ flat
* A full description of all the formatting can be found in the %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
* The best thing to do is just to type until you get stuck
* then follow the link on the edit page to the help.
---++ Commonly used formatting
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:
* ---+ indicates a heading. Add more +'s for a deeper heading.
| *You type* | *You see* |
| %BLACK%---+ This is a heading%ENDCOLOR% |
%BLACK%This is a heading%ENDCOLOR%
|
| %BLACK%---++ And so is this%ENDCOLOR% |
%BLACK%And so is this%ENDCOLOR%
|
* %TOC% will insert a table of contents
---++ More common formatting
* A blank line gives a paragraph break
* --- on a line of its own gives a horizontal bar
* Text in stars *like this* looks *like this*
* Text in underscores _like this_ looks _like this_
* Text in equals signs =like this= looks =like this=
* Bulleted lists use three spaces followed by an asterisk (*) at the start of the line
* The depth of the bullet is given by the number of spaces, in multiples of three
| *You type* | *You see* |
| * Bullet * Sub-bullet |
Bullet
Sub-bullet
|
* Numbered lists use a number in place of the *. The list is numbered automatically, so you can just use a =1=
---++ Even more.....
* You can create a table using vertical bars:
| Cat | Feline |
| Bear | Ursine |
| Wolf | Vulpine |
* appears as
| Cat | Feline |
| Bear | Ursine |
| Wolf | Vulpine |
* %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)
---++ WikiWords
* One special hieroglyph that is *very important* is a BumpyWord
* a word that starts with uppercase, then some lowercase, then more uppercase (a.k.a CamelCase)
* 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.
* 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
* You, or someone else, can always come along later and click on the question mark!
---++ Referencing other pages and URLs
* BumpyWords automatically link to the target page
* You can make these links easier to read using square brackets:
* [[BumpyWords][bumpy words]] appears as [[BumpyWords][bumpy words]]
* 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 [[http://www.google.com/][Google]]
* Use %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.
---++ More formatting
* There's *lots* more formatting available, see %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
* _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_
---++ Creating new pages
* Alternative ways:
* 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.
* 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 simply files, in whatever format you want.
* TWiki recognises some file formats, notably image files (.gif)
* Write =%ATTACHURL%/myco.gif= to see this: %ATTACHURL%/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:
* What can I edit?
* 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.
---++ DocumentMode
* A page in DocumentMode usually comprises a contribution which is written in the third person and left unsigned.
* The piece of text is community property
* It may have multiple and changing authors as it is updated to reflect the community consensus.
---++ ThreadMode
* Thread mode is a form of discussion where the community holds a conversation
* The discussion usually starts out with a statement, at the top of the page, that is subsequently discussed
* The page may be periodically "refactored" (edited) to remove some of the comments
* As long as the comment is accurately reflected in what replaces it, nobody usually minds.
* Remember to always maintain a complete list of contributors, though!
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" ;-)
* ThreadMode is rather like an e-mail thread
* Except that new comments are usually added to the end
* ThreadMode pages often get refactored into DocumentMode
---++ StructuredMode
* A page in StructuredMode follows some predefined structure for example
* An agenda
* A set of meeting minutes
* A requirement description.
* Pages in StructuredMode will usually have rules governing how they are edited.
---++ Other Wiki tricks - Categories
* A Wiki trick for grouping pages together
* Example: to group together a set of pages all relating to the weather:
1 Create a page called 'CategoryWeather'
1 Put a SEARCH that contains the word 'CategoryWeather' into it
* %SEARCH{"CategoryWeather" nosearch="on" nosummary="on"}%
1 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.
* ActionTrackerPlugin: Support *action tags* in topics, with *automatic notification* of action statuses %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* %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: %ACTIVATEDPLUGINS%
There are many other plugins, see http://TWiki.org/cgi-bin/view/Plugins
---++ Credits and Acknowledgements
* 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.
* Valuable contributions were also received from the TWiki Open Source community; special mentions go to:
* TWiki:Main.WalterMundt
* TWiki:Main.SvenDowideit
* The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback
%SLIDESHOWEND%
__Related topics:__ WelcomeGuest, TWikiTutorial, ATasteOfTWikiTemplate
@
1.5
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="5"}%
d4 1
a4 1
%SLIDESHOWSTART{template="ATasteOfTWikiTemplate"}%
d7 1
a7 3
a15 1
d18 2
a19 4
TWiki implements the basic Wiki idea of a shared whiteboard
a22 1
d42 1
a42 1
* Examples: https://uimon.cern.ch/twiki/bin/view/ http://csci.mrs.umn.edu/twiki/view
d315 1
a315 1
* ActionTrackerPlugin: Support *action tags* in topics, with *automatic notification* of action statii %ACTION...
d341 1
@
1.4
log
@buildrelease
@
text
@d1 1
a1 2
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="4"}%
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="4"}%
d14 4
a17 4
* "Wiki" is short for "wiki wiki", the Hawaiian for "Quick"
* The idea originates from [[http://www.hyperdictionary.com/computing/hypercard][Macintosh Hypercard]], via [[http://www.c2.com/cgi/wiki?WardCunningham][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
d26 2
a27 2
* Anyone can add content ... or change what is written ... or change the organisation of the content
* Whatever what you write is ... nicely presented ... remembered... and never forgotten
d33 2
a34 2
* led by TWiki:Main.PeterThoeny
* with over 100 regular contributors in many countries
d38 8
a45 8
* Examples: Disney, British Telecom, SAP, Wind River, Motorola, Epic Games
d48 1
a48 1
* Examples: https://uimon.cern.ch/twiki/bin/view/ http://csci.mrs.umn.edu/twiki/view
d52 2
a53 2
* TWiki pages are fully revision controlled, so a record of every change to every page is kept
* The look-and-feel is highly configurable, through use of templates
d55 4
a58 4
* A "plugins" interface eases
* customisation
* extension
* application integration
d63 5
a67 5
* A whiteboard
* A document repository
* A collaborative authoring environment
* A notebook / scrapbook
* A chat room
d71 7
a77 7
* A Content Management System (CMS) for websites
* A presentation development tool
* A Blog
* A database
* A project management system
* A tracking tool
* (truth is, we don't really know its limits!)
d81 3
a83 3
* A header
* A body
* A footer
d85 2
a86 2
* The header and the footer are generated by the system
* The body contains the text of the page, as entered by you
d94 3
a96 3
MyCo.MyTopic
d98 1
a98 1
Webs: Myco | Main | TWiki | Sandbox
d103 1
a103 1
[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go
d108 4
a111 4
* [[WebChanges][Changes]] - gives you a list of recent changes
* [[WebIndex][Index]] - gives you a full index
* [[WebSearch][Search]] - takes you to a search page, where you can search all the text
* Go - lets you type in the name of a page you already know
d117 3
a119 3
MyCo.MyTopic
d121 1
a121 1
Webs: Myco | Main | TWiki | Sandbox
d126 1
a126 1
[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go
d131 3
a133 3
* 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
* And some admin areas, like "%MAINWEB%" and "%TWIKIWEB%"
d140 4
a143 4
Edit
| Attach
| Diffs | r2 > r1
| More
d148 1
a148 1
Revision r1.2 - 13 Feb 2004 - 09:09 GMT - TWikiPresenter
d151 1
a151 1
%WEBCOPYRIGHT%
d155 3
a157 3
* The Edit link takes you to an interactive page where you can change the page content
* The Attach link lets you attach files
* The other links invoke other, more complex, functions, mainly to do with revision tracking - they can safely be ignored for now
d160 2
a161 2
* 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!
d163 1
a163 1
* Now what?
d166 4
a169 4
* 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
* TWiki understands pages in plain text just fine.
Actually it is perfectly and absolutely flat
appears as
Actually it is perfectly and absolutely flat
d174 3
a176 3
* A full description of all the formatting can be found in the %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
* The best thing to do is just to type until you get stuck
* then follow the link on the edit page to the help.
d180 5
a184 5
* ---+ indicates a heading. Add more +'s for a deeper heading.
| *You type* | *You see* |
| %BLACK%---+ This is a heading%ENDCOLOR% |
%BLACK%This is a heading%ENDCOLOR%
|
| %BLACK%---++ And so is this%ENDCOLOR% |
%BLACK%And so is this%ENDCOLOR%
|
* %TOC% will insert a table of contents
d187 7
a193 7
* A blank line gives a paragraph break
* --- on a line of its own gives a horizontal bar
* Text in stars *like this* looks *like this*
* Text in underscores _like this_ looks _like this_
* Text in equals signs =like this= looks =like this=
* Bulleted lists use three spaces followed by an asterisk (*) at the start of the line
* The depth of the bullet is given by the number of spaces, in multiples of three
d196 1
a196 1
* Numbered lists use a number in place of the *. The list is numbered automatically, so you can just use a =1=
d199 1
a199 1
* You can create a table using vertical bars:
d201 3
a203 3
| Cat | Feline |
| Bear | Ursine |
| Wolf | Vulpine |
d205 5
a209 5
* appears as
| Cat | Feline |
| Bear | Ursine |
| Wolf | Vulpine |
* %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)
d212 5
a216 5
* One special hieroglyph that is *very important* is a BumpyWord
* a word that starts with uppercase, then some lowercase, then more uppercase (a.k.a CamelCase)
* 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.
* 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.
d218 2
a219 2
* 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!
d222 7
a228 7
* BumpyWords automatically link to the target page
* You can make these links easier to read using square brackets:
* [[BumpyWords][bumpy words]] appears as [[BumpyWords][bumpy words]]
* 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 [[http://www.google.com/][Google]]
* Use %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.
d231 4
a234 4
* There's *lots* more formatting available, see %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
* _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_
d237 6
a242 6
* Alternative ways:
* 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.
* Make sure the names of topics are always BumpyWords.
d245 1
a245 1
* Attachments are files which have been uploaded and attached to a TWiki page using the 'Attach' function in the footer.
d257 2
a258 2
myco.gif
d261 1
a261 1
manage
d268 3
a270 3
* 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: %ATTACHURL%/myco.gif
d274 10
a283 10
* What can I edit?
* 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
d287 3
a289 3
* A page in DocumentMode usually comprises a contribution which is written in the third person and left unsigned.
* The piece of text is community property
* It may have multiple and changing authors as it is updated to reflect the community consensus.
d292 5
a296 5
* Thread mode is a form of discussion where the community holds a conversation
* The discussion usually starts out with a statement, at the top of the page, that is subsequently discussed
* The page may be periodically "refactored" (edited) to remove some of the comments
* As long as the comment is accurately reflected in what replaces it, nobody usually minds.
* Remember to always maintain a complete list of contributors, though!
d298 3
a300 3
* ThreadMode is rather like an e-mail thread
* Except that new comments are usually added to the end
* ThreadMode pages often get refactored into DocumentMode
d303 5
a307 5
* A page in StructuredMode follows some predefined structure for example
* An agenda
* A set of meeting minutes
* A requirement description.
* Pages in StructuredMode will usually have rules governing how they are edited.
d310 6
a315 6
* A Wiki trick for grouping pages together
* Example: to group together a set of pages all relating to the weather:
1 Create a page called 'CategoryWeather'
1 Put a SEARCH that contains the word 'CategoryWeather' into it
* %SEARCH{"CategoryWeather" nosearch="on" nosummary="on"}%
1 Put the BumpyWord 'CategoryWeather' on all the pages relating to the weather (usually at the bottom, below a horizontal bar)
d321 6
a326 6
* 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*
d329 5
a333 5
* 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...
d339 5
a343 5
* 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.
* Valuable contributions were also received from the TWiki Open Source community; special mentions go to:
* TWiki:Main.WalterMundt
* TWiki:Main.SvenDowideit
* The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback
@
1.3
log
@none
@
text
@d1 3
a3 2
%META:TOPICINFO{author="PeterThoeny" date="1093211341" format="1.0" version="1.3"}%
This is a short introduction training course for TWiki beginners (newbies).
d8 3
d13 2
a14 2
A Wiki is like a normal web site, except that you can edit the content in your browser
d18 2
a19 2
* A Wiki is basically a shared, online, persistant whiteboard
d22 5
a26 2
TWiki implements the basic Wiki idea of a shared whiteboard
d29 2
a30 1
d38 12
a49 4
* TWiki is mainly used in commercial environments, often on corporate intranets
* Examples: Disney, SAP, British Telecom, Wind River, Motorola, Epic Games
* A number of public Wiki sites also use TWiki
* Examples: http://www.trommetter.com/cgi-bin/view.cgi/ http://csci.mrs.umn.edu/twiki/view
d53 1
a53 1
* TWiki pages are fully revision controlled, so a record of every change to every page is kept
d68 1
a68 1
* A chat room
d114 1
a114 1
---++ The Page Header
d143 1
a143 1
| Diffs | r1.2 > r1.1
d228 1
a228 1
* [[http://www..google.com][google]] appears as [[http://www.google.com][google]]
d271 1
a271 1
* Write =%ATTACHURL%/myco.gif= to see this: %ATTACHURLPATH%/myco.gif
d314 1
a314 1
1 Put a SEARCH that contain the word 'CategoryWeather' into it
d337 1
a337 1
There are many other plugins, see http://www.twiki.org/cgi-bin/view/Plugins
a347 7
-- TWiki:Main.CrawfordCurrie - 17 Feb 2004
%META:FILEATTACHMENT{name="hula.gif" attr="h" comment="" date="1079599072" path="C:\Data\Temp\hula.gif" size="8780" user="PeterThoeny" version="1.1"}%
%META:FILEATTACHMENT{name="anarchy.gif" attr="h" comment="" date="1079598796" path="C:\Data\Temp\anarchy.gif" size="10363" user="PeterThoeny" version="1.1"}%
%META:FILEATTACHMENT{name="lego.gif" attr="h" comment="" date="1079599120" path="C:\Data\Temp\lego.gif" size="4084" user="PeterThoeny" version="1.1"}%
%META:FILEATTACHMENT{name="myco.gif" attr="h" comment="" date="1079599121" path="C:\Data\Temp\myco.gif" size="1833" user="PeterThoeny" version="1.1"}%
@
1.2
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1092546325" format="1.0" version="1.2"}%
d62 1
a62 1
* (truth is, we don't really know it's limits!)
d173 1
a173 1
* --- on a line of it's own gives a horizontal bar
@
1.1
log
@none
@
text
@d1 334
a334 345
%META:TOPICINFO{author="PeterThoeny" date="1079598660" format="1.0" version="1.1"}%
This is a short introduction training course for TWiki beginners (newbies).
%SLIDESHOWSTART{template="ATasteOfTWikiTemplate"}%
---++ A Taste of TWiki
The basic function of TWiki is a Wiki (if that helps!)
A Wiki is like a normal web site, except that you can edit the content in your browser
* "Wiki" is short for "wiki wiki", the Hawaiian for "Quick"
* The idea originates from [[http://www.hyperdictionary.com/computing/hypercard][Macintosh Hypercard]], via [[http://www.c2.com/cgi/wiki?WardCunningham][Ward Cunningham]]
* In Ward's words, Wiki is _"the simplest online database that could possibly work"_
* A Wiki is basically a shared, online, persistant whiteboard
---++ TWiki Wiki
TWiki implements the basic Wiki idea of a shared whiteboard
* Anyone can add content ... or change what is written ... or change the organisation of the content
* Whatever what you write is ... nicely presented ... remembered ... and never forgotten
TWiki also acts as an "application platform" to integrate a number of other functions.
TWiki is an Open-Source development on [[http://twiki.org/][TWiki.org]]
* led by TWiki:Main.PeterThoeny
* with over 100 regular contributors in many countries
---++ Where is it used?
* TWiki is mainly used in commercial environments, often on corporate intranets
* Examples: Disney, SAP, British Telecom, Wind River, Motorola, Epic Games
* A number of public Wiki sites also use TWiki
* Examples: http://www.trommetter.com/cgi-bin/view.cgi/ http://csci.mrs.umn.edu/twiki/view
---++ TWiki Features
TWiki builds on the original Wiki concept and adds a number of features that make it very useful in a business environment.
* TWiki pages are fully revision controlled, so a record of every change to every page is kept
---++ Applications of basic TWiki
Basic TWiki can be used as:
* A whiteboard
* A document repository
* A collaborative authoring environment
* A notebook / scrapbook
* A chat room
---++ Extended applications
TWiki-with-extensions has been used as:
* A Content Management System (CMS) for websites
* A presentation development tool
* A Blog
* A database
* A project management system
* A tracking tool
* (truth is, we don't really know it's limits!)
---++ Structure of a TWiki page
TWiki pages are usually organised into three parts:
* A header
* A body
* A footer
* The header and the footer are generated by the system
* The body contains the text of the page, as entered by you
TWiki is very configurable, and the look can change. However the essentials will all be there on the page (somewhere!)
---++ The Page Header
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.
[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go
It will also usually contain a number of 'links' that you can click on. You will generally see:
* [[WebChanges][Changes]] - gives you a list of recent changes
* [[WebIndex][Index]] - gives you a full index
* [[WebSearch][Search]] - takes you to a search page, where you can search all the text
* Go - lets you type in the name of a page you already know
---++ The Page Header
[[WebChanges][Changes]] | [[WebIndex][Index]] | [[WebSearch][Search]] | Go
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
* And some admin areas, like "%MAINWEB%" and "%TWIKIWEB%"
---++ The Page Footer
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.
* The Edit link takes you to an interactive page where you can change the page content
* The Attach link lets you attach files
* 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!
_Everyone_ *knows* that =the world= is an OblateSpheroid
* Now what?
---++ 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
* 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, and easier to read
_Actually_ it is *perfectly* and __absolutely__ flat
appears as
_Actually_ it is *perfectly* and __absolutely__ flat
* A full description of all the formatting can be found in the %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
* The best thing to do is just to type until you get stuck
* then follow the link on the edit page to the help.
---++ Commonly used formatting
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:
* ---+ 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
|
* %TOC% will insert a table of contents
---++ More common formatting
* A blank line gives a paragraph break
* --- on a line of it's own gives a horizontal bar
* Text in stars *like this* looks *like this*
* Text in underscores _like this_ looks _like this_
* Text in equals signs =like this= looks =like this=
* Bulleted lists use three spaces followed by an asterisk (*) at the start of the line
* The depth of the bullet is given by the number of spaces, in multiples of three
| *You type* | *You see* |
| * Bullet * Sub-bullet |
Bullet
Sub-bullet
|
* Numbered lists use a number in place of the *. The list is numbered automatically, so you can just use a =1=
---++ Even more.....
* You can create a table using vertical bars:
| Cat | Feline |
| Bear | Ursine |
| Wolf | Vulpine |
appears as
| Cat | Feline |
| Bear | Ursine |
| Wolf | Vulpine |
* %RED% .... %ENDCOLOR% will change the color of the enclosed text. Lots of colours are available (%GREEN% etc)
---++ WikiWords
* One special hieroglyph that is *very important* is a BumpyWord
* a word that starts with uppercase, then some lowercase, then more uppercase
* 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.
* 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
* You, or someone else, can always come along later and click on the question mark!
---++ Referencing other pages and URLs
* BumpyWords automatically link to the target page
* You can make these links easier to read using square brackets:
* [[BumpyWords][bumpy words]] appears as [[BumpyWords][bumpy words]]
* 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 [[http://www.google.com][google]]
* Use %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.
---++ More formatting
* There's *lots* more formatting available, see %TWIKIWEB%.TextFormattingRules and %TWIKIWEB%.TextFormattingFAQ
* _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_
---++ Creating new pages
* Alternative ways:
* 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.
* 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 simply files, in whatever format you want.
* TWiki recognises some file formats, notably image files (.gif)
* Write %ATTACHURLPATH%/myco.gif to see this: %ATTACHURLPATH%/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:
* What can I edit?
* 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-instate 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.
---++ DocumentMode
* A page in DocumentMode usually comprises a contribution which is written in the third person and left unsigned.
* The piece of text is community property
* It may have multiple and changing authors as it is updated to reflect the community consensus.
---++ ThreadMode
* Thread mode is a form of discussion where the community holds a conversation
* The discussion usually starts out with a statement, at the top of the page, that is subsequently discussed
* The page may be periodically "refactored" (edited) to remove some of the comments
* As long as the comment is accurately reflected in what replaces it, nobody usually minds.
* Remember to always maintain a complete list of contributors, though!
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" ;-)
* ThreadMode is rather like an e-mail thread
* Except that new comments are usually added to the end
* ThreadMode pages often get refactored into DocumentMode
---++ StructuredMode
* A page in StructuredMode follows some predefined structure for example
* An agenda
* A set of meeting minutes
* A requirement description.
* Pages in StructuredMode will usually have rules governing how they are edited.
---++ Other Wiki tricks - Categories
* A Wiki trick for grouping pages together
* Example: to group together a set of pages all relating to the weather:
1 Create a page called 'CategoryWeather'
1 Put a SEARCH that contain the word 'CategoryWeather' into it
* %SEARCH{"CategoryWeather" nosearch="on" nosummary="on"}%
1 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.
* 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* %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: %INSTALLEDPLUGINS%
There are many other plugins, see http://www.twiki.org/cgi-bin/view/Plugins
---++ Credits and Acknowledgements
* 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.
* Valuable contributions were also received from the TWiki Open Source community; special mentions go to:
* TWiki:Main.WalterMundt
* TWiki:Main.SvenDowideit
* The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback
%SLIDESHOWEND%
__Related topics:__ WelcomeGuest, TWikiTutorial, ATasteOfTWikiTemplate
-- TWiki:Main.CrawfordCurrie - 17 Feb 2004
@
The basic function of TWiki is a Wiki (if that helps!)
A Wiki is like a web site, except that you can edit the content in your browser
* "Wiki" is short for "wiki wiki", the Hawaiian for "Quick"
* The idea originates from [[http://www.hyperdictionary.com/computing/hypercard][Macintosh Hypercard]], via [[http://www.c2.com/cgi/wiki?WardCunningham][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
---++ TWiki Wiki
TWiki implements the basic Wiki idea of a shared whiteboard
* Anyone can add content
myco.gif
