TWiki home TWiki > TWiki > TextFormattingRules (r1.35 vs. r1.36) TWiki webs:
Main | TWiki | Know | Sandbox
TWiki . { Welcome | Register | Changes | Topics | Index | Search | Go }
 <<O>>  Difference Topic TextFormattingRules (r1.36 - 01 Feb 2003 - PeterThoeny)
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.

Changed:
<
<

>
>

Changed:
<
<

Paragraphs:

>
>

Paragraphs:

Changed:
<
<

Headings:

>
>

Headings:

Changed:
<
<

Bold Text:

>
>

Bold Text:

Changed:
<
<

Italic Text:

>
>

Italic Text:

Changed:
<
<

Bold Italic:

>
>

Bold Italic:

Changed:
<
<

Fixed Font:

>
>

Fixed Font:

Changed:
<
<

Bold Fixed Font:

>
>

Bold Fixed Font:

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.

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.

Changed:
<
<

Separator:

>
>

Separator:

Changed:
<
<

List Item:

>
>

List Item:

Changed:
<
<

Nested List Item:

>
>

Nested List Item:

Changed:
<
<

Ordered List:

>
>

Ordered List:

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.

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.

Changed:
<
<

| A4 \ | next \

next
>
>

A4 next next
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.

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.

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]].

Added:
>
>

XML

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:

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).

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

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.
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.
>
>

Changed:
<
<

-- PeterThoeny - 02 May 2002

>
>

-- PeterThoeny - 01 Feb 2003


Topic TextFormattingRules . { View | Diffs | r1.37 | > | r1.36 | > | r1.35 | More }
Revision r1.35 - 03 Oct 2002 - 01:40 GMT - PeterThoeny
Revision r1.36 - 01 Feb 2003 - 11:12 GMT - PeterThoeny
Copyright © 1999-2004 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback.