Difference: TextFormattingRules (35 vs. 36)

Revision 362003-02-01 - PeterThoeny

Line: 1 to 1
 
Changed:
<
<

TWiki Text Formatting

Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the Edit screen.
>
>

TWiki Text Formatting

Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the Edit screen.

 

TWiki Editing Shorthand

Changed:
<
<
>
>
 
Formatting Command:
Line: 19 to 20
 
Changed:
<
<
Paragraphs:
>
>
Paragraphs:
  Blank lines will create new paragraphs.
Line: 37 to 38
 
Changed:
<
<
Headings:
>
>
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 TWikiVariables. Any heading text after !! is excluded from the TOC; for example, write ---+!! text if you do not want to list a header in the TOC.
Line: 55 to 56
 
Changed:
<
<
Bold Text:
>
>
Bold Text:
  Words get bold by enclosing them in * asterisks.
Line: 69 to 70
 
Changed:
<
<
Italic Text:
>
>
Italic Text:
  Words get italic by enclosing them in _ underscores.
Line: 83 to 84
 
Changed:
<
<
Bold Italic:
>
>
Bold Italic:
  Words get _bold italic by enclosing them in _ double-underscores.
Line: 97 to 98
 
Changed:
<
<
Fixed Font:
>
>
Fixed Font:
  Words get shown in fixed font by enclosing them in = equal signs.
Line: 111 to 112
 
Changed:
<
<
Bold Fixed Font:
>
>
Bold Fixed Font:
  Words get shown in bold fixed font by enclosing them in double equal signs.
Line: 125 to 126
 
Changed:
<
<
Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.
>
>
Note: Make sure to "stick" the * _ = == signs to the words, that is, take away spaces.
 

Line: 140 to 141
 
Changed:
<
<
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 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.
 

Line: 166 to 167
 
Changed:
<
<
Separator:
>
>
Separator:
  At least three dashes at the beginning of a line.
Line: 180 to 181
 
Changed:
<
<
List Item:
>
>
List Item:
  Three spaces and an asterisk.
Line: 194 to 195
 
Changed:
<
<
Nested List Item:
>
>
Nested List Item:
  Six, nine, ... spaces and an asterisk.
Line: 208 to 209
 
Changed:
<
<
Ordered List:
>
>
Ordered List:
  Three spaces and a number.
Line: 224 to 225
 
Changed:
<
<
Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
>
>
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 &nbsp; non-breaking-space entity.
Line: 241 to 242
 
Changed:
<
<
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.
>
>
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.
 

Line: 255 to 256
 
A2 2 2
A3 3 3
multi span
Changed:
<
<
| A4 \ | next \
next
>
>
A4 next next
 
Line: 265 to 264
 
A2 2 2
A3 3 3
multi span
Changed:
<
<
A4 next next
>
>
A4 next next
 
Changed:
<
<
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName.
>
>
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName.
 

Line: 291 to 288
 
Changed:
<
<
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 TextFormattingFAQ. You can also refer to a different web and use anchors.
>
>
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; for example, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
 

Line: 309 to 307
 
Changed:
<
<
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. WikiSyntax) 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!]].
>
>
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 (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].
 
[[WikiSyntax][syntax]]

[[http://gnu.org][GNU]]

Added:
>
>
XML
 
syntax

GNU

Added:
>
>
XML
 
Changed:
<
<
Easier External Links:
An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]]. This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]].
[[http://gnu.org GNU]]
GNU
Anchors:
>
>
Anchors:
  You can define a link reference inside a TWiki 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 WikiWord. 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.
Line: 378 to 369
 
Disable Links:
Changed:
<
<
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).
>
>
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).
 
Line: 395 to 388
 
Added:
>
>
Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].
[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]
Mail

Hi

 

Using HTML

Line: 429 to 442
 
  • Email addresses like name@domain.com are linked automatically.

Changed:
<
<
    • You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.
>
>
    • You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.
 

TWiki Variables

Line: 446 to 459
 
  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
Changed:
<
<
>
>
  • %SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.

  • TWikiPreferences defines site-wide variables. Among others:
    • Line break: Write %BR% to start a new line.
    • Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
    • Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: HELP Help, TIP Tip, ALERT! Alert. For more info see TWikiDocGraphics.
 
Changed:
<
<
  • TWikiPreferences defines site-wide variables like colors. For example, write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
>
>
 

TWikiPlugin Formatting Extensions

Line: 473 to 491
 
    • A: The '&' character has a special meaning in HTML, it starts a so called character entity, i.e. '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'.
      Example: Type 'This &amp; that' to get 'This & that'.

-- MikeMannix - 02 Dec 2001

Changed:
<
<
-- PeterThoeny - 02 May 2002
>
>
-- PeterThoeny - 01 Feb 2003
 
Copyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TextFormattingRules.