b6e6b674434a63d4959002a056870567b64897e5
[openafs-wiki.git] / TWiki / WikiSyntax.mdwn
1 # <a name="Instant TWiki Shorthand"></a> Instant TWiki Shorthand
2
3 If you can enter text, write an email, you're ready for TWiki. Use simple, intuitive TWiki shorthand to get even more control - instantly!
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: `Test.WebHome`.
14
15 - - When entering [[WikiName]] signatures - like, admin - include the Main as a prefix, since all TWiki member pages are in the Main web: `Main.YourName`.
16
17 - If you enter a [[WikiWord]] for a topic that doesn't exist, it appears highlighted, with a question mark link at the end, prompting you (or someone else) to start off the new topic by clicking the **?** - [[FreshTopic]] (try clicking the **?**, but don't save, or you'll create a <code>**FreshTopic**</code> page and ruin this example).
18
19 - For an external link, type the full URL: `http://twiki.org` = <http://twiki.org>
20
21 - To prevent a [[WikiWord]] from becoming a link, type `<nop>` first, <code>**&lt;nop&gt;WikiWord**</code> = WikiWord
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   1. Start items in a **numbered list** with `[space][space][space][1][space]`.
27   2. The "1" (or **any number**) will be replaced by the correct number, in order.
28
29 - Always start **counting spaces** for bullets and such from the beginning of a new line.
30
31 - 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=.
32
33 - 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>.
34
35           Surround code excerpts, filenames, and other
36           unformatted text with <pre> or </pre>
37           or the special TWiki use <verbatim> and
38           </verbatim> tags.
39
40 - Use three (or more) consecutive **hyphens** expands into a horizontal rule: `---`
41
42 - See [[TWikiShorthand|Main/TextFormattingRules]] for more....
43
44 ----
45
46 -- [[MikeMannix]] - 01 Oct 2001 <br />