TWiki/WikiSyntax.mdwn

   1 # <a name="TWiki Shorthand Basics"></a> TWiki Shorthand Basics
   2
   3 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...
   4
   5 - Separate each **paragraph** with a blank line.
   6
   7 - To display a word or phrase in **bold type**, put it in asterisks: `*bold type*`.
   8
   9 - To display a word or phrase in _italic_, put it in underscores: `_italic_`.
  10
  11 - To display a word or phrase in **_bold italic_**, put it in _double_ underscores: `__bold italic__`.
  12
  13 - 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`.
  14
  15 - 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!).
  16
  17 - When entering WikiName signatures - like, admin - include "%USERSWEB%." as a prefix, since all TWiki member pages are in the %USERSWEB% web: `%USERSWEB%.YourName`.
  18
  19 - For an external link, type the full URL: `http://twiki.org/`.
  20
  21 - To prevent a WikiWord from becoming a link, type `<nop>` or an exclamation point first: <code>**&lt;nop&gt;NoLinkPlease**</code> or <code>**!NoLinkPlease**</code>.
  22
  23 - To indent with a bullet, enter `[space][space][space][asterisk][space]`.
  24   - Use multiples of 3 spaces to start **nested bullets**.
  25     - That's 3-6-9-...
  26
  27 - To create a numbered list:
  28   1. Start items in a **numbered list** with `[space][space][space][1][space]`.
  29   2. The "1" (or **any number**) will be replaced by the correct number, in order.
  30   3. To add a new paragraph without restarting list numbering, use the %BR% variable, like below:%BR% Text added (in new paragraph)
  31   4. and list numbering continues.
  32
  33 - Always start **counting** spaces for bullets and such from the beginning of a new line.
  34
  35 - To include an image, type its URL. You also can Attach an image to the page and display it with text <br />`%ATTACHURL%/yourimagefilename.jpg`
  36
  37 - To display a word or phrase in `MONOSPACED TYPE`, put it in equal signs: `=like this=`. <br />Use `==two==` for bold: <code>**bold mono**</code>.
  38
  39 - Use <code>**&lt;verbatim&gt;**</code> to enclose code excerpts, filenames, and other unformatted text:%BR% <code>**&lt;verbatim&gt;**</code> %BR% `unformatted text!` %BR% <code>**&lt;/verbatim&gt;**</code> %BR%%BR% **_%X% NOTE:_** VARIABLES can be set within verbatim tags, that is, they are not disabled
  40
  41 - Use <code>**&lt;literal&gt;**</code> to enclose anything that TWiki must not touch under any circumstances, such as in-line HTML code.
  42
  43 - Follow [[GoodStyle]] recommendations when editing topics.
  44
  45 - See [[TextFormattingRules]] for the complete set of formatting rules.