data/TWiki/WikiSyntax.txt
changeset 0 414e01d06fd5
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="20"}%
       
     2 ---+ TWiki Shorthand Basics
       
     3 
       
     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...
       
     5 
       
     6 %STARTINCLUDE%
       
     7 
       
     8    * Separate each *paragraph* with a blank line.
       
     9 
       
    10    * To display a word or phrase in *bold type*, put it in asterisks: =*bold type*=.
       
    11 
       
    12    * To display a word or phrase in _italic_, put it in underscores: =_italic_=.
       
    13 
       
    14    * To display a word or phrase in __bold italic__, put it in _double_ underscores: =__bold italic__=.
       
    15 
       
    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%=.
       
    17 
       
    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!).
       
    19    
       
    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=.
       
    21 
       
    22    * For an external link, type the full URL: =http://twiki.org/=.
       
    23 
       
    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==.
       
    25 
       
    26    * To indent with a bullet, enter =[space][space][space][asterisk][space]=.
       
    27       * Use multiples of 3 spaces to start *nested bullets*.
       
    28          * That's 3-6-9-...
       
    29 
       
    30    * To create a numbered list:
       
    31       1 Start items in a *numbered list* with =[space][space][space][1][space]=.
       
    32       1 The "1" (or *any number*) will be replaced by the correct number, in order.
       
    33       1 To add a new paragraph without restarting list numbering, use the %<nop>BR% variable, like below:%BR% Text added (in new paragraph)
       
    34       1 and list numbering continues.
       
    35 
       
    36    * Always start *counting* spaces for bullets and such from the beginning of a new line.
       
    37 
       
    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=
       
    39 
       
    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==.
       
    41 
       
    42    * Use ==&lt;verbatim&gt;== to enclose code excerpts, filenames, and other unformatted text:%BR%
       
    43      =<b>&lt;verbatim&gt;</b>= %BR%
       
    44      =unformatted text!= %BR%
       
    45      =<b>&lt;/verbatim&gt;</b>= %BR%%BR%
       
    46      __%X% NOTE:__ VARIABLES can be set within verbatim tags, that is, they are not disabled
       
    47 
       
    48    * Use ==&lt;literal&gt;== to enclose anything that TWiki must not touch under any circumstances, such as in-line HTML code.
       
    49 
       
    50    * Follow GoodStyle recommendations when editing topics.
       
    51 
       
    52    * See TextFormattingRules for the complete set of formatting rules.