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 quick tour..."> 2. Take a quick tour...</a></li>
   6         <li><a href="#3. Open a private account..."> 3. Open a private account...</a></li>
   7         <li><a href="#4. Check out TWiki users, groups"> 4. Check out TWiki users, groups, offices...</a></li>
   8         <li><a href="#5. Test the page controls..."> 5. Test the page controls...</a></li>
   9         <li><a href="#6. Change a page, and create a n"> 6. Change a page, and create a new one...</a></li>
  10         <li><a href="#7. Use your browser to upload fi"> 7. Use your browser to upload files as page attachments...</a></li>
  11         <li><a href="#8. Get email alerts whenever pag"> 8. Get email alerts whenever pages are changed...</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 TWiki basics, in _mere minutes_...
  20
  21 > ## <a name="1. Get set..."></a> 1. Get set...
  22 >
  23 > Open two browser windows, so that you can follow these steps in one window, while trying things out in the other.
  24 >
  25 > ## <a name="2. Take a quick tour..."></a> 2. Take a quick tour...
  26 >
  27 > A
  28 >
  29 > [[TWikiSite]]
  30 >
  31 > 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.
  32 >
  33 > - Each web has hyperlinked topics, displayed as pages in your browser.
  34 > - The home page in each web is the [[WebHome]] topic.
  35 > - 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.
  36 > - Follow the [[WikiWord]] link and learn what it is.
  37 > - 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.
  38 > - You can search each TWiki web. Enter a search string in the [[WebHome]] 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]].
  39 >
  40 > ## <a name="3. Open a private account..."></a> 3. Open a private account...
  41 >
  42 > To edit topics, you need to have a TWiki account.
  43 >
  44 > - Go to the [[TWikiRegistration]] page to create your TWiki account. Fill in a couple of lines and you're set!
  45 >
  46 > ## <a name="4. Check out TWiki users, groups"></a> 4. Check out TWiki users, groups, offices...
  47 >
  48 > - Go to the [[TWikiUsers]] topic in the TWiki.Main web; it has a list of all users of TWiki. Your [[WikiName]] will be in this list after you register.
  49 > - Go to the [[TWikiGroups]] topic in the TWiki.Main web; it has a list of groups which can be used to define fine grained [[TWikiAccessControl]] in TWiki.
  50 > - Go to the [[OfficeLocations]] topic in the TWiki.Main web; it has a sample list of corporate offices. This type of set-up can be used for departments, client companies, or any other type of organizational divisions.
  51 >
  52 > ## <a name="5. Test the page controls..."></a> 5. Test the page controls...
  53 >
  54 > Go to the
  55 >
  56 > [[bottom of the page|Main/WebHome#PageBottom]]
  57 >
  58 > to see what you can do. The color-coded control strip has a collection of action links:
  59 >
  60 > - <code>**\[[Edit]**</code> - add to or edit the topic (discussed later)
  61 > - <code>**[Attach]**</code> - attach files to a topic (discussed later)
  62 > - <code>**[Ref-By]**</code> - find out what other topics link to this topic (reverse link)
  63 > - <code>**[Printable]**</code> - goes to a stripped down version of the page, good for printing
  64 > - <code>**[Diffs]**</code> - topics are under revision control - `[Diffs]` shows you the complete change history of the topic, ex: who changed what and when.
  65 > - <code>**[r1.3 | &gt; | r1.2 | &gt; | r1.1]**</code> - view a previous version of the topic or the difference between two versions.
  66 > - <code>**[More]**</code> - additional controls, like <code>**[Rename/move]**</code>, version control and setting the topic's parent.
  67 >
  68 > ## <a name="6. Change a page, and create a n"></a> 6. Change a page, and create a new one...
  69 >
  70 > Go to the
  71 >
  72 > [[Test|Test/WebHome]]
  73 >
  74 > . This is the sandbox web, where you can make changes and try it all out at will.
  75 >
  76 > - Click the <code>**[Edit]**</code> 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.)
  77 > - Look at the text in edit mode and compare it with the rendered page (move back and forth in your browser.)
  78 > - Notice how [[WikiWords]] are linked automatically; there is no link if you look at the text in edit mode.
  79 > - Now, create a new topic - your own test page:
  80 >   1. In edit mode, enter a new text with a [[WikiWord]], ex: <br />`This is YourOwnSandBox topic.`
  81 >   2. 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.
  82 >   3. Click on the question mark. Now you're in edit mode of the new topic.
  83 >   4. Type some text, basically, like you write an email.
  84 >   5. A signature with your name is already entered by default. **_NOTE:_** The `Main.` in front of your name means that you have a link from the current web to your personal topic located in the Main web.
  85 >   6. Preview and save the topic...
  86 > - Learn about text formatting. You can enter text in [[TWikiShorthand]], a very simple markup language. Follow the [[TWikiShorthand]] link to see how, then:
  87 >   1. Go back to your sandbox topic end edit it.
  88 >   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.
  89 >   3. Preview and save the topic.
  90 >
  91 > ## <a name="7. Use your browser to upload fi"></a> 7. Use your browser to upload files as page attachments...
  92 >
  93 > You can attach
  94 >
  95 > _any_
  96 >
  97 > type of file to a topic - documents, images, programs, whatever - where they can be opened, viewed, or downloaded.
  98 >
  99 > - Attaching files is just like including a file with an email.
 100 >   1. Go back to your sandbox topic and click on the <code>**[Attach]**</code> link at the bottom.
 101 >   2. Click <code>**[Browse]**</code> to find a file on your PC that you'd like to attach; enter an optional comment; leave everything else unchecked.
 102 >   3. Click <code>**[Upload file]**</code>, then scroll to the end of the page to see the new attachment listing.
 103 > - Do this again - this time, upload a GIF, JPG or PNG image file.
 104 >   - Check the <code>**[Link:]**</code> 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.
 105 >   - To move the image, edit the topic and place the last line (containing `%ATTACHURL%`) anywhere on the page.
 106 > - 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: Main.admin?
 107 >
 108 > ## <a name="8. Get email alerts whenever pag"></a> 8. Get email alerts whenever pages are changed...
 109 >
 110 > [[WebNotify]]
 111 >
 112 > is a subscription service that automatically notifies you by email when topics change in a TWiki web. This is a convenience service - for many people, checking email is easier than checking the Web.
 113 >
 114 > - 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.
 115 > - Alerts are emailed as links to individual topics that've been changed in a set period: each day, every hour, whatever is configured for your system.
 116 > - 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 [[WebNotify]].
 117
 118 That's it! You're now equipped with all the TWiki essentials. You are ready to roll.
 119
 120 **_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 email, 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!
 121
 122 -- [[MikeMannix]] - 01 Dec 2001