data/TWiki/TWikiTutorial.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="17"}%
colas@0
     2
%STARTINCLUDE%
colas@0
     3
---+ 20-Minute TWiki Tutorial
colas@0
     4
colas@0
     5
This step-by-step, hands-on tutorial gets you up to speed with all the TWikiSite basics, in _mere minutes_...
colas@0
     6
colas@0
     7
%TOC%
colas@0
     8
colas@0
     9
---++ 1. Get set...
colas@0
    10
Open two browser windows, so that you can follow these steps in one window, while trying things out in the other.
colas@0
    11
colas@0
    12
---++ 2. Take a quick tour...
colas@0
    13
A TWikiSite is divided into webs; each one usually represents one area of collaboration. You can navigate the webs from the upper right corner of each web page.
colas@0
    14
   * Each web has hyperlinked topics, displayed as pages in your browser. 
colas@0
    15
   * The home page in each web is the %HOMETOPIC% topic.
colas@0
    16
   * To browse a TWiki web, just click on any highlighted link. These links are called WikiWords and comprise two or more words with initial capitals, run together. 
colas@0
    17
   * Follow the WikiWord link and learn what it is.
colas@0
    18
   * If you know the name of a topic, you can jump directly to it by typing its name into the *Go* field on the top of the page. Type =WebSearch= to jump to the search page. __Hint:__ Do not confuse the *Go* field with search.
colas@0
    19
   * You can search each TWiki web. Enter a search string in the %HOMETOPIC% topic or the WebSearch topic accessible from the =Search= link on each topic. TWiki searches for an exact match; optionally, you can also use RegularExpressions.
colas@0
    20
colas@0
    21
---++ 3. Open a private account...
colas@0
    22
To edit topics, you need to have a TWiki account.
colas@0
    23
   * Go to the TWikiRegistration page to create your TWiki account. Fill in a couple of lines and you're set!
colas@0
    24
colas@0
    25
---++ 4. Check out TWiki users, groups.
colas@0
    26
   * Go to the %USERSWEB%.%WIKIUSERSTOPIC% topic; it has a list of all users of TWiki. Your WikiName will be in this list after you register.
colas@0
    27
   * Go to the %USERSWEB%.TWikiGroups topic in the %USERSWEB% web; it has a list of groups which can be used to define fine grained TWikiAccessControl in TWiki.
colas@0
    28
colas@0
    29
---++ 5. Test the page controls...
colas@0
    30
The color-coded control strips at the top and/or bottom of the page has a collection of action links. Different skins show different links, but most will have some or all of::
colas@0
    31
   * ==Edit== - add to or edit the topic (discussed later)
colas@0
    32
   * ==Raw View== - show the source text without editing the topic
colas@0
    33
   * ==Attach== - attach files to a topic (discussed later)
colas@0
    34
   * ==Backlinks== - find out what other topics link to this topic (reverse link)
colas@0
    35
   * ==Printable== - goes to a stripped down version of the page, good for printing
colas@0
    36
   * ==History== - topics are under revision control - =History= shows you the complete change history of the topic, for example, who changed what and when
colas@0
    37
   * ==r3 &gt; r2 &gt; r1== - view a previous version of the topic or the difference between two versions
colas@0
    38
   * ==More== - additional controls, such as rename/move, version control and setting the topic's parent.
colas@0
    39
colas@0
    40
---++ 6. Change a page, and create a new one...
colas@0
    41
Go to the [[Sandbox.%HOMETOPIC%][Sandbox]]. This is the sandbox web, where you can make changes and try it all out at will.
colas@0
    42
   * Click the ==Edit== link. You are now in edit mode and you can see the source of the page. (Go to a different topic like Sandbox.%WIKINAME%Sandbox if you see a "Topic is being edited by an other user" warning.)
colas@0
    43
   * Look at the text in edit mode and compare it with the rendered page (move back and forth in your browser.)
colas@0
    44
   * __%T% Tip:__ When you only want to see the source code of a topic click the ==Raw View== link.
colas@0
    45
   * Notice how WikiWords are linked automatically; there is no link if you look at the text in edit mode.
colas@0
    46
   * Now, create a new topic - your own test page:
colas@0
    47
      1. In edit mode, enter a new text with a WikiWord, for example: <br />
colas@0
    48
         =This is <nop>%WIKINAME%Sandbox topic.=
colas@0
    49
      1. Preview and save the topic. The name appears, highlighted, with a linked question mark at the end. This means that the topic doesn't exist yet.
colas@0
    50
      1. Click on the question mark. Now you're in edit mode of the new topic.
colas@0
    51
      1. Type some text, basically, like you write an e-mail.
colas@0
    52
      1. A signature with your name is already entered by default. __NOTE:__ The =%USERSWEB%.= in front of your name means that you have a link from the current web to your personal topic located in the %USERSWEB% web.
colas@0
    53
      1. Preview and save the topic...
colas@0
    54
   * Learn about text formatting. You can enter text in !TWikiShorthand, a very simple markup language. Follow the TWikiShorthand link to see how, then:
colas@0
    55
      1. Go back to your sandbox topic end edit it.
colas@0
    56
      2. Enter some text in TWikiShorthand: *bold* text, _italic_ text, __bold italic__ text, a bullet list, tables, paragraphs, etc. __Hint:__ If you need help, click on the TextFormattingRules link located below the text box in edit mode.
colas@0
    57
      3. Preview and save the topic.
colas@0
    58
colas@0
    59
---++ 7. Use your browser to upload files as page attachments...
colas@0
    60
You can attach _any_ type of file to a topic - documents, images, programs, whatever - where they can be opened, viewed, or downloaded. 
colas@0
    61
   * Attaching files is just like including a file with an e-mail.
colas@0
    62
      1. Go back to your sandbox topic and click on the ==[Attach]== link at the bottom.
colas@0
    63
      1. Click ==[Browse]== to find a file on your PC that you'd like to attach; enter an optional comment; leave everything else unchecked.
colas@0
    64
      1. Click ==[Upload file]==, then scroll to the end of the page to see the new attachment listing.
colas@0
    65
   * Do this again - this time, upload a GIF, JPG or PNG image file.
colas@0
    66
      * Check the ==[Link:]== box to _Create a link to the attached file at the end of the topic_. The image will show up at the bottom of the topic. 
colas@0
    67
      * To move the image, edit the topic and place the last line (containing =%<nop>ATTACHURL%=) anywhere on the page.
colas@0
    68
   * If you have a GIF, JPG or PNG image of yourself, your cat, your sprawling family estate...why not upload it now to personalize your account page %WIKIUSERNAME%?
colas@0
    69
colas@0
    70
---++ 8. Get e-mail alerts whenever pages are changed...
colas@0
    71
%NOTIFYTOPIC% is a subscription service that automatically notifies you by e-mail when topics change in a TWiki web. This is a convenience service - for many people, checking e-mail is easier than checking the Web.
colas@0
    72
   * If you're using TWiki to collaborate on a project, it's important to know when anyone on your team posts an update. If you're following a specific discussion, it's convenient to know when there's new input.
colas@0
    73
   * Alerts are e-mailed as links to individual topics that've been changed in a set period: each day, every hour, whatever is configured for your system.
colas@0
    74
   * It's strongly recommended that you try out the service by subscribing to each TWiki web that's relevant to you. You can subscribe and unsubscribe instantly, on a per web basis using %NOTIFYTOPIC%. 
colas@0
    75
colas@0
    76
That's it! You're now equipped with all the TWiki essentials. You are ready to roll.
colas@0
    77
colas@0
    78
__NOTE:__ When first using TWiki, it will probably seem strange to be able to change other people's postings - we're used to _separating_ individual messages, with  e-mail, message boards, non-Wiki collaboration platforms. __Don't worry about it.__ You can't accidentally delete important stuff - you can always check previous versions, and copy-and-paste from them if you want to undo any changes. After a short while, TWiki-style free-form communication becomes second-nature. You'll expect it everywhere!
colas@0
    79
colas@0
    80
__Related Topics:__ UserDocumentationCategory
colas@0
    81