steve
/
wiki-archive
mirror of https://github.com/tdwg/wiki-archive.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
wiki-archive/twiki/data/TWiki/TWikiTutorial.txt,v

820 lines
44 KiB
Plaintext
Raw Normal View History

Archive entire twiki setup from owl as of today
2016-02-24 10:46:01 +00:00
head 1.16;
access;
symbols;
locks; strict;
comment @# @;
1.16
date 2007.01.16.04.11.58; author TWikiContributor; state Exp;
branches;
next 1.15;
1.15
date 2006.04.01.05.55.16; author TWikiContributor; state Exp;
branches;
next 1.14;
1.14
date 2006.02.01.12.01.20; author TWikiContributor; state Exp;
branches;
next 1.13;
1.13
date 2004.08.21.22.14.23; author PeterThoeny; state Exp;
branches;
next 1.12;
1.12
date 2002.10.22.06.42.56; author PeterThoeny; state Exp;
branches;
next 1.11;
1.11
date 2002.04.21.06.07.52; author PeterThoeny; state Exp;
branches;
next 1.10;
1.10
date 2001.12.02.07.48.47; author MikeMannix; state Exp;
branches;
next 1.9;
1.9
date 2001.12.02.06.23.00; author MikeMannix; state Exp;
branches;
next 1.8;
1.8
date 2001.09.14.03.09.39; author MikeMannix; state Exp;
branches;
next 1.7;
1.7
date 2001.09.13.08.17.34; author PeterThoeny; state Exp;
branches;
next 1.6;
1.6
date 2001.09.11.22.22.39; author PeterThoeny; state Exp;
branches;
next 1.5;
1.5
date 2001.08.29.09.06.02; author MikeMannix; state Exp;
branches;
next 1.4;
1.4
date 2001.03.25.07.36.10; author PeterThoeny; state Exp;
branches;
next 1.3;
1.3
date 2000.12.29.03.14.56; author PeterThoeny; state Exp;
branches;
next 1.2;
1.2
date 2000.12.14.02.46.48; author PeterThoeny; state Exp;
branches;
next 1.1;
1.1
date 2000.08.18.09.08.04; author PeterThoeny; state Exp;
branches;
next ;
desc
@none
@
1.16
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="16"}%
%TOC%
%STARTINCLUDE%
---# 20-Minute TWiki Tutorial
This step-by-step, hands-on tutorial gets you up to speed with all the TWikiSite basics, in _mere minutes_...
---++ 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 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 %HOMETOPIC% 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.
* 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 %HOMETOPIC% 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...
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, groups.
* Go to the %MAINWEB%.%WIKIUSERSTOPIC% topic in the TWiki.%MAINWEB% web; it has a list of all users of TWiki. Your WikiName will be in this list after you register.
* Go to the %MAINWEB%.TWikiGroups topic in the %MAINWEB% web; it has a list of groups which can be used to define fine grained TWikiAccessControl 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 - =History= shows 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.%HOMETOPIC%][Sandbox]]. 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 Sandbox.%WIKINAME%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.)
* __%T% Tip:__ When you only want to see the source code of a topic click the ==Raw View== link.
* 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:
1. In edit mode, enter a new text with a WikiWord, for example: <br />
=This is <nop>%WIKINAME%Sandbox topic.=
1. 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.
1. Click on the question mark. Now you're in edit mode of the new topic.
1. Type some text, basically, like you write an e-mail.
1. A signature with your name is already entered by default. __NOTE:__ The =%MAINWEB%.= in front of your name means that you have a link from the current web to your personal topic located in the %MAINWEB% web.
1. 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:
1. Go back to your sandbox topic end edit it.
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.
3. 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.
1. Go back to your sandbox topic and click on the ==[Attach]== link at the bottom.
1. Click ==[Browse]== to find a file on your PC that you'd like to attach; enter an optional comment; leave everything else unchecked.
1. 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 =%<nop>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 %WIKIUSERNAME%?
---++ 8. Get e-mail alerts whenever pages are changed...
%NOTIFYTOPIC% 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 %NOTIFYTOPIC%.
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 - 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 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!
__Related Topics:__ UserDocumentationCategory
@
1.15
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="15"}%
d7 1
a7 1
<blockquote>
d74 1
a74 1
</blockquote>
@
1.14
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="14"}%
d13 6
a18 6
* Each web has hyperlinked topics, displayed as pages in your browser.
* The home page in each web is the %HOMETOPIC% 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.
* 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 %HOMETOPIC% 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.
d22 1
a22 1
* Go to the TWikiRegistration page to create your TWiki account. Fill in a couple of lines and you're set!
d25 2
a26 2
* Go to the %MAINWEB%.%WIKIUSERSTOPIC% topic in the TWiki.%MAINWEB% web; it has a list of all users of TWiki. Your WikiName will be in this list after you register.
* Go to the %MAINWEB%.TWikiGroups topic in the %MAINWEB% web; it has a list of groups which can be used to define fine grained TWikiAccessControl in TWiki.
d30 8
a37 8
* ==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 - =History= shows you the complete change history of the topic, for example, who changed what and when
* ==r3 &gt; r2 &gt; 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.
d41 16
a56 16
* 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 Sandbox.%WIKINAME%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.)
* __%T% Tip:__ When you only want to see the source code of a topic click the ==Raw View== link.
* 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:
1. In edit mode, enter a new text with a WikiWord, for example: <br />
=This is <nop>%WIKINAME%Sandbox topic.=
1. 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.
1. Click on the question mark. Now you're in edit mode of the new topic.
1. Type some text, basically, like you write an e-mail.
1. A signature with your name is already entered by default. __NOTE:__ The =%MAINWEB%.= in front of your name means that you have a link from the current web to your personal topic located in the %MAINWEB% web.
1. 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:
1. Go back to your sandbox topic end edit it.
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.
3. Preview and save the topic.
d60 8
a67 8
* Attaching files is just like including a file with an e-mail.
1. Go back to your sandbox topic and click on the ==[Attach]== link at the bottom.
1. Click ==[Browse]== to find a file on your PC that you'd like to attach; enter an optional comment; leave everything else unchecked.
1. 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 =%<nop>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 %WIKIUSERNAME%?
d71 3
a73 3
* 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 %NOTIFYTOPIC%.
@
1.13
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1093126463" format="1.0" version="1.13"}%
d24 1
a24 1
---++ 4. Check out TWiki users, groups, offices...
d26 1
a26 2
* Go to the %MAINWEB%.TWikiGroups topic in the TWiki.%MAINWEB% web; it has a list of groups which can be used to define fine grained TWikiAccessControl in TWiki.
* Go to the %MAINWEB%.OfficeLocations topic in the TWiki.%MAINWEB% 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.
d29 9
a37 8
Go to the [[#PageBottom][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 | &gt; | r1.2 | &gt; | 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.
d41 1
a41 1
* 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 Sandbox.TestTopic3 in case you see a "Topic is locked by an other user" warning.)
d43 1
d46 2
a47 2
1. In edit mode, enter a new text with a WikiWord, ex: <br />
=This is <nop>YourOwnSandBox topic.=
d50 1
a50 1
1. Type some text, basically, like you write an email.
d53 1
a53 1
* Learn about text formatting. You can enter text in TWikiShorthand, a very simple markup language. Follow the TWikiShorthand link to see how, then:
d60 1
a60 1
* Attaching files is just like including a file with an email.
d67 1
a67 1
* 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: %MAINWEB%.%USERNAME%?
d69 2
a70 2
---++ 8. Get email alerts whenever pages are changed...
%NOTIFYTOPIC% 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.
d72 1
a72 1
* 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.
d77 1
a77 1
__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!
d79 1
a79 1
-- Main.MikeMannix - 01 Dec 2001
@
1.12
log
@none
@
text
@d1 79
a79 78
%META:TOPICINFO{author="PeterThoeny" date="1035268976" format="1.0" version="1.12"}%
%TOC%
%STARTINCLUDE%
---# 20-Minute TWiki
This step-by-step, hands-on tutorial gets you up to speed with all the TWikiSite basics, in _mere minutes_...
<blockquote>
---++ 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 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 %HOMETOPIC% 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.
* 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 %HOMETOPIC% 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...
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, groups, offices...
* Go to the %MAINWEB%.%WIKIUSERSTOPIC% topic in the TWiki.%MAINWEB% web; it has a list of all users of TWiki. Your WikiName will be in this list after you register.
* Go to the %MAINWEB%.TWikiGroups topic in the TWiki.%MAINWEB% web; it has a list of groups which can be used to define fine grained TWikiAccessControl in TWiki.
* Go to the %MAINWEB%.OfficeLocations topic in the TWiki.%MAINWEB% 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 [[#PageBottom][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 | &gt; | r1.2 | &gt; | 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 [[Sandbox.%HOMETOPIC%][Sandbox]]. 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 Sandbox.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:
1. In edit mode, enter a new text with a WikiWord, ex: <br />
=This is <nop>YourOwnSandBox topic.=
1. 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.
1. Click on the question mark. Now you're in edit mode of the new topic.
1. Type some text, basically, like you write an email.
1. A signature with your name is already entered by default. __NOTE:__ The =%MAINWEB%.= in front of your name means that you have a link from the current web to your personal topic located in the %MAINWEB% web.
1. 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:
1. Go back to your sandbox topic end edit it.
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.
3. 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 email.
1. Go back to your sandbox topic and click on the ==[Attach]== link at the bottom.
1. Click ==[Browse]== to find a file on your PC that you'd like to attach; enter an optional comment; leave everything else unchecked.
1. 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 =%<nop>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: %MAINWEB%.%USERNAME%?
---++ 8. Get email alerts whenever pages are changed...
%NOTIFYTOPIC% 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 %NOTIFYTOPIC%.
</blockquote>
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 - 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!
-- Main.MikeMannix - 01 Dec 2001
@
1.11
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1019369272" format="1.0" version="1.11"}%
d31 1
a31 1
* ==[[Edit]== - add to or edit the topic (discussed later)
@
1.10
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1007279327" format="1.0" version="1.10"}%
d40 2
a41 2
Go to the [[Test.%HOMETOPIC%][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 Test.TestTopic3 in case you see a "Topic is locked by an other user" warning.)
@
1.9
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1007274180" format="1.0" version="1.9"}%
d6 1
a6 1
This step-by-step, hands-on tutorial gets you up to speed with all the TWiki basics, in _mere minutes_...
@
1.8
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000440123" format="1.0" version="1.8"}%
d4 1
a4 1
---## 20-Minute TWiki
d6 1
a6 1
This step-by-step, hands-on tutorial gets you up to speed with all the %WIKITOOLNAME% basics, in mere minutes...
d8 2
a9 2
---+++ 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.
d11 2
a12 2
---+++ 2. Take a whirlwind tour:
A %WIKITOOLNAME% 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.
d15 1
a15 1
* 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.
d18 1
a18 1
* You can search each %WIKITOOLNAME% web. Enter a search string in the %HOMETOPIC% 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.
d20 22
a41 21
---+++ 3. Open a private account page:
To edit topics, you need to have a %WIKITOOLNAME% account.
* Go to the TWikiRegistration page to create your %WIKITOOLNAME% account.
---+++ 4. Check out %WIKITOOLNAME% Users, offices and groups:
* Go to the %MAINWEB%.%WIKIUSERSTOPIC% topic in the %WIKITOOLNAME%.%MAINWEB% web; it has a list of all users of %WIKITOOLNAME%. Your WikiName will be in this list after you register.
* Go to the %MAINWEB%.OfficeLocations topic in the %WIKITOOLNAME%.%MAINWEB% web; it has a list of corporate offices already entered into %WIKITOOLNAME%.
* Go to the %MAINWEB%.TWikiGroups topic in the %WIKITOOLNAME%.%MAINWEB% web; it has a list of groups which can be used to define fine grained TWikiAccessControl in %WIKITOOLNAME%.
---+++ 5. Test the page controls:
Go to the %HOMETOPIC% 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 | &gt; | r1.2 | &gt; | 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.
---+++ 6. Change a page and create a new one:
Go to the Test.%HOMETOPIC% topic of the %WIKITOOLNAME%.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 Test.TestTopic3 in case you see a "Topic is locked by an other user" warning.)
d44 5
a48 5
* Now, create a new topic, your own test page:
1. In edit mode, enter a new text with a WikiWord, i.e. <br>
=This is <nop>PaulsSandBox topic.=
1. 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.
1. Click on the question mark. Now you are in edit mode of the new topic.
d51 2
a52 2
1. 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:
d54 1
a54 1
2. 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.
d57 16
a72 15
---+++ 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 =%<nop>ATTACHURL%=) to anywhere you like.
* If you have a GIF or JPG image of yourself, why not upload it now to your personal topic?
---+++ 8. Get email alerts when topics change:
It is very important that team members are kept in sync of changes.
* %NOTIFYTOPIC% (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.
* It is strongly recommended that you subscribe to the %WIKITOOLNAME% web(s) relevant to your work.
d76 1
a76 1
__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!
d78 1
a78 2
-- PeterThoeny - 13 Sep 2001 <br />
-- MikeMannix - 14 Sep 2001 <br />
@
1.7
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1000369054" format="1.0" version="1.7"}%
d4 1
a4 3
---## 20 Minute TWiki
This step-by-step, hands-on tutorial gets you up to speed with all the %WIKITOOLNAME% basics in mere minutes...
d6 2
d9 1
a9 1
* Open two browser windows; arrange them so that you can follow these steps in one window, while trying things out in the other.
d11 3
a13 3
---+++ 2. Take a tour around:
* %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.
* Each web has hyper-linked topics. A topic is one web page in your browser.
d21 1
a21 1
* To edit topics, you need to have a %WIKITOOLNAME% account.
d29 8
a36 9
---+++ 5. Test the Topic controls:
* Go to the %HOMETOPIC% topic to learn what we can do with a topic.
* The bottom of the page has some links:
* =Edit= : Allows you to 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= : Allows you to see a previous topic revision or the difference between revisions.
* =More= : More actions on the topic, like rename/move, version control and setting the topic parent.
d39 2
a40 2
* Go to the Test.%HOMETOPIC% topic of the %WIKITOOLNAME%.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 Test.TestTopic3 in case you see a "Topic is locked by an other user" warning.)
d43 12
a54 14
* Now let's create a new topic, your own sandbox topic:
* In edit mode, enter a new text with a WikiWord, i.e. <br>
* =This is <nop>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.
* Type some text, basically like you write an email.
* A signature with your name is already entered by default. __Note:__ Please note the =%MAINWEB%.= in front of your name. This means that you have a link from the current web to your personal topic located in the %MAINWEB% web.
* Preview and save the topic.
* Learn about text formatting:
* You write text in WikiSyntax, a very simple markup language. Follow the WikiSyntax link and learn how to write text.
* 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.
* Preview and save the topic.
d57 1
a57 1
* You can attach any file to a topic, not unlike attachments to an email.
d68 1
a68 1
* It is very important that team members are kept in sync of changes.
d71 1
a71 1
d74 1
a74 1
__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.)
d76 2
a77 2
-- Main.PeterThoeny - 13 Sep 2001 <br />
-- MikeMannix - 29 Aug 2001
@
1.6
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1000247135" format="1.0" version="1.6"}%
d37 1
d67 1
a67 1
* 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 =&lt;a href="%<nop>ATTACHURLPATH%/...=) to anywhere you like.
d79 1
a79 1
-- Main.PeterThoeny - 28 Dec 2000 <br>
@
1.5
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999077269" format="1.0" version="1.5"}%
d24 1
a24 1
---+++ 4. Check out %WIKITOOLNAME% Users and offices:
d27 1
@
1.4
log
@none
@
text
@d1 71
a71 1
This is a short, step-by-step tutorial to get you up to speed on %WIKITOOLNAME%.
d73 1
a73 2
* Preparation:
* 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.
d75 1
a75 65
* Navigation and search:
* %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.
* Each web has hyper-linked topics. A topic is one web page in your browser.
* The home page in each web is the %HOMETOPIC% topic.
* 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.
* 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 %WIKITOOLNAME% web. Enter a search string in the %HOMETOPIC% 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.
* Create your account:
* To edit topics, you need to have a %WIKITOOLNAME% account.
* Go to the TWikiRegistration page to create your %WIKITOOLNAME% account.
* %WIKITOOLNAME% Users and offices:
* Go to the %MAINWEB%.%WIKIUSERSTOPIC% topic in the %WIKITOOLNAME%.%MAINWEB% web; it has a list of all users of %WIKITOOLNAME%. Your WikiName will be in this list after you register.
* Go to the %MAINWEB%.OfficeLocations topic in the %WIKITOOLNAME%.%MAINWEB% web; it has a list of corporate offices already entered into %WIKITOOLNAME%.
* Operations on topics:
* Go to the %HOMETOPIC% topic to learn what we can do with a topic.
* The bottom of the page has some links:
* =Edit= : Allows you to 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= : Allows you to see a previous topic revision or the difference between revisions.
* Editing a topic and creating hyperlinked pages:
* Go to the Test.%HOMETOPIC% topic of the %WIKITOOLNAME%.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 Test.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 let's create a new topic, your own sandbox topic:
* In edit mode, enter a new text with a WikiWord, i.e. <br>
=This is <nop>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.
* Type some text, basically like you write an email.
* A signature with your name is already entered by default. __Note:__ Please note the =%MAINWEB%.= in front of your name. This means that you have a link from the current web to your personal topic located in the %MAINWEB% web.
* Preview and save the topic.
* Learn about text formatting:
* You write text in WikiSyntax, a very simple markup language. Follow the WikiSyntax link and learn how to write text.
* 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.
* Preview and save the topic.
* Attaching files to a topic:
* 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 (starting with =&lt;a href="%<nop>ATTACHURLPATH%/...=) to anywhere you like.
* If you have a GIF or JPG image of yourself, why not upload it now to your personal topic?
* Getting notified of topic changes:
* It is very important that team members are kept in sync of changes.
* %NOTIFYTOPIC% (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.
* It is strongly recommended that you subscribe to the %WIKITOOLNAME% web(s) relevant to your work.
This concludes the tutorial. Now you are ready to roll.
__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.)
d78 1
@
1.3
log
@none
@
text
@d24 1
a24 1
* Go the the %HOMETOPIC% topic to learn what we can do with a topic.
d33 1
a33 1
* Go the the Test.%HOMETOPIC% topic of the %WIKITOOLNAME%.Test web. This web is the sandbox where you can make changes at will.
@
1.2
log
@none
@
text
@d13 1
a13 1
* You can search each %WIKITOOLNAME% web. Enter a search string in the %HOMETOPIC% 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. __Note:__ A search only looks in the current web unless you use the advanced search option.
d17 1
a17 1
* Go to the TWikiRegistration page to create your TWiki account.
d20 1
a20 1
* Go to the %MAINWEB%.%WIKIUSERSTOPIC% 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.
d49 1
a49 1
* Enter some text in WikiSyntax: *bold* text, _italic_ text, __bold italic__ text, a bullet list, tables, paragraphs, e.t.c. __Hint:__ If you need to look up the WikiSyntax, click on the TextFormattingRules link located below the edit field.
d60 1
a60 1
* 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 =&lt;a href="%<nop>ATTACHURLPATH%/...= ) to anywhere you like.
d64 1
a64 1
* It is very important that team members are kept in synch of changes.
d70 1
a70 1
__A side note:__ Initially it can be intriguing to change 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.)
d72 1
a72 1
-- Main.PeterThoeny - 13 Dec 2000 <br>
@
1.1
log
@none
@
text
@d9 1
a9 1
* The home page in each web is the WebHome topic.
d13 1
a13 1
* 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. __Note:__ A search only looks in the current web unless you use the advanced search option.
d20 2
a21 2
* Go to the Main.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.
* Go to the Main.OfficeLocations topic in the %WIKITOOLNAME%.Main web; it has a list of corporate offices already entered into %WIKITOOLNAME%.
d24 1
a24 1
* Go the the WebHome topic to learn what we can do with a topic.
d33 1
a33 1
* Go the the Test.WebHome topic of the %WIKITOOLNAME%.Test web. This web is the sandbox where you can make changes at will.
d44 1
a44 1
* 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.
d65 1
a65 1
* 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.
d72 1
a72 1
-- Main.PeterThoeny - 18 Aug 2000 <br>
@