Difference: WikiSyntax (17 vs. 18)

Revision 182005-03-27 - TWikiContributor

 

TWiki Shorthand Basics

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...

Changed:
<
<
  • Separate each paragraph with a blank line.
>
>
  • Separate each paragraph with a blank line.
 
Changed:
<
<
  • To display a word or phrase in bold type, put it in asterisks: *bold type*.
>
>
  • To display a word or phrase in bold type, put it in asterisks: *bold type*.
 
Changed:
<
<
  • To display a word or phrase in italic, put it in underscores: _italic_.
>
>
  • To display a word or phrase in italic, put it in underscores: _italic_.
 
Changed:
<
<
  • To display a word or phrase in bold italic, put it in double underscores: __bold italic__.
>
>
  • To display a word or phrase in bold italic, put it in double underscores: __bold italic__.
 
Changed:
<
<
  • 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.WebHome.
>
>
  • 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.WebHome.
 
Changed:
<
<
  • 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!).

  • When entering WikiName signatures - like, guest - include "Main." as a prefix, since all TWiki member pages are in the Main web: Main.YourName.
>
>
  • 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!).

  • When entering WikiName signatures - like, guest - include "Main." as a prefix, since all TWiki member pages are in the Main web: Main.YourName.
 
Changed:
<
<
  • For an external link, type the full URL: http://twiki.org/.
>
>
  • For an external link, type the full URL: http://twiki.org/.
 
Changed:
<
<
  • To prevent a WikiWord from becoming a link, type <nop> or an exclamation point first: <nop>NoLinkPlease or !NoLinkPlease.
>
>
  • To prevent a WikiWord from becoming a link, type <nop> or an exclamation point first: <nop>NoLinkPlease or !NoLinkPlease.
 
Changed:
<
<
  • To indent with a bullet, enter [space][space][space][asterisk][space].
    • Use multiples of 3 spaces to start nested bullets.
      • That's 3-6-9-...
>
>
  • To indent with a bullet, enter [space][space][space][asterisk][space].
    • Use multiples of 3 spaces to start nested bullets.
      • That's 3-6-9-...
 
Changed:
<
<
  • To create a numbered list:
    1. Start items in a numbered list with [space][space][space][1][space].
    2. The "1" (or any number) will be replaced by the correct number, in order.
    3. To add a new paragraph without restarting list numbering, use the %BR% variable, like below:
      Text added (in new paragraph)
    4. and list numbering continues.
>
>
  • To create a numbered list:
    1. Start items in a numbered list with [space][space][space][1][space].
    2. The "1" (or any number) will be replaced by the correct number, in order.
    3. To add a new paragraph without restarting list numbering, use the %BR% variable, like below:
      Text added (in new paragraph)
    4. and list numbering continues.
 
Changed:
<
<
  • Always start counting spaces for bullets and such from the beginning of a new line.
>
>
  • Always start counting spaces for bullets and such from the beginning of a new line.
 
Changed:
<
<
  • To include an image, type its URL. You also can Attach an image to the page and display it with text
    %ATTACHURL%/yourimagefilename.jpg
>
>
  • To include an image, type its URL. You also can Attach an image to the page and display it with text
    %ATTACHURL%/yourimagefilename.jpg
 
Changed:
<
<
  • To display a word or phrase in MONOSPACED TYPE, put it in equal signs: =like this=.
    Use ==two== for bold: bold mono.
>
>
  • To display a word or phrase in MONOSPACED TYPE, put it in equal signs: =like this=.
    Use ==two== for bold: bold mono.
 
Changed:
<
<
  • Use <verbatim> to enclose code excerpts, filenames, and other unformatted text:
    <verbatim>
    unformatted text!
    </verbatim>

    ALERT! NOTE: VARIABLES can be set within verbatim tags, that is, they are not disabled
>
>
  • Use <verbatim> to enclose code excerpts, filenames, and other unformatted text:
    <verbatim>
    unformatted text!
    </verbatim>

    ALERT! NOTE: VARIABLES can be set within verbatim tags, that is, they are not disabled
 
Changed:
<
<
  • Three (or more) consecutive hyphens expand into a horizontal rule:
    ---
>
>
  • Three (or more) consecutive hyphens expand into a horizontal rule:
    ---
 
Changed:
<
<
  • Follow GoodStyle recommendations when editing topics.
>
>
  • Follow GoodStyle recommendations when editing topics.
 
Changed:
<
<
>
>
 
 
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding KoreaCmsWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.WikiSyntax