TWiki/TextFormattingRules.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#TWiki Text Formatting"> TWiki Text Formatting</a><ul>
   4         <li><a href="#TWiki Editing Shorthand"> TWiki Editing Shorthand</a></li>
   5         <li><a href="#Using HTML"> Using HTML</a><ul>
   6             <li><a href="#Script tags"> Script tags</a></li>
   7           </ul>
   8         </li>
   9         <li><a href="#Hyperlinks"> Hyperlinks</a><ul>
  10             <li><a href="#Internal Links"> Internal Links</a></li>
  11             <li><a href="#External Links"> External Links</a></li>
  12           </ul>
  13         </li>
  14         <li><a href="#TWiki Variables"> TWiki Variables</a></li>
  15         <li><a href="#TWikiPlugin Formatting Extension"> TWikiPlugin Formatting Extensions</a></li>
  16         <li><a href="#Common Editing Errors"> Common Editing Errors</a></li>
  17       </ul>
  18     </li>
  19   </ul>
  20 </div>
  21
  22 # <a name="TWiki Text Formatting"></a> TWiki Text Formatting
  23
  24 Working in TWiki is as easy as typing in text. 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 laid out below.
  25
  26 <a name="TWikiShorthand"></a>
  27
  28 ## <a name="TWiki Editing Shorthand"></a> TWiki Editing Shorthand
  29
  30 <table bgcolor="#ffffff" border="1" cellpadding="3">
  31   <tr bgcolor="#ffffff">
  32     <th width="50%"> Formatting Command: </th>
  33     <th width="25%"> You write: </th>
  34     <th width="25%"> You get: </th>
  35   </tr>
  36   <tr valign="top">
  37     <td><strong>Paragraphs:</strong> %BR% Blank lines will create new paragraphs. </td>
  38     <td><pre>
  39 1st paragraph
  40
  41 2nd paragraph
  42 </pre></td>
  43     <td> 1st paragraph <p> 2nd paragraph </p>
  44     </td>
  45   </tr>
  46   <tr valign="top">
  47     <td><strong>Headings:</strong> %BR% Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6. <p> You can create a table of contents with the [[Main/TWikiVariables#VarTOC]] variable. If you want to <strong>exclude</strong> a heading from the TOC, put <code>!!</code> after the <code>---+</code>. </p>
  48       <p> %X% Empty headings are allowed, but won't appear in the table of contents. </p>
  49     </td>
  50     <td><pre>
  51 ---++ Sushi
  52 ---+++ Maguro
  53 ---+++!! Not in TOC
  54 </pre></td>
  55     <td>
  56       <h2>Sushi</h2>
  57       <h3>Maguro</h3>
  58       <h3>Not in TOC</h3>
  59     </td>
  60   </tr>
  61   <tr valign="top">
  62     <td><strong>Bold Text:</strong> %BR% Words get shown in <strong>bold</strong> by enclosing them in <code>*</code> asterisks. </td>
  63     <td><pre>
  64 *Bold*
  65 </pre></td>
  66     <td><strong>Bold</strong></td>
  67   </tr>
  68   <tr valign="top">
  69     <td><strong>Italic Text:</strong> %BR% Words get shown in <em>italic</em> by enclosing them in <code>_</code> underscores. </td>
  70     <td><pre>
  71 _Italic_
  72 </pre></td>
  73     <td><em>Italic</em></td>
  74   </tr>
  75   <tr valign="top">
  76     <td><strong>Bold Italic:</strong> %BR% Words get shown in <strong><em>bold italic</em></strong> by enclosing them in <code>__</code> double-underscores. </td>
  77     <td><pre>
  78 __Bold italic__
  79 </pre></td>
  80     <td><strong><em>Bold italic</em></strong></td>
  81   </tr>
  82   <tr valign="top">
  83     <td><strong>Fixed Font:</strong> %BR% Words get shown in <code>fixed font</code> by enclosing them in <code>=</code> equal signs. </td>
  84     <td><pre>
  85 =Fixed font=
  86 </pre></td>
  87     <td><code>Fixed font</code><p>
  88       </p>
  89     </td>
  90   </tr>
  91   <tr valign="top">
  92     <td><strong>Bold Fixed Font:</strong> %BR% Words get shown in <code><b>bold fixed font</b></code> by enclosing them in <code><b></b></code> double equal signs. </td>
  93     <td><pre>
  94 ==Bold fixed==
  95 </pre></td>
  96     <td><code><b>Bold fixed</b></code></td>
  97   </tr>
  98   <tr valign="top">
  99     <td> %T% You can follow the closing bold, italic, or other (<code>* _ __ = ==</code>) indicator with normal punctuation, such as commas and full stops. <p> %X% Make sure there is no space between the text and the indicators. </p>
 100     </td>
 101     <td><pre>
 102 _This works_,
 103 _this does not _
 104 </pre></td>
 105     <td><em>This works</em>,%BR% _this does not _ </td>
 106   </tr>
 107   <tr valign="top">
 108     <td><strong>Verbatim (Literal) Text:</strong> %BR% Surround code excerpts and other formatted text with <code>&lt;verbatim&gt;</code> and <code>&lt;/verbatim&gt;</code> tags.%BR% %T% <code>verbatim</code> tags disable HTML code. Use <code>&lt;pre&gt;</code> and <code>&lt;/pre&gt;</code> tags instead if you want the HTML code within the tags to be interpreted.%BR% <strong><em>%X% NOTE:</em></strong> Preferences variables (* Set NAME = value) are set within verbatim tags. </td>
 109     <td><pre>
 110 &lt;verbatim&gt;
 111 class CatAnimal {
 112   void purr() {
 113     &lt;code here&gt;
 114   }
 115 }
 116 &lt;/verbatim&gt;
 117 </pre></td>
 118     <td><pre>
 119 class CatAnimal {
 120   void purr() {
 121     &lt;code here&gt;
 122   }
 123 }
 124 </pre></td>
 125   </tr>
 126   <tr valign="top">
 127     <td><strong>Separator (Horizontal Rule):</strong> %BR% Three or more three dashes at the beginning of a line.. </td>
 128     <td><pre>
 129 -------
 130 </pre></td>
 131     <td>
 132       <hr />
 133     </td>
 134   </tr>
 135   <tr valign="top">
 136     <td><strong>Bulleted List:</strong> %BR% Multiple of three spaces, an asterisk, and another space.%BR% %H% For all the list types, you can break a list item over several lines by indenting lines after the first one by <strong>at least 3 spaces</strong>. </td>
 137     <td><pre>
 138    * level 1
 139       * level 2
 140    * back on 1
 141    * A bullet
 142      broken over
 143      three lines
 144    * last bullet
 145 </pre></td>
 146     <td>
 147       <ul>
 148         <li> level 1 <ul>
 149             <li> level 2 </li>
 150           </ul>
 151         </li>
 152         <li> back on 1 </li>
 153         <li> A bullet broken over three lines </li>
 154         <li> last bullet </li>
 155       </ul>
 156     </td>
 157   </tr>
 158   <tr valign="top">
 159     <td><strong>Numbered List:</strong> %BR% Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number: <table border="1" cellpadding="0" cellspacing="0" style="border-width: 1px">
 160         <tr>
 161           <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=0;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Type</font></a></th>
 162           <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=1;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Generated Style</font></a></th>
 163           <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=2;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Sample Sequence</font></a></th>
 164         </tr>
 165         <tr>
 166           <td bgcolor="#ecf2f8" style=""> 1. </td>
 167           <td bgcolor="#ecf2f8" style=""> Arabic numerals </td>
 168           <td bgcolor="#ecf2f8" style=""> 1, 2, 3, 4... </td>
 169         </tr>
 170         <tr>
 171           <td bgcolor="#ffffff" style=""> A. </td>
 172           <td bgcolor="#ffffff" style=""> Uppercase letters </td>
 173           <td bgcolor="#ffffff" style=""> A, B, C, D... </td>
 174         </tr>
 175         <tr>
 176           <td bgcolor="#ecf2f8" style=""> a. </td>
 177           <td bgcolor="#ecf2f8" style=""> Lowercase letters </td>
 178           <td bgcolor="#ecf2f8" style=""> a, b, c, d... </td>
 179         </tr>
 180         <tr>
 181           <td bgcolor="#ffffff" style=""> I. </td>
 182           <td bgcolor="#ffffff" style=""> Uppercase Roman Numerals </td>
 183           <td bgcolor="#ffffff" style=""> I, II, III, IV... </td>
 184         </tr>
 185         <tr>
 186           <td bgcolor="#ecf2f8" style=""> i. </td>
 187           <td bgcolor="#ecf2f8" style=""> Lowercase Roman Numerals </td>
 188           <td bgcolor="#ecf2f8" style=""> i, ii, iii, iv... </td>
 189         </tr>
 190       </table>
 191     </td>
 192     <td><pre>
 193    1. Sushi
 194    1. Dim Sum
 195    1. Fondue
 196
 197    A. Sushi
 198    A. Dim Sum
 199    A. Fondue
 200
 201    i. Sushi
 202    i. Dim Sum
 203    i. Fondue
 204 </pre></td>
 205     <td>
 206       <ol>
 207         <li> Sushi </li>
 208         <li> Dim Sum </li>
 209         <li> Fondue </li>
 210       </ol>
 211       <p>
 212       </p>
 213       <ol>
 214         <li type="A"> Sushi </li>
 215         <li type="A"> Dim Sum </li>
 216         <li type="A"> Fondue </li>
 217       </ol>
 218       <p>
 219       </p>
 220       <ol>
 221         <li type="i"> Sushi </li>
 222         <li type="i"> Dim Sum </li>
 223         <li type="i"> Fondue </li>
 224       </ol>
 225     </td>
 226   </tr>
 227   <tr valign="top">
 228     <td><strong>Definition List:</strong> %BR% Three spaces, a dollar sign, the term, a colon, a space, followed by the definition. </td>
 229     <td><pre>
 230    $ Sushi: Japan
 231    $ Dim Sum: S.F.
 232 </pre></td>
 233     <td>
 234       <dl>
 235         <dt> Sushi </dt>
 236         <dd> Japan </dd>
 237         <dt> Dim Sum </dt>
 238         <dd> S.F. </dd>
 239       </dl>
 240     </td>
 241   </tr>
 242   <tr valign="top">
 243     <td><strong>Table:</strong> %BR% Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored. <ul>
 244         <li><code>| *bold* |</code> header cell with text in asterisks </li>
 245         <li><code>|   center-aligned   |</code> cell with at least two, and equal number of spaces on either side </li>
 246         <li><code>|      right-aligned |</code> cell with more spaces on the left </li>
 247         <li><code>| 2 colspan ||</code> and multi-span columns with multiple <tt>|</tt>'s right next to each other </li>
 248         <li><code>|^|</code> cell with caret indicating follow-up row of multi-span rows </li>
 249         <li> You can split rows over multiple lines by putting a backslash <code>'\'</code> at the end of each line </li>
 250         <li> Contents of table cells wrap automatically as determined by the browser </li>
 251       </ul> %T% The [[TWiki/TablePlugin]] provides the <code>|^|</code> multiple-span row functionality and additional rendering features </td>
 252     <td><pre>
 253 | *L* | *C* | *R* |
 254 | A2 |  B2  |  C2 |
 255 | A3 |  B3  |  C3 |
 256 | multi span |||
 257 | A5-7 |  5  |  5 |
 258 |^| six | six |
 259 |^| seven | seven |
 260 | split\
 261   | over\
 262   | 3 lines |
 263 | A9 |  B9  |  C9 |
 264 </pre></td>
 265     <td>
 266       <table border="1" cellpadding="0" cellspacing="0" style="border-width: 1px">
 267         <tr>
 268           <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=0;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">L</font></a></th>
 269           <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=1;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">C</font></a></th>
 270           <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=2;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">R</font></a></th>
 271         </tr>
 272         <tr>
 273           <td bgcolor="#ecf2f8" style=""> A2 </td>
 274           <td align="center" bgcolor="#ecf2f8" style=""> B2 </td>
 275           <td align="right" bgcolor="#ecf2f8" style=""> C2 </td>
 276         </tr>
 277         <tr>
 278           <td bgcolor="#ffffff" style=""> A3 </td>
 279           <td align="center" bgcolor="#ffffff" style=""> B3 </td>
 280           <td align="right" bgcolor="#ffffff" style=""> C3 </td>
 281         </tr>
 282         <tr>
 283           <td bgcolor="#ecf2f8" colspan="3" style=""> multi span </td>
 284         </tr>
 285         <tr>
 286           <td bgcolor="#ffffff" rowspan="3" style=""> A5-7 </td>
 287           <td align="center" bgcolor="#ffffff" style=""> 5 </td>
 288           <td align="right" bgcolor="#ffffff" style=""> 5 </td>
 289         </tr>
 290         <tr>
 291           <td bgcolor="#ecf2f8" style=""> six </td>
 292           <td bgcolor="#ecf2f8" style=""> six </td>
 293         </tr>
 294         <tr>
 295           <td bgcolor="#ffffff" style=""> seven </td>
 296           <td bgcolor="#ffffff" style=""> seven </td>
 297         </tr>
 298         <tr>
 299           <td bgcolor="#ecf2f8" style=""> split </td>
 300           <td bgcolor="#ecf2f8" style=""> over </td>
 301           <td bgcolor="#ecf2f8" style=""> 3 lines </td>
 302         </tr>
 303         <tr>
 304           <td bgcolor="#ffffff" style=""> A9 </td>
 305           <td align="center" bgcolor="#ffffff" style=""> B9 </td>
 306           <td align="right" bgcolor="#ffffff" style=""> C9 </td>
 307         </tr>
 308       </table>
 309     </td>
 310   </tr>
 311   <tr valign="top">
 312     <td><strong>WikiWord Links:</strong> %BR% CapitalizedWordsStuckTogether (or [[Main/WikiWords]]) will produce a link automatically if preceded by whitespace or parenthesis. %BR% %T% If you want to link to a topic in a different web write <code>Otherweb.TopicName</code>. %BR% %H% The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the WebHome topic. <p> It's generally a good idea to use the [[Main/TWikiVariables]] %TWIKIWEB% and %MAINWEB% instead of TWiki and Main. </p>
 313     </td>
 314     <td><pre>
 315 WebStatistics
 316
 317 Sandbox.WebNotify
 318
 319 Sandbox.WebHome
 320 </pre></td>
 321     <td>[[Main/WebStatistics]]<p>[[Sandbox/WebNotify]]</p>
 322       <p>[[Sandbox/WebHome]]</p>
 323     </td>
 324   </tr>
 325   <tr valign="top">
 326     <td><strong>Anchors:</strong> %BR% You can define a reference inside a TWiki topic (called an anchor name) and link to that. To <strong><em>define</em></strong> an anchor write <code>#AnchorName</code> at the beginning of a line. The anchor name must be a [[Main/WikiWord]]. To <strong><em>link to</em></strong> an anchor name use the <code>[[MyTopic#MyAnchor]]</code> syntax. You can omit the topic name if you want to link within the same topic. </td>
 327     <td><pre>
 328 [[WikiWord#NotThere]]
 329
 330 [[#MyAnchor][Jump]]
 331
 332 #MyAnchor To here
 333 </pre></td>
 334     <td>[[Main/WikiWord#NotThere]]<p>[[Main/WebHome#MyAnchor]]</p>
 335       <p><a name="MyAnchor"></a> To here </p>
 336     </td>
 337   </tr>
 338   <tr valign="top">
 339     <td><a name="HeRe"></a> <strong>Forced Links:</strong> %BR% You can create a forced internal link by enclosing words in double square brackets. %BR% 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, <code>[[text formatting FAQ]]</code> links to topic [[Main/TextFormattingFAQ]]. You can also refer to a different web and use anchors. %BR% %T% To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point. </td>
 340     <td><pre>
 341 [[wiki syntax]]
 342
 343 [[Main.TWiki users]]
 344
 345 escaped:
 346 ![[wiki syntax]]
 347 </pre></td>
 348     <td>[[Main/WikiSyntax]]<p>[[Main/TWikiUsers]]</p>
 349       <p> escaped: [[wiki syntax]] </p>
 350     </td>
 351   </tr>
 352   <tr valign="top">
 353     <td><strong>Specific Links:</strong> %BR% You can create a link where you specify the link text and the URL separately using nested square brackets <code>[[reference][text]]</code>. Internal link references (e.g. [[Main/WikiSyntax]]) and URLs (e.g. <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a>) are both supported. The rules described under <strong><em>Forced Links</em></strong> apply for internal link references. %BR% %T% Anchor names can be added as well, to create a link to a specific place in a topic. </td>
 354     <td><pre>
 355 [[WikiSyntax][wiki syntax]]
 356
 357 [[http://gnu.org][GNU]]
 358 </pre></td>
 359     <td>[[Main/WikiSyntax]]<p><a href="http://gnu.org" target="_top">GNU</a></p>
 360     </td>
 361   </tr>
 362   <tr valign="top">
 363     <td><strong>Prevent a Link:</strong> %BR% Prevent a [[Main/WikiWord]] from being linked by prepending it with an exclamation point. </td>
 364     <td><pre>
 365 !SunOS
 366 </pre></td>
 367     <td> SunOS </td>
 368   </tr>
 369   <tr valign="top">
 370     <td><strong>Disable Links:</strong> %BR% You can disable automatic linking of [[Main/WikiWords]] by surrounding text with <code>&lt;noautolink&gt;</code> and <code>&lt;/noautolink&gt;</code> tags.%BR% %H% It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. </td>
 371     <td><pre>
 372  &lt;noautolink&gt;
 373  RedHat &amp;
 374  SuSE
 375  &lt;/noautolink&gt;
 376 </pre></td>
 377     <td> RedHat &amp; SuSE </td>
 378   </tr>
 379   <tr valign="top">
 380     <td><strong>Mailto Links:</strong> %BR% E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write <code>[[mailto:user@domain][descriptive text]]</code>. </td>
 381     <td><pre>
 382 a@b.com
 383
 384 [[mailto:a@b.com]\
 385 [Mail]]
 386
 387 [[mailto:?subject=\
 388 Hi][Hi]]
 389 </pre></td>
 390     <td><a href="mailto:a@b.com">a@b.com</a><p><a href="mailto:a@b.com">Mail</a></p>
 391       <p><a href="mailto:?subject=Hi">Hi</a></p>
 392     </td>
 393   </tr>
 394 </table>
 395
 396 ## <a name="Using HTML"></a> Using HTML
 397
 398 You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write `<strike>deleted text</strike>` to get <strike>deleted text</strike>.
 399
 400 %X% There are a few usability and technical considerations to keep in mind:
 401
 402 - On collaboration pages, it's better **not** to use HTML, but to use [[TWiki shorthand|Main/WebHome#TWikiShorthand]] instead - this keeps the text uncluttered and easy to edit.
 403 - If you use HTML use [XHTML 1.0 Transitional](http://www.w3.org/TR/xhtml1/) syntax.
 404 - %X% Script tags may be filtered out, at the discretion of your TWiki administrator.
 405
 406 Recommendations when pasting HTML from other sources:
 407
 408 - Copy only text between `<body>` and `</body>` tags.
 409 - Remove all empty lines. TWiki inserts `<p />` paragraph tags on empty lines, which causes problems if done between HTML tags that do not allow paragraph tags, like for example between table tags.
 410 - Remove leading spaces. TWiki might interpret some text as lists.
 411 - Do not span a tag over more than one line. TWiki requires that the opening and closing angle brackets - <code>**&lt;...&gt;**</code> - of an HTML tag are on the same line, or the tag will be broken.
 412 - In your HTML editing program, save without hard line breaks on text wrap.
 413
 414 %T% TWiki converts shorthand notation to HTML for display. To copy a fully marked-up page, simply view the source in your browser and save the contents. If you need to save HTML frequently, you may want to check out TWiki:Plugins/PublishAddOn.
 415
 416 ### <a name="Script tags"></a> Script tags
 417
 418 You can use HTML `<script>` tags for your TWiki applications. However note that your TWiki administrator can disable `<script>` in topics, and may have chosen to do so for security considerations. TWiki markup and [[TWikiVariables]] are **not** expanded inside script tags.
 419
 420 ## <a name="Hyperlinks"></a> Hyperlinks
 421
 422 Being able to create links without any special formatting is a core TWiki feature, made possible with [[WikiWords]] and inline URLs.
 423
 424 ### <a name="Internal Links"></a> Internal Links
 425
 426 - [[GoodStyle]] is a [[WikiWord]] that links to the GoodStyle topic located in the current web.
 427
 428 - [[NotExistingYet]] is a topic waiting to be written. Create the topic by clicking on the **?**. (Try clicking, but then, **Cancel** - creating the topic would wreck this example!)
 429
 430 ### <a name="External Links"></a> External Links
 431
 432 - `http://...`, `https://...`, `ftp://...`, `gopher://...`, `news://...`, `file://...`, `telnet://...` and `mailto:...@...` are linked automatically.
 433
 434 - E-mail addresses like `name@domain.com` are linked automatically.
 435
 436 - `[[Square bracket rules]]` let you easily create [[non-WikiWord links|Main/WebHome#SquareBrackets]].
 437   - 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](http://yahoo.com/).
 438
 439 ## <a name="TWiki Variables"></a> TWiki Variables
 440
 441 TWiki Variables are names that are enclosed in percent signs `%` that are expanded on the fly.
 442
 443 - `%TOC%` : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
 444
 445 - `%WEB%` : The current web, is **%WEB%**.
 446
 447 - `%TOPIC%` : The current topic name, is **%TOPIC%**.
 448
 449 - `%ATTACHURL%` : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as <code>**%ATTACHURL%/image.gif**</code> to show the URL of the file or the image in your text.
 450
 451 - `%INCLUDE{"SomeTopic"}%` : Server side include, includes another topic. The current web is the default web. Example: <code>**%INCLUDE\{"TWiki.SiteMap"\}%**</code>
 452
 453 - `%SEARCH{"sushi"}%` : Inline search showing the search result embedded in a topic. [[FormattedSearch]] gives you control over formatting, useful for creating web-based applications.
 454
 455 - [[TWikiPreferences]] defines some site-wide variables. Among others:
 456   - **Line break:** Write `%BR%` to start a new line.
 457   - **Colored text:** Write: `%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors` to get: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors.
 458   - **Documentation Graphics:** Write: `%H% Help, %T% Tip, %X% Alert` to get: %H% Help, %T% Tip, %X% Alert. For more info see [[TWikiDocGraphics]].
 459
 460 - There are many more variables, see **[[TWikiVariables]]**.
 461
 462 - To "escape" a variable, prefix it with an exclamation mark. Write: `!%SOMEVARIABLE%` to get: %SOMEVARIABLE%.
 463
 464 ## <a name="TWikiPlugin Formatting Extension"></a><a name="_TWikiPlugin Formatting Extensio"></a> TWikiPlugin Formatting Extensions
 465
 466 Plugins can extend the functionality of TWiki into many other areas. There are a huge number of TWiki plugins available from the [Plugins](http://twiki.org/cgi-bin/view/Plugins) web on TWiki.org.
 467
 468 Currently enabled plugins on this TWiki installation, as listed by `%PLUGINDESCRIPTIONS%`:
 469
 470 - [[SpreadSheetPlugin]] <span>(any TWiki, 10197)</span>:
 471 - [[CommentPlugin]] <span>(Dakar, 11359)</span>: Allows users to quickly post comments to a page without an edit/preview/save cycle
 472 - [[EditTablePlugin]] <span>(any TWiki, 11646)</span>:
 473 - [[InterwikiPlugin]] <span>(Dakar, $Rev: 11935$)</span>:
 474 - [[PreferencesPlugin]] <span>(Dakar, 9839)</span>:
 475 - [[SlideShowPlugin]] <span>(Any TWiki, $Rev: 12847$)</span>:
 476 - [[SmiliesPlugin]] <span>(Dakar, 8154)</span>:
 477 - [[TablePlugin]] <span>(1.020, 12339)</span>:
 478 - [[TwistyPlugin]] <span>(1.2.0, $Rev: 12154$)</span>:
 479
 480 Check on current Plugin status and settings for this site in [[TWikiPreferences]].
 481
 482 ## <a name="Common Editing Errors"></a> Common Editing Errors
 483
 484 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]]:
 485
 486 - **Q:** Text enclosed in angle brackets like `<filename>` is not displayed. How can I show it as it is?
 487   - **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 `'>'`. <br /> Example: Type `'prog &lt;filename&gt;'` to get `'prog <filename>'`.
 488
 489 - **Q:** Why is the `'&'` character sometimes not displayed?
 490   - **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 `'&'`. <br /> Example: Type `'This &amp; that'` to get `'This & that'`.