TWiki Home TWiki . TWiki . TextFormattingRules (r1.28 vs. r1.29) TWiki webs:
BG| DE | ES | FI | FR | Glossary | HU | IT | JA | Know | Main | NL | PT | Pub | RU | SL | TWiki | Test | ZH-CN? | ZH-TW? |
TWiki . { Home | Welcome | Register | Changes | Index | Search | Go }
 <<O>>  Difference Topic TextFormattingRules (r1.29 - 02 Dec 2001 - MikeMannix?)
Changed:
<
<

Appendix C: Text Formatting Rules

>
>

TWiki Text Formatting

Changed:
<
<

>
>

#SquareBrackets
Changed:
<
<

TWiki Variables

Variables are names that are enclosed in percent signs % that are expanded on the fly.

  • %TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.

  • %WEB% : The current web, is TWiki.

  • %TOPIC% : The current topic name, is TextFormattingRules.

  • %ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%

Common Editing Errors

TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ:

  • Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?
    • A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '&lt;' instead of '<', and '&gt;' instead of '>'.
      Example: Type 'prog &lt;filename&gt;' to get 'prog <filename>'.

  • Q: Why is the '&' character sometimes not displayed?
    • A: The '&' character has a special meaning in HTML, it starts a so called character entity, ex: '&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'.
>
>

TWikiPlugin Formatting Extensions

Changed:
<
<

TWiki Plugins

>
>

Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Changed:
<
<

Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on here:

>
>

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

Changed:
<
<

-- MikeMannix - 02 Oct 2001

>
>

-- MikeMannix? - 02 Dec 2001


Topic TextFormattingRules . { View | Diffs | r1.30 | > | r1.29 | > | r1.28 | More }
Revision r1.28 - 02 Oct 2001 - 07:29 GMT - MikeMannix?
Revision r1.29 - 02 Dec 2001 - 08:07 GMT - MikeMannix?
This website is distributed under the GNU Documentation License