On this page:
- 1. Get set...
- 2. Take a quick tour...
- 3. Open a private account...
- 4. Check out Foswiki users and groups.
- 5. Test the page controls...
- 6. Create a new topic and edit an existing one
- 7. Use your browser to upload files as page attachments...
- 8. Get e-mail alerts whenever pages are changed...
- 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 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 Jump field on the top of a page. Type
WebSearchto jump to the search page.
- You can search each web. Enter a search string into the Search field on the top of a page. Foswiki searches for an exact match
- Advanced Search lets you select different search types, including database-style Queries and even Regular Expressions.
Do not confuse the Jump field with the Search field.
- Go to the User Registration page to create your own Foswiki account. Fill in a couple of lines and you're set!
- Go to the Wiki Users topic in the Main web; it has a list of all users of Foswiki. Your Wiki Name will be listed after you register.
- Go to the Wiki Groups topic in the Main web; it has a list of groups which can be used to define fine grained Access Control in Foswiki.
[Edit]- edit an existing topic (discussed later)
[Attach]- attach files to a topic (discussed later)
[Print version]- 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
[View wiki text]- show the source text's Wiki Syntax without editing the topic
[More topic actions]- additional controls, such as rename/move or setting the topic's parent.
- Go to the Sandbox web. This web provides and area where you can make changes and try it all out at will.
- Click the
[Create New Topic]link in the main menue; it is normally located on the left side of a page. A new page will open where you put the name of the new topic you are going to create. This name will also be used to link from one topic to another. For example, the name of this topic is Twenty Minute Tutorial.
- Enter a name for the new topic (preferably a Wiki Word), for example
MyFirstTopic(if it says that this topic already exists, just choose a different one). After that, click
- The screen now changes to the edit mode. Just start entering some text, as if you wrote an e-mail.
[Save]to save the page. The edit mode disappears and you will be redirected to the topic you just created. Congratulations - you are now actively participating in Foswiki! And it was really simple, wasn't it?
- Click on the
[Edit]link - you will be redirected to the edit mode again.
- Do some changes to your original text and save it. Done!
- Click once more on the
- Again, in the edit mode, type a Wiki Word. A Wiki Word is a word consisting of at least two capitalized words run together, so type e.g.
- Save the topic and have a look at the Wiki Word you just typed. You will notice a question mark behind the Wiki Word. Once you finish creating your second topic, the question mark will disappear and word will be converted into a link. In fact, the word Wiki Word is a link, too. Using the name of a topic is the easiest way to create links between two topics.
- Now click on the question mark behind the Wiki Word you just entered. You will be redirected to the edit mode, this time not for your first topic, but for the new one. This new (second) topic will be named after the link you created in the original topic. So if the Wiki Word you typed in the original text was
MySecondTopic, the new topic will be called
If you were not redirected to the edit mode, but see some strange text (which is not yours) instead, it seems like the topic already existed In this case, go back in your browser and type something different from
- Using the WYSIWYG editor - highlight and format text as you would do it in a normal text editor
- Using TML shorthand - TML (Topic Markup Language) is a very simple markup language. For additional information on editing topics and formatting text with TML, have a look at Wiki Syntax, Text Formatting Rules and Topics And Webs.
Your site administrator may have blocked some types of files (such as
.html) from being attached for security reasons.
- Attaching files is just like including a file with an e-mail.
- Go once more to your sandbox topic and click on the
[Browse]to find a file on your PC that you'd like to attach; enter an optional comment; leave everything else unchecked.
[Upload file], then scroll to the end of the page to see the new attachment listing.
- Go once more to your sandbox topic and click on the
- Do this again - this time, upload a GIF, JPG or PNG image file.
- Check the
Properties:box saying Create a link to the attached file. Once saving 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 Wiki Guest?
- If you're using Foswiki 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 Foswiki web that's relevant to you. You can subscribe and unsubscribe instantly, on a per web basis using Web Notify.
When first using Foswiki, it will probably seem strange to be able to change other people's postings - we're used to separating individual messages, with e-mail, 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 restore them, if necessary, if you want to undo any changes. After a short while, it'll become second-nature and you'll expect it everywhere!Related Topics: User Documentation Category, Topics And Webs, Wiki Syntax