web commit from 217.226.25.50: poll vote (Accept both)
[ikiwiki.git] / basewiki / helponformatting.mdwn
1 # Help on formatting text
2
3 Text on this wiki is, by default, written in a form very close to how you
4 might write text for an email message. This style of text formatting is
5 called [[MarkDown]], and it works like this:
6
7 Leave blank lines between paragraphs.
8
9 You can \**emphasise*\* or \*\***strongly emphasise**\*\* text by placing it
10 in single or double asterisks.
11
12 To create a list, start each line with an asterisk:
13
14 * "* this is my list"
15 * "* another item"
16
17 To make a numbered list, start each line with a number (any number will
18 do) followed by a period:
19
20 1. "1. first line"
21 2. "2. second line"
22 2. "2. third line"
23
24 To create a header, start a line with one or more `#` characters followed
25 by a space and the header text. The number of `#` characters controls the
26 size of the header:
27
28 # # h1
29 ## ## h2
30 ### ### h3
31 #### #### h4
32 ##### ##### h5
33 ###### ###### h6
34
35 You can also make the first two levels of heading by underlining text with
36 equals or dash:
37
38 heading 1
39 =========
40
41     heading 1
42     =========
43
44 heading 2
45 ---------
46
47     heading 2
48     ---------
49
50 To create a horizontal rule, just write three or more dashes or stars on
51 their own line:
52
53 ----
54
55 To quote someone, prefix the quote with ">":
56
57 > To be or not to be,
58 > that is the question.
59
60 To write a code block, indent each line with a tab or 4 spaces:
61
62         10 PRINT "Hello, world!"
63         20 GOTO 10
64
65 To link to another page on the wiki, place the page's name inside double
66 square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].
67
68 To link to any other web page, or to an email address, you can just put the url in angle brackets: <<http://ikiwiki.kitenet.net>>, or you can use the form
69 \[link text\]\(url\)
70
71 ----
72
73 You can also use [[PreProcessorDirective]]s to do additional cool stuff.
74
75 [[if test="enabled(smiley)"  then="""
76 Also, because this wiki has the smiley plugin enabled, you can
77 insert [[smileys]] and some other useful symbols.
78 """]]