TWiki/TextFormattingRules.mdwn

   1 # <a name="TWiki Text Formatting"></a> TWiki Text Formatting
   2
   3 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.
   4
   5 <div>
   6   <ul>
   7     <li><a href="#TWiki Text Formatting"> TWiki Text Formatting</a><ul>
   8         <li><a href="#TWiki Editing Shorthand"> TWiki Editing Shorthand</a></li>
   9         <li><a href="#Using HTML"> Using HTML</a></li>
  10         <li><a href="#Hyperlinks"> Hyperlinks</a><ul>
  11             <li><a href="#Internal Links"> Internal Links</a></li>
  12             <li><a href="#External Links"> External Links</a></li>
  13           </ul>
  14         </li>
  15         <li><a href="#TWiki Variables"> TWiki Variables</a></li>
  16         <li><a href="#TWikiPlugin Formatting Extension"> TWikiPlugin Formatting Extensions</a></li>
  17         <li><a href="#Common Editing Errors"> Common Editing Errors</a></li>
  18       </ul>
  19     </li>
  20   </ul>
  21 </div>
  22
  23 <a name="TWikiShorthand"></a>
  24
  25 ## <a name="TWiki Editing Shorthand"></a> TWiki Editing Shorthand
  26
  27 ## <a name="Using HTML"></a> Using HTML
  28
  29 ## <a name="Hyperlinks"></a> Hyperlinks
  30
  31 Being able to create links without any special formatting is a core TWiki feature, made possible with [[WikiWords]] and inline URLs.
  32
  33 ### <a name="Internal Links"></a> Internal Links
  34
  35 - [[GoodStyle]] is a [[WikiWord]] that links to the GoodStyle topic located in the current web.
  36
  37 - [[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!)
  38
  39 ### <a name="External Links"></a> External Links
  40
  41 - `http://...`, `https://...`, `ftp://...`, `gopher://...`, `news://...`, `file://...`, `telnet://...` and `mailto:...@...` are linked automatically.
  42
  43 - E-mail addresses like `name@domain.com` are linked automatically.
  44
  45 - `[[Square bracket rules]]` let you easily create [[non-WikiWord links|Main/WebHome#SquareBrackets]].
  46   - 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/).
  47
  48 ## <a name="TWiki Variables"></a> TWiki Variables
  49
  50 ## <a name="TWikiPlugin Formatting Extension"></a><a name="_TWikiPlugin Formatting Extensio"></a> TWikiPlugin Formatting Extensions
  51
  52 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.
  53
  54 Currently enabled plugins on this TWiki installation, as listed by `%PLUGINDESCRIPTIONS%`:
  55
  56 - [[SpreadSheetPlugin]] <span>(any TWiki, 10197)</span>:
  57 - [[CommentPlugin]] <span>(Dakar, 11359)</span>: Allows users to quickly post comments to a page without an edit/preview/save cycle
  58 - [[EditTablePlugin]] <span>(any TWiki, 11646)</span>:
  59 - [[InterwikiPlugin]] <span>(Dakar, $Rev: 11935$)</span>:
  60 - [[PreferencesPlugin]] <span>(Dakar, 9839)</span>:
  61 - [[SlideShowPlugin]] <span>(Any TWiki, $Rev: 12847$)</span>:
  62 - [[SmiliesPlugin]] <span>(Dakar, 8154)</span>:
  63 - [[TablePlugin]] <span>(1.020, 12339)</span>:
  64 - [[TwistyPlugin]] <span>(1.2.0, $Rev: 12154$)</span>:
  65
  66 Check on current Plugin status and settings for this site in [[TWikiPreferences]].
  67
  68 ## <a name="Common Editing Errors"></a> Common Editing Errors
  69
  70 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]]:
  71
  72 - **Q:** Text enclosed in angle brackets like `<filename>` is not displayed. How can I show it as it is?
  73   - **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>'`.
  74
  75 - **Q:** Why is the `'&'` character sometimes not displayed?
  76   - **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'`.