From 54fad55fb3f13bf34f4713edf80e4a0b22a75632 Mon Sep 17 00:00:00 2001 From: MikeMannix Date: Thu, 6 Sep 2001 07:49:13 +0000 Subject: none --- TWiki/TextFormattingRules.mdwn | 338 +++++++++++++++++++++-------------------- 1 file changed, 172 insertions(+), 166 deletions(-) (limited to 'TWiki/TextFormattingRules.mdwn') diff --git a/TWiki/TextFormattingRules.mdwn b/TWiki/TextFormattingRules.mdwn index 906d5e4a..bc65758a 100644 --- a/TWiki/TextFormattingRules.mdwn +++ b/TWiki/TextFormattingRules.mdwn @@ -2,82 +2,85 @@ ## Editing - +
- - - - - - -
Formatting Command:Example: You write:You get:
Paragraphs:
Blank lines will create new paragraphs. 
+
+ + + + + + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + - - - - - + + + + - - - - - + + + + - - - - - + + + + - - - - - + + + + - + + +
Formatting Command:Example: You write:You get:
Paragraphs:
Blank lines will create new paragraphs. 
 1st paragraph
 
 2nd paragraph
1st paragraph

2nd paragraph

-
Headings:
At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWiki Variables?. 
+
1st paragraph

2nd paragraph

+
Headings:
At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWiki Variables?. 
 ---++ Sushi
 
 ---+++ Maguro
-

Sushi

-

-

-

Maguro

-
Bold Text:
Words get bold by enclosing them in * asterisks. 
+
+

Sushi

+

+

+

Maguro

+
Bold Text:
Words get bold by enclosing them in * asterisks. 
 *Bold*
Bold
Italic Text:
Words get italic by enclosing them in _ underscores. 
+
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. 
+
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. 
+
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. 
+
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. 
+
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 <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself. 
+
This works, _this not _
Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself. 
 <verbatim>
 class CatAnimal {
   void purr() {
@@ -86,81 +89,81 @@ class CatAnimal {
 }
 </verbatim>
 
+          
 class CatAnimal {
   void purr() {
     <code here>
   }
 }
Separator:
At least three dashes at the beginning of a line. 
+
Separator:
At least three dashes at the beginning of a line. 
 -------
-
-
List Item:
Three spaces and an asterisk. 
+
+
+
List Item:
Three spaces and an asterisk. 
    * bullet item
-
    -
  • bullet item
    • -
-
Nested List Item:
Six, nine, ... spaces and an asterisk. 
+
+
    +
  • bullet item
    • +
+
Nested List Item:
Six, nine, ... spaces and an asterisk. 
       * nested stuff
-
    -
  • -
      -
    • nested stuff
      • -
    -
    • -
-
Ordered List:
Three spaces and a number. 
+
+
    +
  • +
      +
    • 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, a space, 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   non-breaking-space entity. 
+
+
    +
  1. Sushi
    2. +
  2. Dim Sum
    3. +
+
Definition List:
Three spaces, the term, a colon, a space, 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   non-breaking-space entity. 
    Sushi: Japan
    Dim Sum: S.F.
-
-
Sushi
-
Japan
-
Dim Sum
-
S.F.
-
-
Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: |   spaced   | cells are rendered center aligned.
Note: |     spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character.
- 
+
+
+
Sushi
+
Japan
+
Dim Sum
+
S.F.
+
+
Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: |   spaced   | cells are rendered center aligned.
Note: |     spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character.
+ 
 | *L* | *C* | *R* |
 | A2 |  2  |  2 |
 | A3 |  3  |  3 |
@@ -169,83 +172,86 @@ class CatAnimal {
   | next \
   | next |
- - - - - - - - - - + - - - - - - - - - - - - -
LCR
A2 2 2 + + + + + + + + + + + + + + + + + + + + + + + + +
LCR
A2 2 2
A3 3 3
multi span
A4 next next
+
A3 3 3
multi span
A4 next next
-
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. 
+
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 and use anchors. 
+
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 and use anchors. 
 [[wiki syntax]]
 
 [[%MAINWEB%.TWiki users]]
wiki syntax?

%MAINWEB%.TWiki users?

-
Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (i.e. Wiki Syntax?) and external link references (i.e. http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]]. 
+
wiki syntax?

%MAINWEB%.TWiki users?

+
Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (i.e. Wiki Syntax?) and external link references (i.e. http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]]. 
 [[WikiSyntax][syntax]]
 
 [[http://gnu.org][GNU]]
syntax?

GNU

-
Anchors:
You can define a link reference inside a %WIKITOOLNAME% topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a Wiki Word?. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic. 
+
syntax?

GNU

+
Anchors:
You can define a link reference inside a %WIKITOOLNAME% topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a Wiki Word?. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic. 
 [[WebHome#NotThere]]
 
 [[#MyAnchor][Jump]]
 
 #MyAnchor To here
Web Home#Not There?

Jump

-

To here

-
Prevent a Link:
Prevent a Wiki Word? from being linked by prepending it with the <nop> tag. 
+
Web Home#Not There?

Jump

+

To here

+
Prevent a Link:
Prevent a Wiki Word? from being linked by prepending it with the <nop> tag. 
 <nop>SunOS
SunOS SunOS
+
-- cgit v1.2.3