data/TWiki/WikiSyntax.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="20"}%
colas@0
     2
---+ TWiki Shorthand Basics
colas@0
     3
colas@0
     4
If you can enter text, you're ready for TWiki. With a few simple, intuitive TextFormattingRules, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics...
colas@0
     5
colas@0
     6
%STARTINCLUDE%
colas@0
     7
colas@0
     8
   * Separate each *paragraph* with a blank line.
colas@0
     9
colas@0
    10
   * To display a word or phrase in *bold type*, put it in asterisks: =*bold type*=.
colas@0
    11
colas@0
    12
   * To display a word or phrase in _italic_, put it in underscores: =_italic_=.
colas@0
    13
colas@0
    14
   * To display a word or phrase in __bold italic__, put it in _double_ underscores: =__bold italic__=.
colas@0
    15
colas@0
    16
   * To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first: =Sandbox.<nop>%HOMETOPIC%=.
colas@0
    17
colas@0
    18
   * If you enter a WikiWord for a topic that doesn't exist, it'll appear highlighted, with question mark at the end, prompting you (or someone else) to start off the new topic by clicking the *?* - NewTopic (click the *?*, but don't save, to preserve the example!).
colas@0
    19
   
colas@0
    20
   * When entering <nop>WikiName signatures - like, <nop>%USERNAME% - include "%USERSWEB%." as a prefix, since all TWiki member pages are in the %USERSWEB% web: =%USERSWEB%.YourName=.
colas@0
    21
colas@0
    22
   * For an external link, type the full URL: =http://twiki.org/=.
colas@0
    23
colas@0
    24
   * To prevent a <nop>WikiWord from becoming a link, type =&lt;nop&gt;= or an exclamation point first: ==&lt;nop&gt;NoLinkPlease== or ==!NoLinkPlease==.
colas@0
    25
colas@0
    26
   * To indent with a bullet, enter =[space][space][space][asterisk][space]=.
colas@0
    27
      * Use multiples of 3 spaces to start *nested bullets*.
colas@0
    28
         * That's 3-6-9-...
colas@0
    29
colas@0
    30
   * To create a numbered list:
colas@0
    31
      1 Start items in a *numbered list* with =[space][space][space][1][space]=.
colas@0
    32
      1 The "1" (or *any number*) will be replaced by the correct number, in order.
colas@0
    33
      1 To add a new paragraph without restarting list numbering, use the %<nop>BR% variable, like below:%BR% Text added (in new paragraph)
colas@0
    34
      1 and list numbering continues.
colas@0
    35
colas@0
    36
   * Always start *counting* spaces for bullets and such from the beginning of a new line.
colas@0
    37
colas@0
    38
   * To include an image, type its URL. You also can Attach an image to the page and display it with text <br /> =%<nop>ATTACHURL%/yourimagefilename.jpg=
colas@0
    39
colas@0
    40
   * To display a word or phrase in =MONOSPACED TYPE=, put it in equal signs: =<nop>=like this==. <br />Use =<nop>=<nop>=two=== for bold: ==bold mono==.
colas@0
    41
colas@0
    42
   * Use ==&lt;verbatim&gt;== to enclose code excerpts, filenames, and other unformatted text:%BR%
colas@0
    43
     =<b>&lt;verbatim&gt;</b>= %BR%
colas@0
    44
     =unformatted text!= %BR%
colas@0
    45
     =<b>&lt;/verbatim&gt;</b>= %BR%%BR%
colas@0
    46
     __%X% NOTE:__ VARIABLES can be set within verbatim tags, that is, they are not disabled
colas@0
    47
colas@0
    48
   * Use ==&lt;literal&gt;== to enclose anything that TWiki must not touch under any circumstances, such as in-line HTML code.
colas@0
    49
colas@0
    50
   * Follow GoodStyle recommendations when editing topics.
colas@0
    51
colas@0
    52
   * See TextFormattingRules for the complete set of formatting rules.