none

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

diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn
index 2adbf16..6941040 100644 (file)
--- a/TWiki/TextFormattingRules.mdwn
+++ b/TWiki/TextFormattingRules.mdwn
@@ -17,7 +17,7 @@ External links:
 
 **EDITING**
 
-- [[CapitalizedWordsStickedTogether]] will produce a link automatically.
+- CapitalizedWordsStuckTogether will produce a link automatically.
 - Blank lines will create new paragraphs.
 - Words get **bold** by enclosing them in **\*** asterisks
 - Words get _italic_ by enclosing them in **\_** underscores
@@ -31,17 +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: <3spaces>\*
-- Nested Item: <6spaces>\*
-- Ordered List: <3spaces><number>.
-- Definition: <3spaces><term>:<definition>.
-- Table: <optional spaces>| cell 1 | cell 2 | cell 3 | ... |
+- Separator: at least four dashes at the beginning of a line: <-------->
+- List Item: 3 spaces and an asterisk: <   \*>
+- Nested Item: 6 spaces and an asterisk: <      \*>
+- Ordered List: 3 spaces and a number: <   1>
+- Definition: 3 spaces, the term, a colon, followed by the definition.
+- Table: Optional spaces followed by the cells enclosed in vertical bars: <   | cell 1 | cell 2 | cell 3 | ... |>
 
-**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 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{"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]].