From b6ebbda1268d081e825a76d6fe97ace42596a381 Mon Sep 17 00:00:00 2001 From: Peter Thoeny Date: Thu, 1 Feb 2001 01:34:06 +0000 Subject: none --- TWiki/TextFormattingRules.mdwn | 218 ++++++++++++++++++++++++++++++++++++----- 1 file changed, 196 insertions(+), 22 deletions(-) (limited to 'TWiki') diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn index 76ee93e9..12c1667d 100644 --- a/TWiki/TextFormattingRules.mdwn +++ b/TWiki/TextFormattingRules.mdwn @@ -16,28 +16,202 @@ The %WIKITOOLNAME% web has the following types of **_internal links:_** **EDITING** -* 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 [[Know/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 [[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. [[%MAINWEB%.TWiki users]] points to %MAINWEB%.TWikiUsers in the %MAINWEB% web. -* Blank lines will create new paragraphs. -* Words get **bold** by enclosing them in **\*** asterisks -* Words get _italic_ by enclosing them in **\_** underscores -* Words get **_bold italic_** by enclosing them in **\_\_** double-underscores -* Words get shown in `fixed font` by enclosing them in **=** equal signs -* Words get shown in **bold fixed font** by enclosing them in **==** double equal signs -* Note for **bold** , _italic_ , **_bold italic_** and `fixed font` text: - * Make sure to "stick" the `* _ =` signs to the characters, e.g. - * _This works_ - * \_This does not get italic because there is a space between the last word and the underline character \_ - * Example text to enter: - * 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 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: <   term: definition>
Note that terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity, i.e. write `Character Set:` to get `Character Set:`. -* Table: Optional spaces followed by the cells enclosed in vertical bars: <   | cell 1 | cell 2 | cell 3 | ... |> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Formatting Command:Example: You write:You get:
Paragraphs:
Blank lines will create new paragraphs. 
+ 1st paragraph
+
+ 2nd paragraph
+
 1st paragraph

2nd paragraph

+
Bold Text:
Words get bold by enclosing them in * asterisks. 
+ *Bold*
+
Bold
Italic Text:
Words get italic by enclosing them in _ underscores. 
+ _Italic_
+
Italic
Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores. 
+ __Bold italic__
+
Bold italic
Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs. 
+ =Fixed font=
+
Fixed font
Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs. 
+ ==Bold fixed==
+
Bold fixed
Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces. 
+ _This works_,
+ _this not _
+
This works, _this not _
Verbatim Mode:
Surround code excerpts and other formatted text with &lt;verbatim&gt; and &lt;/verbatim&gt; tags.
Note: Use &lt;pre&gt; and &lt;/pre&gt; tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself. 
+&lt;verbatim&gt;
+class CatAnimal {
+  void purr() {
+    &lt;code here&gt;
+  }
+}
+&lt;/verbatim&gt;
+
+class CatAnimal {
+  void purr() {
+    &lt;code here&gt;
+  }
+}
+
Separator:
At least four dashes at the beginning of a line. 
+-------
+
 +
+
List Item:
Three spaces and an asterisk. 
+   * bullet item
+
 +
    +
  • bullet item
    • +
+
Nested List Item:
Six, nine, ... spaces and an asterisk. 
+      * nested stuff
+
 +
    +
  • +
      +
    • nested stuff
      • +
    +
    • +
+
Ordered List:
Three spaces and a number. 
+   1 Sushi
+   1 Dim Sum
+
 +
    +
  1. Sushi
    2. +
  2. Dim Sum
    3. +
+
Definition List:
Three spaces, the term, a colon, followed by the definition.
Note: Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the &amp;nbsp; non-breaking-space entity. 
+   Sushi: Japan
+   Dim&amp;nbsp;Sum: S.F.
+
 +
+
Sushi
+
Japan
+
Dim Sum
+
S.F.
+
+
Table:
Optional spaces followed by the cells enclosed in vertical bars. 
+| A1 | B1 | C1 |
+| A2 | B2 | C2 |
+
 + + + + + + + + + + + +
A1 B1 C1
A2 B2 C2
+
WikiWord Links:
CapitalizedWordsStuckTogether (or Wiki Words?) will produce a link automatically.
Note: In case you want to link to a topic in a different %WIKITOOLNAME% web write Webname.TopicName. 
+ WebNotify,
+ Know.ReadmeFirst
+
Web Notify?, Readme First?
Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic Text Formatting FAQ?. You can also refer to a different web. 
+ [[wiki syntax]],
+ [[%MAINWEB%.TWiki users]]
+
wiki syntax?, %MAINWEB%.TWiki users?
Prevent a Link:
Prevent a Wiki Word? from being linked by prepending it with the &lt;nop&gt; tag. 
+ &lt;nop&gt;SunOS
+
SunOS
Disable Links:
You can disable automatic linking of Wiki Words? by surround text with &lt;noautolink&gt; and &lt;/noautolink&gt; tags.
Note: Each tag must be on a line by itself. 
+ &lt;noautolink&gt;
+ RedHat &amp;
+ SuSE
+ &lt;/noautolink&gt;
+
 RedHat &amp; SuSE
**HTML** -- cgit v1.2.3