none
authorPeterThoeny <PeterThoeny>
Sat, 1 Jul 2000 05:12:17 +0000 (05:12 +0000)
committerPeterThoeny <PeterThoeny>
Sat, 1 Jul 2000 05:12:17 +0000 (05:12 +0000)
TWiki/WelcomeGuest.mdwn
TWiki/WikiNotation.mdwn
TWiki/WikiSyntax.mdwn [new file with mode: 0644]
TWiki/WikiWord.mdwn [new file with mode: 0644]

index 05b2560..d5ffc77 100644 (file)
@@ -2,22 +2,43 @@ Welcome,
 
 you have reached the TWiki web (pronounced twee-kee web). TWiki is a meeting place to collaborate on common interests. Everybody can contribute by just using a web browser. It looks like a normal web site, but then... everybody can edit web pages.
 
-TWiki is divided up into **webs** , each one represents one area of collaboration. This Twiki installation has two TWiki webs:
+**Main Features of TWiki**
 
-- [TWiki.Main](http://www.dementia.org/twiki//view/Main): Entry point, has the list of TWiki guests, also used for explanations and testing.
+- Edit existing pages or create new pages by using any web browser.
+- Web pages are automatically linked. You do not need to learn HTML commands to link pages.
+- Very simple text formatting. Basically you write a web page like you would write an email.
+- Full text search with/without regular expressions.
+- All changes to pages are under revision control. Find out who changed what and when.
+- Automatic email notification when web pages change.
+- File attachments: Upload and download any file as an attachment to a page by using your browser. This is similar to email file attachments, but it happens on web pages.
+- Topic locking: Users are warned if a page is being edited by an other person. This is to prevent contention, e.g. simultaneous page editing.
+
+**How TWiki Works**
+
+TWiki is divided up into **webs** , each one represents one area of collaboration. Currently we have three TWiki webs:
+
+- [TWiki.Main](http://www.dementia.org/twiki//view/Main): The web you are currently in. It is the entry point, has a list of all [[TWikiUsers]] and offices.
 - [TWiki.Know](http://www.dementia.org/twiki//view/Know): Knowledge Base area. This is to demonstrate how to use TWiki as a knowledge base for support.
+- [TWiki.Test](http://www.dementia.org/twiki//view/Test): Just for testing.
+
+Each web has hyper-linked topics. A **topic** is one web page in your browser.
 
-Each web has topics. A **topic** is one web page in your browser. You can edit a topic by clicking on the **Edit** link at the bottom of each page.
+To browse this Wiki site, just click on any highlighted link. These links are called [[WikiWords]], and comprise two or more words with initial capitals, run together.
 
-Good starting points in the TWiki.Main web are:
+To edit any page, click on "Edit" at the bottom of the page. You can edit the page from within your browser, using [[WikiSyntax]], a very simple markup language. You could also use HTML if you wish, but his is optional. (Before you can edit pages you need to register in [[TWikiRegistration]].)
 
+A highlighted "?" following a [[WikiTopic]] means that no content has yet been entered for that topic. You are invited to add some content by clicking on the "?". You are encouraged to include [[WikiWords]] in your content, for others to fill out later.
+
+Please follow the [[TWikiTutorial]] to get you up to speed on TWiki.
+
+**Starting points in the TWiki.Main web**
+
+- ** [[TWikiTutorial]] **: Familiarize yourself with TWiki before you start editing content.
 - [[WebHome]]: Entry point of this TWiki web.
 - [[TWikiWeb]]: Explains what a TWiki web is.
 - [[GoodStyle]]: Things to consider when changing text.
-- [[TextFormattingRules]]: Easy to learn rules when editing text.
+- [[WikiSyntax]]: Easy to learn rules when editing text.
 - [Changes](http://www.dementia.org/twiki//changes/Main): Recent changes to the TWiki.Main web.
-- [[TestArea]]: The place where you can get your virtual hands dirty.
-- [[TWikiUsers]]: List of users.
+- [[OfficeLocations]]: Wind River Offices.
+- [[TWikiUsers]]: List of TWiki users.
 - [[TWikiRegistration]]: **Before you leave** add your name here.
-
--- [[PeterThoeny]] - 13 Jun 1999 <br />
index c354544..399b5a6 100644 (file)
@@ -1,21 +1 @@
-TWiki links topics automatically, provided you give a [[WikiTopic]] a name that follows the [[WikiNotation]]. It is a sequence of:
-
-- Uppercase letter(s)
-- Lowercase letter(s)
-- Uppercase letter(s)
-- Optional lowercase or uppercase letter(s) or number(s)
-
-Good examples for topic names:
-
-- [[TWikiWeb]]
-- [[GoodStyle]]
-- [[AVeryLongTWikiTopicNameIsAlsoPossible]]
-- [[ProblemY2K]]
-
-Bad examples for topic names:
-
-- Web: Name with no uppercase letter in between
-- [[T5Wiki]]: Name with number before the first lowercase letter
-- Know-How: Name with dashes in between
-
-Sometimes you have to be creative to find a good name for a [[WikiTopic]]. For example, if you want to create a topic about the year 2000 problem, you could go for [[FixY2K]] or [[YearTwoK]] or [[YearTwoThousand]], but not [[Year2K]] or [[Y2K]] or Y2000 as a topic name.
+Wiki links topics automatically when you use the [[WikiWord]] notation.
diff --git a/TWiki/WikiSyntax.mdwn b/TWiki/WikiSyntax.mdwn
new file mode 100644 (file)
index 0000000..79adbd2
--- /dev/null
@@ -0,0 +1,31 @@
+Separate each paragraph with a blank line.
+
+To display a word or phrase in **bold type** , surround it by asterisks.
+
+To display a word or phrase in _italic_ , surround it by underscores.
+
+To display a word or phrase in **_bold italic_** , surround it by double underscores.
+
+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, a dot and the WikiWord for that topic, i.e. `Test.WebHome` )
+
+If you add a [[WikiWord]] for a topic that does not yet exist, you'll see a question mark after it, prompting you (or someone else) to edit the new topic. After that has been done, the WikiWord will be automatically recognized as a link to the new Wiki page.
+
+For an external hyperlink, just type the URL ( starting with `http://` ).
+
+- Start a bullet point with space-space-space-asterisk-space.
+  - Use a multiple of 3 spaces to start nested bullets.
+
+1. Start items in a numbered list with space-space-space-1-space.
+2. (The "1" will be replaced by the correct number).
+
+To include an image inline, just type its URL. You also can attach an image to the page and display it with text `%ATTACHURL%/imagefile.jpg` .
+
+To display a word or phrase in `MONOSPACED TYPE` , surround it by '=' characters.
+
+<pre>  Surround code excerpts and other<br />  formatted text with<br />       &lt;pre&gt; and &lt;/pre&gt; tags.</pre>
+
+Use five consecutive hyphens for a horizontal rule.
+
+To see the markup for any page, click on "Edit" at the bottom of the page.
+
+See [[TextFormattingRules]] for more detail.
diff --git a/TWiki/WikiWord.mdwn b/TWiki/WikiWord.mdwn
new file mode 100644 (file)
index 0000000..02c0598
--- /dev/null
@@ -0,0 +1,38 @@
+A WikiWord consists of two or more words with initial capitals, run together.
+
+When you type a WikiWord, you establish a hyperlink. It's as easy as that.
+
+WikiWords are styled like this because:
+
+- It makes Wiki hyperlinks instantly recognizable
+- It leads to interesting Wiki topics
+- It avoids the need to fiddle with HTML tags
+- It avoids over-general topics, because at least two words are required
+
+**Syntax of a WikiWord**
+
+- Uppercase letter(s)
+- Lowercase letter(s)
+- Uppercase letter(s)
+- Optional lowercase or uppercase letter(s) or number(s)
+
+**Good examples for WikiWords:**
+
+- [[WikiWord]]
+- [[GoodStyle]]
+- [[AVeryLongWikiTopicNameIsAlsoPossible]]
+- [[ProblemY2K]]
+
+**Bad examples for WikiWords:**
+
+- Web: Name with no uppercase letter in between
+- [[T5Wiki]]: Name with number before the first lowercase letter
+- Know-How: Name with dashes in between
+
+**Hints**
+
+- Insert WikiWords wherever you can. Rich linking helps to make a Wiki successful.
+- To stop a WikiWord from being turned into a hyperlink, insert the text `<nop>` immediately before the WikiWord.
+- A topic is usually presented in the singular. Plural WikiWords are automatically linked to the singular topic, i.e. the link [[WikiWords]] links to the topic [[WikiWord]].
+- Sometimes you have to be creative to find a good WikiName. For example, if you want to create a topic about the year 2000 problem, you could go for [[FixY2K]] or [[YearTwoK]] or [[YearTwoThousand]], but not [[Year2K]] or [[Y2K]] or Y2000.
+- Turn acronyms into WikiWords, i.e. take [[FaqIndex]] for a "FAQ index" topic.