diff options
Diffstat (limited to 'TWiki')
| -rw-r--r-- | TWiki/TWikiTutorial.mdwn | 100 |
1 files changed, 51 insertions, 49 deletions
diff --git a/TWiki/TWikiTutorial.mdwn b/TWiki/TWikiTutorial.mdwn index 87dce52a..ac91ab1f 100644 --- a/TWiki/TWikiTutorial.mdwn +++ b/TWiki/TWikiTutorial.mdwn @@ -1,88 +1,90 @@ %TOC% %STARTINCLUDE% -## <a name="20_Minute_TWiki"> 20-Minute TWiki </a> +# <a name="20_Minute_TWiki"> 20-Minute TWiki </a> -This step-by-step, hands-on tutorial gets you up to speed with all the %WIKITOOLNAME% basics, in mere minutes... +This step-by-step, hands-on tutorial gets you up to speed with all the TWiki basics, in _mere minutes_... -> ### <a name="1_Get_set_"> 1. Get set: </a> +> ## <a name="1_Get_set_"> 1. Get set... </a> > -> Open two browser windows, side-by-side, so that you can follow these steps in one window, while trying things out in the other. +> Open two browser windows, so that you can follow these steps in one window, while trying things out in the other. > -> ### <a name="2_Take_a_whirlwind_tour_"> 2. Take a whirlwind tour: </a> +> ## <a name="2_Take_a_quick_tour_"> 2. Take a quick tour... </a> > -> 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. +> 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 %WIKITOOLNAME% 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 %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]]. +> * 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]]. > -> ### <a name="3_Open_a_private_account_page_"> 3. Open a private account page: </a> +> ## <a name="3_Open_a_private_account_"> 3. Open a private account... </a> > -> To edit topics, you need to have a %WIKITOOLNAME% account. +> To edit topics, you need to have a TWiki account. > -> * Go to the [[TWikiRegistration]] page to create your %WIKITOOLNAME% account. +> * Go to the [[TWikiRegistration]] page to create your TWiki account. Fill in a couple of lines and you're set! > -> ### <a name="4_Check_out_WIKITOOLNAME_Users_o"> 4. Check out %WIKITOOLNAME% Users, offices and groups: </a> +> ## <a name="4_Check_out_TWiki_users_groups_o"> 4. Check out TWiki users, groups, offices... </a> > -> * 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%. +> * 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. > -> ### <a name="5_Test_the_page_controls_"> 5. Test the page controls: </a> +> ## <a name="5_Test_the_page_controls_"> 5. Test the page controls... </a> > -> Go to the %HOMETOPIC% page to find out what you can do. The bottom of the page has action links: +> 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) -> * **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. +> * <code>**\[[Edit]**</code> - add to or edit the topic (discussed later) +> * <code>**[Attach]**</code> - attach files to a topic (discussed later) +> * <code>**[Ref-By]**</code> - find out what other topics link to this topic (reverse link) +> * <code>**[Printable]**</code> - goes to a stripped down version of the page, good for printing +> * <code>**[Diffs]**</code> - topics are under revision control - `[Diffs]` shows you the complete change history of the topic, ex: who changed what and when. +> * <code>**[r1.3 | > | r1.2 | > | r1.1]**</code> - view a previous version of the topic or the difference between two versions. +> * <code>**[More]**</code> - additional controls, like <code>**[Rename/move]**</code>, version control and setting the topic's parent. > -> ### <a name="6_Change_a_page_and_create_a_new"> 6. Change a page and create a new one: </a> +> ## <a name="6_Change_a_page_and_create_a_new"> 6. Change a page, and create a new one... </a> > -> Go to the Test.%HOMETOPIC% topic of the %WIKITOOLNAME%.Test web. This web is the sandbox where you can make changes at will. +> Go to the [[Test/HOMETOPIC]]. This is the sandbox web, where you can make changes and try it all out 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.) +> * Click the <code>**[Edit]**</code> 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, create a new topic, your own test page: -> 1. In edit mode, enter a new text with a [[WikiWord]], i.e. <br /><code>This is PaulsSandBox topic.</code> -> 2. 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. -> 3. Click on the question mark. Now you are in edit mode of the new topic. +> * Now, create a new topic - your own test page: +> 1. In edit mode, enter a new text with a [[WikiWord]], ex: <br /><code>This is YourOwnSandBox topic.</code> +> 2. 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. +> 3. Click on the question mark. Now you're in edit mode of the new topic. > 4. Type some text, basically, like you write an email. > 5. 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. -> 6. 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: +> 6. 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 [[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. +> 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. > -> ### <a name="7_Upload_files_as_page_Attachmen"> 7. Upload files as page Attachments: </a> +> ## <a name="7_Use_your_browser_to_upload_fil"> 7. Use your browser to upload files as page attachments... </a> > -> You can attach any file to a topic, not unlike attachments to an email. +> You can attach _any_ type of file to a topic - documents, images, programs, whatever - where they can be opened, viewed, or downloaded. > -> * 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 <code>%ATTACHURL%</code>) to anywhere you like. -> * If you have a GIF or JPG image of yourself, why not upload it now to your personal topic? +> * Attaching files is just like including a file with an email. +> 1. Go back to your sandbox topic and click on the <code>**[Attach]**</code> link at the bottom. +> 2. Click <code>**[Browse]**</code> to find a file on your PC that you'd like to attach; enter an optional comment; leave everything else unchecked. +> 3. Click <code>**[Upload file]**</code>, 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 <code>**[Link:]**</code> 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 <code>%ATTACHURL%</code>) 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%? > -> ### <a name="8_Get_email_alerts_when_topics_c"> 8. Get email alerts when topics change: </a> +> ## <a name="8_Get_email_alerts_whenever_page"> 8. Get email alerts whenever pages are changed... </a> > -> It is very important that team members are kept in sync of changes. +> %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. > -> * %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. +> * 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%. 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 <br /> -- [[MikeMannix]] - 14 Sep 2001 <br /> +-- [[Main/MikeMannix]] - 01 Dec 2001 |