summaryrefslogtreecommitdiff
path: root/TWiki
diff options
context:
space:
mode:
authorPeter Thoeny <web-hurd@gnu.org>2000-08-18 06:50:00 +0000
committerPeter Thoeny <web-hurd@gnu.org>2000-08-18 06:50:00 +0000
commit0f0ad9998390346a9d94192652d91952467d0002 (patch)
tree61f9309720390b277a39e3127e69db0e322d420f /TWiki
parente6edb323a533e9c01eae8572766e5e717f75a3b7 (diff)
none
Diffstat (limited to 'TWiki')
-rw-r--r--TWiki/TextFormattingRules.mdwn27
1 files changed, 14 insertions, 13 deletions
diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn
index afe56cff..19bc7013 100644
--- 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,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.
* <code>%WEB%</code> : The current web, is **%WEB%** .
* <code>%TOPIC%</code> : The current topic name, is **%TOPIC%** .
* <code>%ATTACHURL%</code> : 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.
-* <code>%INCLUDE\{"file.ext"\}%</code> : Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code>**%INCLUDE\{"Know/TopicName.txt"\}%**</code>
+* <code>%INCLUDE\{"SomeTopic"\}%</code> : 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]].