f806990062d254b984d6be4dacaff72ecc00cfa2
[openafs-wiki.git] / TWiki / WikiSyntax.mdwn
1 ## <a name="TWiki Language by the Line"></a> TWiki Language by the Line
2
3 - Separate each **paragraph** with a blank line.
4
5 - To display a word or phrase in **bold type**, surround it by asterisks: `*bold type*`
6
7 - To display a word or phrase in _italic_, surround it by underscores: `_italic_`
8
9 - To display a word or phrase in **_bold italic_**, surround it by double underscores: `__bold italic__`
10
11 - **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, a dot, and the WikiWord for that topic: <code>**Test.WebHome**</code>.
12
13 - If you add a [[WikiWord]] for a topic that doesn't exist, you'll see a question mark after it, prompting you (or someone else) to edit the new topic: [[FreshTopic]]. Once edited, enter the new WikiName and it will appear as a link to the that page.
14
15 - When entering WikiName links, include the home web name as a prefix, ex: all TWiki member pages are in the Main web, so enter <code>**Main.YourName**</code>.
16
17 - For an external link, just type the URL, starting with <code>**http://**</code>.
18
19 - To prevent a WikiName from becoming a link, type `<nop>` first, <code>**&lt;nop&gt;NoLinkPlease**</code>.
20
21 - To indent with a **bullet**, enter space-space-space-asterisk-space.
22   - Use a multiple of 3 spaces to start **nested bullets**.
23
24 1. Start items in a **numbered list** with space-space-space-1-space.
25 2. The "1" (or **any number**) will be replaced by the correct number in order.
26
27 - Always start **counting** for bullets and such from the beginning of a new line.
28
29 - To include an **image**, type its URL. You also can Attach an image to the page and display it with text `%ATTACHURL%/yourimagefilename.jpg` .
30
31 - To display a word or phrase in `MONOSPACED TYPE`, surround it by '=' characters. Use two for bold: <code>**bold mono**</code> .
32
33           Surround code excerpts, filenames, and other
34           unformatted text with <pre> or </pre>
35           <verbatim> and </verbatim> tags.
36
37 - Use three or more consecutive **hyphens** for a horizontal rule: `---`
38
39 - To see the markup for any page, click on **Raw text** on the lower toolbar.
40
41 - See [[TextFormattingRules]] for more....