none
[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 - 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 **?** - [[FreshTopic]] (click the **?**, but don't save, to preserve the example!).
16
17 - When entering WikiName signatures - like, admin - include the Main as a prefix, since all TWiki member pages are in the Main web: `Main.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>` first, <code>**&lt;nop&gt;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     - Thats 3-6-9-...
26
27 1. Start items in a **numbered list** with `[space][space][space][1][space]`.
28 2. The "1" (or **any number**) will be replaced by the correct number, in order.
29
30 - Always start **counting** for bullets and such from the beginning of a new line.
31
32 - 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=.
33
34 - 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>.
35
36           Surround code excerpts, filenames, and other
37           unformatted text with <pre> or </pre>
38           or the special TWiki use <verbatim> and
39           </verbatim> tags.
40
41 - Use three (or more) consecutive **hyphens** expands into a horizontal rule: `---`
42
43 - See [[TextFormattingRules]] for more....
44
45 ----
46
47 -- [[MikeMannix]] - 14 Sep 2001 <br />