TWiki/TWikiTutorial.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#20 Minute TWiki"> 20 Minute TWiki</a><ul>
   4         <li><a href="#1. Get set:"> 1. Get set:</a></li>
   5         <li><a href="#2. Take a tour around:"> 2. Take a tour around:</a></li>
   6         <li><a href="#3. Open a private account page:"> 3. Open a private account page:</a></li>
   7         <li><a href="#4. Check out %WIKITOOLNAME% User"> 4. Check out %WIKITOOLNAME% Users and offices:</a></li>
   8         <li><a href="#5. Test the Topic controls:"> 5. Test the Topic controls:</a></li>
   9         <li><a href="#6. Change a page and create a ne"> 6. Change a page and create a new one:</a></li>
  10         <li><a href="#7. Upload files as page Attachme"> 7. Upload files as page Attachments:</a></li>
  11         <li><a href="#8. Get email alerts when topics"> 8. Get email alerts when topics change:</a></li>
  12       </ul>
  13     </li>
  14   </ul>
  15 </div>
  16
  17 ## <a name="20 Minute TWiki"></a> 20 Minute TWiki
  18
  19 This step-by-step, hands-on tutorial gets you up to speed with all the %WIKITOOLNAME% basics in mere minutes...
  20
  21 ### <a name="1. Get set:"></a> 1. Get set:
  22
  23 - Open two browser windows; arrange them so that you can follow these steps in one window, while trying things out in the other.
  24
  25 ### <a name="2. Take a tour around:"></a> 2. Take a tour around:
  26
  27 - %WIKITOOLNAME% is divided up into webs; each one represents one area of collaboration. The webs are accessible at the upper right corner of each web page.
  28 - Each web has hyper-linked topics. A topic is one web page in your browser.
  29 - The home page in each web is the [[WebHome]] topic.
  30 - To browse a %WIKITOOLNAME% web, just click on any highlighted link. These links are called [[WikiWords]] and comprise two or more words with initial capitals, run together.
  31 - Follow the [[WikiWord]] link and learn what it is.
  32 - 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.
  33 - You can search each %WIKITOOLNAME% web. Enter a search string in the [[WebHome]] topic or the [[WebSearch]] topic accessible from the `Search` link on each topic. %WIKITOOLNAME% searches for an exact match; optionally, you can also use [[RegularExpressions]].
  34
  35 ### <a name="3. Open a private account page:"></a> 3. Open a private account page:
  36
  37 - To edit topics, you need to have a %WIKITOOLNAME% account.
  38 - Go to the [[TWikiRegistration]] page to create your %WIKITOOLNAME% account.
  39
  40 ### <a name="4. Check out %WIKITOOLNAME% User"></a> 4. Check out %WIKITOOLNAME% Users and offices:
  41
  42 - Go to the [[TWikiUsers]] topic in the %WIKITOOLNAME%.Main web; it has a list of all users of %WIKITOOLNAME%. Your [[WikiName]] will be in this list after you register.
  43 - Go to the [[OfficeLocations]] topic in the %WIKITOOLNAME%.Main web; it has a list of corporate offices already entered into %WIKITOOLNAME%.
  44
  45 ### <a name="5. Test the Topic controls:"></a> 5. Test the Topic controls:
  46
  47 - Go to the [[WebHome]] topic to learn what we can do with a topic.
  48 - The bottom of the page has some links:
  49 - `Edit` : Allows you to edit the topic (discussed later)
  50 - `Ref-By` : Find out what other topics link to this topic (reverse link)
  51 - `Attach` : Attach files to a topic (discussed later)
  52 - `Diffs` : Topics are under revision control. Diffs shows you the complete change history of the topic, e.g. who changed what and when.
  53 - `r1.3 | > | r1.2 | > | r1.1` : Allows you to see a previous topic revision or the difference between revisions.
  54
  55 ### <a name="6. Change a page and create a ne"></a> 6. Change a page and create a new one:
  56
  57 - Go to the [[Test|Test/WebHome]] topic of the %WIKITOOLNAME%.Test web. This web is the sandbox where you can make changes at will.
  58 - Press the `Edit` link. You are now in edit mode and you can see the source of the page. (Go to a different topic like [[TestTopic3]] in case you see a "Topic is locked by an other user" warning.)
  59 - Look at the text in edit mode and compare it with the rendered page (move back and forth in your browser.)
  60 - Notice how [[WikiWords]] are linked automatically; there is no link if you look at the text in edit mode.
  61 - Now let's create a new topic, your own sandbox topic:
  62   - In edit mode, enter a new text with a [[WikiWord]], i.e. <br />
  63   - `This is PaulsSandBox topic.`
  64   - Preview and save the topic.
  65   - You can see a linked question mark after the topic name. This means that the topic does not exist yet.
  66   - Click on the question mark. Now you are in edit mode of the new topic.
  67   - Type some text, basically like you write an email.
  68   - A signature with your name is already entered by default. **_Note:_** Please note the `Main.` in front of your name. This means that you have a link from the current web to your personal topic located in the Main web.
  69   - Preview and save the topic.
  70 - Learn about text formatting:
  71   - You write text in [[WikiSyntax]], a very simple markup language. Follow the [[WikiSyntax]] link and learn how to write text.
  72   - Go back to your sandbox topic end edit it.
  73   - Enter some text in [[WikiSyntax]]: **bold** text, _italic_ text, **_bold italic_** text, a bullet list, tables, paragraphs, etc. **_Hint:_** If you need to look up the [[WikiSyntax]], click on the [[TextFormattingRules]] link located below the edit field.
  74   - Preview and save the topic.
  75
  76 ### <a name="7. Upload files as page Attachme"></a> 7. Upload files as page Attachments:
  77
  78 - You can attach any file to a topic, not unlike attachments to an email.
  79 - Go back to your sandbox topic and click on the `Attach` link at the bottom.
  80 - Browse for any file you would like to attach; enter an optional comment.
  81 - Upload and attach the file.
  82 - Do this again with a JPG or GIF image file.
  83 - Checkmark the box "Create a link to the attached file at the end of the topic."
  84 - Upload and attach the image file.
  85 - The image will show up at the bottom of the topic. To move the image, you can edit the topic and move the last line (starting with `<a href="%ATTACHURLPATH%/...`) to anywhere you like.
  86 - If you have a GIF or JPG image of yourself, why not upload it now to your personal topic?
  87
  88 ### <a name="8. Get email alerts when topics"></a><a name="8. Get email alerts when topics "></a> 8. Get email alerts when topics change:
  89
  90 - It is very important that team members are kept in sync of changes.
  91 - [[WebNotify]] (one per %WIKITOOLNAME% web) is a subscription service to be automatically notified by email when topics change in a %WIKITOOLNAME% web. This is a convenient service, so you do not have to come back and check all the time to see if something has changed.
  92 - It is strongly recommended that you subscribe to the %WIKITOOLNAME% web(s) relevant to your work.
  93
  94 That's it! You're now equipped with all the TWiki essentials. You are ready to roll.
  95
  96 **_A side note:_** Initially, it can be daunting to modify text someone else wrote. Please do not worry, nothing gets lost, because previous versions are always accessible (and also recoverable by the %WIKITOOLNAME% administrator if needed.)
  97
  98 -- [[PeterThoeny]] - 28 Dec 2000 <br /> -- [[MikeMannix]] - 29 Aug 2001