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