20-Minute TWiki Tutorial
This step-by-step, hands-on tutorial gets you up to speed with all the TWiki Site basics, in mere minutes...On this page:
1. Get set...
Open two browser windows, so that you can follow these steps in one window, while trying things out in the other.2. Take a quick tour...
A TWiki Site 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.- Each web has hyperlinked topics, displayed as pages in your browser.
- The home page in each web is the Web Home topic.
- To browse a TWiki web, just click on any highlighted link. These links are called Wiki Words and comprise two or more words with initial capitals, run together.
- Follow the Wiki Word link and learn what it is.
- 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
WebSearchto jump to the search page. Hint: Do not confuse the Go field with search. - You can search each TWiki web. Enter a search string in the Web Home topic or the Web Search topic accessible from the
Searchlink on each topic. TWiki searches for an exact match; optionally, you can also use Regular Expressions.
3. Open a private account...
To edit topics, you need to have a TWiki account.- Go to the TWiki Registration page to create your TWiki account. Fill in a couple of lines and you're set!
4. Check out TWiki users, groups.
- Go to the TWiki Users topic; it has a list of all users of TWiki. Your Wiki Name will be in this list after you register.
- Go to the TWiki Groups topic in the Main web; it has a list of groups which can be used to define fine grained TWiki Access Control in TWiki.
5. Test the page controls...
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::-
Edit- add to or edit the topic (discussed later) -
Raw View- show the source text without editing the topic -
Attach- attach files to a topic (discussed later) -
Backlinks- find out what other topics link to this topic (reverse link) -
Printable- goes to a stripped down version of the page, good for printing -
History- topics are under revision control -Historyshows you the complete change history of the topic, for example, who changed what and when -
r3 > r2 > r1- view a previous version of the topic or the difference between two versions -
More- additional controls, such as rename/move, version control and setting the topic's parent.
6. Change a page, and create a new one...
Go to the Sandbox. This is the sandbox web, where you can make changes and try it all out at will.- Click the
Editlink. You are now in edit mode and you can see the source of the page. (Go to a different topic like TWiki Guest Sandbox? if you see a "Topic is being edited by an other user" warning.) - Look at the text in edit mode and compare it with the rendered page (move back and forth in your browser.)
-
Tip: When you only want to see the source code of a topic click the Raw Viewlink. - Notice how Wiki Words are linked automatically; there is no link if you look at the text in edit mode.
- Now, create a new topic - your own test page:
- In edit mode, enter a new text with a Wiki Word, for example:
This is TWikiGuestSandbox topic. - 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.
- Click on the question mark. Now you're in edit mode of the new topic.
- Type some text, basically, like you write an e-mail.
- 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. - Preview and save the topic...
- In edit mode, enter a new text with a Wiki Word, for example:
- Learn about text formatting. You can enter text in TWikiShorthand, a very simple markup language. Follow the TWiki Shorthand link to see how, then:
- Go back to your sandbox topic end edit it.
- Enter some text in TWiki Shorthand: bold text, italic text, bold italic text, a bullet list, tables, paragraphs, etc. Hint: If you need help, click on the Text Formatting Rules link located below the text box in edit mode.
- Preview and save the topic.
7. Use your browser to upload files as page attachments...
You can attach any type of file to a topic - documents, images, programs, whatever - where they can be opened, viewed, or downloaded.- Attaching files is just like including a file with an e-mail.
- Go back to your sandbox topic and click on the
[Attach]link at the bottom. - Click
[Browse]to find a file on your PC that you'd like to attach; enter an optional comment; leave everything else unchecked. - Click
[Upload file], then scroll to the end of the page to see the new attachment listing.
- Go back to your sandbox topic and click on the
- Do this again - this time, upload a GIF, JPG or PNG image file.
- 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. - To move the image, edit the topic and place the last line (containing
%ATTACHURL%) anywhere on the page.
- Check the
- 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 TWiki Guest?
8. Get e-mail alerts whenever pages are changed...
Web Notify 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.- 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.
- 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.
- 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 Web Notify.
| Topic TWikiTutorial . { Edit | Attach | Backlinks: Web All webs | Printable | History: r17 < r16 < r15 < r14 < r13 More } |