none

[openafs-wiki.git] / TWiki / TextFormattingRules.mdwn

diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn
index 1ce9790..f276c72 100644 (file)
--- a/TWiki/TextFormattingRules.mdwn
+++ b/TWiki/TextFormattingRules.mdwn
@@ -4,20 +4,20 @@ It is easy to collaborate, just type your text. You don't need to know HTML at a
 
 The Collaborative Work Area is a bunch of related links that are editable through your web browser.
 
-The TWiki web has the following types of internal links:
+The TWiki web has the following types of **_internal links:_**
 
-- [[GoodStyle]] is a topic that is part of the current TWiki web.
+- [[GoodStyle]] is a [[WikiWord]] that links to the GoodStyle topic located in the current %WIKITOOLNAME% web.
 - [[NotExistingYet]] is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic, you would wreck this example!)
-- [[ReadmeFirst]] is a topic in a different TWiki web. (You write it as _Web.TopicName_ , but it will show up as _TopicName_ )
 
-External links:
+**_External links:_**
 
 - `http://...`, `https://...`, `ftp://...` and `mailto:...@...` are linked automatically.
 - Email addresses like <code> <name@domain.com> </code> are linked automatically.
 
 **EDITING**
 
-- [[CapitalizedWordsStickedTogether]] will produce a link automatically.
+- CapitalizedWordsStuckTogether (or [[WikiWords]]) will produce a link automatically. In case you want to link to a topic in a different %WIKITOOLNAME% web write `Web.TopicName`, i.e. write `Know.ReadmeFirst` to link to [[ReadmeFirst]] located in the Know web.
+- You can create a forced internal link by enclosing words in double square brackets, i.e. write `[[text formatting FAQ]]` to get [[text formatting FAQ|Main/TextFormattingFAQ]] that links to topic [[TextFormattingFAQ]]. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. `[[Main.TWiki users]]` points to [[TWikiUsers]] in the Main web.
 - Blank lines will create new paragraphs.
 - Words get **bold** by enclosing them in **\*** asterisks
 - Words get _italic_ by enclosing them in **\_** underscores
@@ -31,25 +31,26 @@ External links:
     - Writing \*bold text\* , \_italic text\_ and =fixed== monospaced text
   - Example text gets rendered as:
     - Writing **bold text** , _italic text_ and `fixed=` monospaced text
-- Separator: -------- (at the beginning of a line)
-- List Item: &lt;3spaces&gt;\*
-- Nested Item: &lt;6spaces&gt;\*
-- Ordered List: &lt;3spaces&gt;&lt;number&gt;.
-- Definition: &lt;3spaces&gt;&lt;term&gt;:&lt;definition&gt;.
-- Table: &lt;optional spaces&gt;| cell 1 | cell 2 | cell 3 | ... |
+- Separator: at least four dashes at the beginning of a line: &lt;--------&gt;
+- List Item: 3 spaces and an asterisk: &lt;   \*&gt;
+- Nested Item: 6 spaces and an asterisk: &lt;      \*&gt;
+- Ordered List: 3 spaces and a number: &lt;   1&gt;
+- Definition: 3 spaces, the term, a colon, followed by the definition.
+- Table: Optional spaces followed by the cells enclosed in vertical bars: &lt;   | cell 1 | cell 2 | cell 3 | ... |&gt;
 
-**EXTRAS**
+**HTML**
 
-- Most HTML tags will work.
-  - Overview of all HTML elements at <http://www.htmlhelp.com/reference/wilbur/overview.html>
-  - HTML 3.2 Reference Specification at <http://www.w3.org/TR/REC-html32.html>
+Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit.
+
+- Overview of all HTML elements at <http://www.htmlhelp.com/reference/wilbur/overview.html>
+- HTML 3.2 Reference Specification at <http://www.w3.org/TR/REC-html32.html>
 
 **WIKI VARIABLES**
 
-Variables are names enclosed in percent signs that gets expanded on the fly.
+Variables are names that are enclosed in percent signs; they get expanded on the fly.
 
 - `%WEB%` : The current web, is **%WEB%** .
 - `%TOPIC%` : The current topic name, is **%TOPIC%** .
 - `%ATTACHURL%` : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as <code>**%ATTACHURL%/image.gif**</code> to show the URL of the file or the image in your text.
-- `%INCLUDE{"file.ext"}%` : Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code>**%INCLUDE\{"Know/TopicName.txt"\}%**</code>
+- `%INCLUDE{"SomeTopic"}%` : Server side include, includes another topic. The current %WIKITOOLNAME% web is the default web. Example: <code>**%INCLUDE\{"TWiki.TWikiWebsTable"\}%**</code>
 - There are many more variables, see [[TWikiVariables]].