| |
|
< < | 20-Minute TWiki |
> > | 20-Minute TWiki |
| |
|
< < | This step-by-step, hands-on tutorial gets you up to speed with all the TWiki basics, in mere minutes... |
> > | This step-by-step, hands-on tutorial gets you up to speed with all the TWiki basics, in mere minutes... |
| |
|
< < | 1. Get set:
Open two browser windows, side-by-side, so that you can follow these steps in one window, while trying things out in the other. |
> > | 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 whirlwind 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. |
> > | 2. Take a quick tour...
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. |
|
- Each web has hyperlinked topics, displayed as pages in your browser.
- The home page in each web is the WebHome topic.
|
|
< < |
- 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.
|
> > |
- 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.
|
|
- Follow the WikiWord 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
WebSearch to 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 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.
|
> > |
- 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.
|
| |
|
< < | 3. Open a private account page:
To edit topics, you need to have a TWiki account. |
> > | 3. Open a private account...
To edit topics, you need to have a TWiki account.
- Go to the TWikiRegistration page to create your TWiki account. Fill in a couple of lines and you're set!
|
| |
|
< < | 4. Check out TWiki Users, offices and groups:
- 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.
- Go to the OfficeLocations topic in the TWiki.Main web; it has a list of corporate offices already entered into TWiki.
- 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.
|
> > | 4. Check out TWiki users, groups, offices...
- 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.
- 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.
- 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.
|
| |
|
< < | 5. Test the page controls:
Go to the WebHome page to find out what you can do. The bottom of the page has action links:
- Edit - add to or edit the topic (discussed later)
- Ref-By - find out what other topics link to this topic (reverse link)
- Attach - attach files to a topic (discussed later)
- Diffs - topics are under revision control. Diffs shows you the complete change history of the topic, e.g. who changed what and when.
- r1.3 | > | r1.2 | > | r1.1 - view a previous version of the topic or the difference between two revisions
- More - additional controls, like Rename/move, version control and setting the topic parent.
|
> > | 5. Test the page controls...
Go to the bottom of the page to see what you can do. The color-coded control strip has a collection of action links:
-
[[Edit] - add to or edit the topic (discussed later)
-
[Attach] - attach files to a topic (discussed later)
-
[Ref-By] - find out what other topics link to this topic (reverse link)
-
[Printable] - goes to a stripped down version of the page, good for printing
-
[Diffs] - topics are under revision control - [Diffs] shows you the complete change history of the topic, ex: who changed what and when.
-
[r1.3 | > | r1.2 | > | r1.1] - view a previous version of the topic or the difference between two versions.
|
|
> > |
-
[More] - additional controls, like [Rename/move] , version control and setting the topic's parent.
|
| |
|
< < | 6. Change a page and create a new one:
Go to the Test topic of the TWiki.Test web. This web is the sandbox where you can make changes at will.
- 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.)
|
> > | 6. Change a page, and create a new one...
Go to the Test. This is the sandbox web, where you can make changes and try it all out at will.
- 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 TestTopic3 in case you see a "Topic is locked 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.)
- Notice how WikiWords 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 WikiWord, i.e.
This is PaulsSandBox topic.
- Preview and save the topic. You can see a linked question mark after the topic name. This means that the topic does not exist yet.
- Click on the question mark. Now you are in edit mode of the new topic.
|
> > |
- Now, create a new topic - your own test page:
- In edit mode, enter a new text with a WikiWord, ex:
This is YourOwnSandBox 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 email.
- 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.
- Learn about text formatting. You can enter text in WikiSyntax, a very simple markup language. Follow the WikiSyntax link to see how, then:
|
> > |
-
- Preview and save the topic...
- Learn about text formatting. You can enter text in TWikiShorthand, a very simple markup language. Follow the TWikiShorthand link to see how, then:
|
|
-
- Go back to your sandbox topic end edit it.
|
|
< < |
-
- 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.
|
> > |
-
- 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.
|
|
-
- Preview and save the topic.
|
|
< < | 7. Upload files as page Attachments:
You can attach any file to a topic, not unlike attachments to an email.
- Go back to your sandbox topic and click on the
Attach link at the bottom.
- Browse for any file you would like to attach; enter an optional comment.
- Upload and attach the file.
- Do this again with a JPG or GIF image file.
- Checkmark the box "Create a link to the attached file at the end of the topic."
- Upload and attach the image file.
- 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 (bullet containing
%ATTACHURL% ) to anywhere you like.
- If you have a GIF or JPG image of yourself, why not upload it now to your personal 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 email.
- 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.
- 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.
- 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.guest?
|
| |
|
< < | 8. Get email alerts when topics change:
It is very important that team members are kept in sync of changes.
- WebNotify (one per TWiki web) is a subscription service to be automatically notified by email when topics change in a TWiki 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.
- It is strongly recommended that you subscribe to the TWiki web(s) relevant to your work.
|
> > | 8. Get email alerts whenever pages are changed...
WebNotify 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.
- 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 emailed 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 WebNotify.
|
|
That's it! You're now equipped with all the TWiki essentials. You are ready to roll. |
|
< < | NOTE: When first using TWiki, it will probably seem strange to be able to change other people's postings - separated messages is the online rule, with email, message boards, non-Wiki collaboration platforms. Don't worry about it. Nothing gets lost, you can always check previous versions, and copy-and-paste from them if you want to revert after saving a change. Use TWiki for a short while, and you'll want this sort of natural communications freedom...everywhere! |
> > | 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! |
| |
|
< < | -- PeterThoeny - 13 Sep 2001
|
> > | -- MikeMannix - 01 Dec 2001 |
|
< < | -- MikeMannix - 14 Sep 2001 |
| |