none
authorMikeMannix <MikeMannix>
Sun, 2 Dec 2001 06:55:52 +0000 (06:55 +0000)
committerMikeMannix <MikeMannix>
Sun, 2 Dec 2001 06:55:52 +0000 (06:55 +0000)
TWiki/TWikiTutorial.mdwn
TWiki/WebHome.mdwn
TWiki/WikiSyntax.mdwn

index b93cdfb..066bc6f 100644 (file)
 <div>
   <ul>
     <li><a href="#20-Minute TWiki"> 20-Minute TWiki</a><ul>
-        <li><a href="#1. Get set:"> 1. Get set:</a></li>
-        <li><a href="#2. Take a whirlwind tour:"> 2. Take a whirlwind tour:</a></li>
-        <li><a href="#3. Open a private account page:"> 3. Open a private account page:</a></li>
-        <li><a href="#4. Check out %WIKITOOLNAME% User"> 4. Check out %WIKITOOLNAME% Users, offices and groups:</a></li>
-        <li><a href="#5. Test the page controls:"> 5. Test the page controls:</a></li>
-        <li><a href="#6. Change a page and create a ne"> 6. Change a page and create a new one:</a></li>
-        <li><a href="#7. Upload files as page Attachme"> 7. Upload files as page Attachments:</a></li>
-        <li><a href="#8. Get email alerts when topics"> 8. Get email alerts when topics change:</a></li>
+        <li><a href="#1. Get set..."> 1. Get set...</a></li>
+        <li><a href="#2. Take a quick tour..."> 2. Take a quick tour...</a></li>
+        <li><a href="#3. Open a private account..."> 3. Open a private account...</a></li>
+        <li><a href="#4. Check out TWiki users, groups"> 4. Check out TWiki users, groups, offices...</a></li>
+        <li><a href="#5. Test the page controls..."> 5. Test the page controls...</a></li>
+        <li><a href="#6. Change a page, and create a n"> 6. Change a page, and create a new one...</a></li>
+        <li><a href="#7. Use your browser to upload fi"> 7. Use your browser to upload files as page attachments...</a></li>
+        <li><a href="#8. Get email alerts whenever pag"> 8. Get email alerts whenever pages are changed...</a></li>
       </ul>
     </li>
   </ul>
 </div>
 
-## <a name="20-Minute TWiki"></a> 20-Minute TWiki
+# <a name="20-Minute TWiki"></a> 20-Minute TWiki
 
-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:"></a> 1. Get set:
+> ## <a name="1. Get set..."></a> 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.
+> 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:"></a> 2. Take a whirlwind tour:
+> ## <a name="2. Take a quick tour..."></a> 2. Take a quick 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.
+> 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 %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 [[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]].
+> - 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]].
 >
-> ### <a name="3. Open a private account page:"></a> 3. Open a private account page:
+> ## <a name="3. Open a private account..."></a> 3. Open a private account...
 >
-> 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% User"></a> 4. Check out %WIKITOOLNAME% Users, offices and groups:
+> ## <a name="4. Check out TWiki users, groups"></a> 4. Check out TWiki users, groups, offices...
 >
-> - Go to the [[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 [[OfficeLocations]] topic in the %WIKITOOLNAME%.Main web; it has a list of corporate offices already entered into %WIKITOOLNAME%.
-> - Go to the [[TWikiGroups]] topic in the %WIKITOOLNAME%.Main web; it has a list of groups which can be used to define fine grained [[TWikiAccessControl]] in %WIKITOOLNAME%.
+> - 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.
 >
-> ### <a name="5. Test the page controls:"></a> 5. Test the page controls:
+> ## <a name="5. Test the page controls..."></a> 5. Test the page controls...
 >
 > Go to the
 >
-> [[WebHome]]
+> [[bottom of the page|Main/WebHome#PageBottom]]
 >
-> page to find out what you can do. The bottom of the page has action links:
+> 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 | &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.
+> - <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 | &gt; | r1.2 | &gt; | 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 ne"></a> 6. Change a page and create a new one:
+> ## <a name="6. Change a page, and create a n"></a> 6. Change a page, and create a new one...
 >
 > Go to the
 >
 > [[Test|Test/WebHome]]
 >
-> topic of the %WIKITOOLNAME%.Test web. This web is the sandbox where you can make changes at will.
+> . 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 [[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 [[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 />`This is PaulsSandBox topic.`
->   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 />`This is YourOwnSandBox topic.`
+>   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 `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.
->   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 Attachme"></a> 7. Upload files as page Attachments:
+> ## <a name="7. Use your browser to upload fi"></a> 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.
 >
-> You can attach any file to a topic, not unlike attachments to an email.
+> - 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 `%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.admin?
 >
-> - 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?
+> ## <a name="8. Get email alerts whenever pag"></a> 8. Get email alerts whenever pages are changed...
 >
-> ### <a name="8. Get email alerts when topics"></a><a name="8. Get email alerts when topics "></a> 8. Get email alerts when topics change:
+> [[WebNotify]]
 >
-> It is very important that team members are kept in sync of changes.
+> 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.
 >
-> - [[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.
-> - 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 [[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 <br /> -- [[MikeMannix]] - 14 Sep 2001 <br />
+-- [[MikeMannix]] - 01 Dec 2001
index 27634a6..5e5af84 100644 (file)
   - [[TWikiRegistration]]: Sign up so you can edit pages and select options
 
 - **One-Page Primers** cover TWiki basics
-  - [[TWikiSite]]: Instant overview - first, there was Wiki...
+  - [[TWikiTutorial]]: A compact, 20-minute TWiki primer
+  - [[TWikiPages]]: Customize, rename, move, or delete TWiki topics
+  - [[TWikiShorthand]]: The complete TWiki text formatting syntax on one page
   - [[WikiSyntax]]: TWiki shorthand basics
-  - [[TWikiTutorial]]: A compact %WIKITOOLNAME% primer
   - [[GoodStyle]]: Working tips for an open collaboration environment
-  - [[TWikiShorthand]]: The complete TWiki text formatting syntax on one page
   - [[TWikiVariables]]: How to easily embed text, graphics, dynamic content
   - [[FileAttachments]]: Use your browser to upload files for distribution or display
   - [[WebChangesAlert]]: Subscribe to email alerts linking to the latest page changes
-  - [[TWikiPages]]: Customize, rename, move, or delete TWiki topics
 
 - **TWiki Help FAQs**
-  - [[TWikiFAQ]]: The first things people ask about %WIKITOOLNAME%
-  - [[TextFormattingFAQ]]: Most-requested facts about posting in TWiki
+  - [[TWikiSite]]: Instant overview - first, there was Wiki...
+  - [[TWikiFAQ]]: The first things people ask about TWiki
+  - [[TextFormattingFAQ]]: Common how-to questions about posting in TWiki
 
 - Frequent users should also browse the [[TWiki Reference Manual|Main/WebHome#ReferenceManual]]!
 - It's easy to customize the User's Guide to reflect the features and settings enabled on your own TWiki site.
@@ -69,7 +69,7 @@ Documentation for webmasters, system administrators, project managers, team lead
 </form>
 
 - [[WebPreferences]]: Preference settings for the this web
-- [[TWikiPreferences]]: %WIKITOOLNAME% site-wide preferences
+- [[TWikiPreferences]]: TWiki site-wide preferences
 - The [[TWikiWebsTable]] _(below)_ is a color-coded directory of available webs that can be easily included on any page.
   - The [[%WEB%|TWiki/WebHome]] web is coded light orange for quick identification.
 
index b6e6b67..40b6e37 100644 (file)
@@ -1,6 +1,6 @@
-# <a name="Instant TWiki Shorthand"></a> Instant TWiki Shorthand
+# <a name="TWikiShorthand Basics"></a><a name="_TWikiShorthand Basics"></a> TWikiShorthand Basics
 
-If you can enter text, write an email, you're ready for TWiki. Use simple, intuitive TWiki shorthand to get even more control - instantly!
+If you can enter text, you're ready for TWiki. With a few simple, intuitive [[TWikiShorthand]] rules, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics...
 
 - Separate each **paragraph** with a blank line.
 
@@ -12,25 +12,26 @@ If you can enter text, write an email, you're ready for TWiki. Use simple, intui
 
 - To link to another Wiki topic, type the [[WikiWord]] for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first: `Test.WebHome`.
 
-- - When entering [[WikiName]] signatures - like, admin - include the Main as a prefix, since all TWiki member pages are in the Main web: `Main.YourName`.
+- If you enter a [[WikiWord]] for a topic that doesn't exist, it'll appear highlighted, with question mark at the end, prompting you (or someone else) to start off the new topic by clicking the **?** - [[NewTopic]] (click the **?**, but don't save, to preserve the example!).
 
-- If you enter a [[WikiWord]] for a topic that doesn't exist, it appears highlighted, with a question mark link at the end, prompting you (or someone else) to start off the new topic by clicking the **?** - [[FreshTopic]] (try clicking the **?**, but don't save, or you'll create a <code>**FreshTopic**</code> page and ruin this example).
+- When entering WikiName signatures - like, admin - include the Main as a prefix, since all TWiki member pages are in the Main web: `Main.YourName`.
 
-- For an external link, type the full URL: `http://twiki.org` = <http://twiki.org>
+- For an external link, type the full URL: `http://twiki.org`.
 
-- To prevent a [[WikiWord]] from becoming a link, type `<nop>` first, <code>**&lt;nop&gt;WikiWord**</code> = WikiWord
+- To prevent a WikiWord from becoming a link, type `<nop>` first, <code>**&lt;nop&gt;NoLinkPlease**</code>.
 
 - To indent with a bullet, enter `[space][space][space][asterisk][space]`.
   - Use multiples of 3 spaces to start **nested bullets**.
     - That's 3-6-9-...
-  1. Start items in a **numbered list** with `[space][space][space][1][space]`.
-  2. The "1" (or **any number**) will be replaced by the correct number, in order.
 
-- Always start **counting spaces** for bullets and such from the beginning of a new line.
+1. Start items in a **numbered list** with `[space][space][space][1][space]`.
+2. The "1" (or **any number**) will be replaced by the correct number, in order.
+
+- Always start **counting** for bullets and such from the beginning of a new line.
 
 - To include an image, type its URL. You also can Attach an image to the page and display it with text <br />=%ATTACHURL%/yourimagefilename.jpg=.
 
-- To display a word or phrase in `MONOSPACED type`, put it in equal signs: `=like this=`. <br />Use `==two==` for bold: <code>**bold mono**</code>.
+- To display a word or phrase in `MONOSPACED TYPE`, put it in equal signs: `=like this=`. <br />Use `==two==` for bold: <code>**bold mono**</code>.
 
          Surround code excerpts, filenames, and other
          unformatted text with <pre> or </pre>
@@ -39,8 +40,6 @@ If you can enter text, write an email, you're ready for TWiki. Use simple, intui
 
 - Use three (or more) consecutive **hyphens** expands into a horizontal rule: `---`
 
-- See [[TWikiShorthand|Main/TextFormattingRules]] for more....
+- See [[TWikiShorthand]] for the complete set of formatting rules.
 
 ----
-
--- [[MikeMannix]] - 01 Oct 2001 <br />