6683d843a02337ba995fd179211de7dae4e94054
[openafs-wiki.git] / TWiki / TWikiTutorial.mdwn
1 This is a short, step-by-step tutorial to get you up to speed on %WIKITOOLNAME%.
2
3 - Preparation:
4   - Open up a new browser window. While you are working in one window, you can look at the step-by-step tutorial instructions in the other window.
5
6 - Navigation and search:
7   - %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.
8   - Each web has hyper-linked topics. A topic is one web page in your browser.
9   - The home page in each web is the [[WebHome]] topic.
10   - 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.
11   - Follow the [[WikiWord]] link and learn what it is.
12   - 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.
13   - 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]].
14
15 - Create your account:
16   - To edit topics, you need to have a %WIKITOOLNAME% account.
17   - Go to the [[TWikiRegistration]] page to create your %WIKITOOLNAME% account.
18
19 - %WIKITOOLNAME% Users and offices:
20   - 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.
21   - Go to the [[OfficeLocations]] topic in the %WIKITOOLNAME%.Main web; it has a list of corporate offices already entered into %WIKITOOLNAME%.
22
23 - Operations on topics:
24   - Go the the [[WebHome]] topic to learn what we can do with a topic.
25   - The bottom of the page has some links:
26   - `Edit` : Allows you to edit the topic (discussed later)
27   - `Ref-By` : Find out what other topics link to this topic (reverse link)
28   - `Attach` : Attach files to a topic (discussed later)
29   - `Diffs` : Topics are under revision control. Diffs shows you the complete change history of the topic, e.g. who changed what and when.
30   - `r1.3 | > | r1.2 | > | r1.1` : Allows you to see a previous topic revision or the difference between revisions.
31
32 - Editing a topic and creating hyperlinked pages:
33   - Go the the [[Test|Test/WebHome]] topic of the %WIKITOOLNAME%.Test web. This web is the sandbox where you can make changes at will.
34   - 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.)
35   - Look at the text in edit mode and compare it with the rendered page (move back and forth in your browser.)
36   - Notice how [[WikiWords]] are linked automatically; there is no link if you look at the text in edit mode.
37   - Now let's create a new topic, your own sandbox topic:
38     - In edit mode, enter a new text with a [[WikiWord]], i.e. <br />`This is PaulsSandBox topic.`
39     - Preview and save the topic.
40     - You can see a linked question mark after the topic name. This means that the topic does not exist yet.
41     - Click on the question mark. Now you are in edit mode of the new topic.
42     - Type some text, basically like you write an email.
43     - 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.
44     - Preview and save the topic.
45   - Learn about text formatting:
46     - You write text in [[WikiSyntax]], a very simple markup language. Follow the [[WikiSyntax]] link and learn how to write text.
47     - Go back to your sandbox topic end edit it.
48     - 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.
49     - Preview and save the topic.
50
51 - Attaching files to a topic:
52   - You can attach any file to a topic, not unlike attachments to an email.
53   - Go back to your sandbox topic and click on the `Attach` link at the bottom.
54   - Browse for any file you would like to attach; enter an optional comment.
55   - Upload and attach the file.
56   - Do this again with a JPG or GIF image file.
57   - Checkmark the box "Create a link to the attached file at the end of the topic."
58   - Upload and attach the image file.
59   - 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.
60   - If you have a GIF or JPG image of yourself, why not upload it now to your personal topic?
61
62 - Getting notified of topic changes:
63   - It is very important that team members are kept in sync of changes.
64   - [[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.
65   - It is strongly recommended that you subscribe to the %WIKITOOLNAME% web(s) relevant to your work.
66
67 This concludes the tutorial. Now you are ready to roll.
68
69 **_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.)
70
71 -- [[PeterThoeny]] - 28 Dec 2000 <br />