web commit by alccode
[ikiwiki.git] / doc / ikiwiki / formatting.mdwn
1 [[!meta title="Formatting wiki pages"]]
2 [[!meta robots="noindex, follow"]]
3
4 Text on this wiki is, by default, written in a form very close to how you
5 might write text for an email message. This style of text formatting is
6 called [[MarkDown]], and it works like this:
7
8 Leave blank lines between paragraphs.
9
10 <h1>test h1</h1>
11 <p>paragraph1. yay and so on.</p>
12 <p>paragraph 2.  etc. etc.</p>
13 <hr>
14 <p>did you see hr?</p>
15
16 You can \**emphasise*\* or \*\***strongly emphasise**\*\* text by placing it
17 in single or double asterisks.
18
19 To create a list, start each line with an asterisk:
20
21 * "* this is my list"
22 * "* another item"
23
24 To make a numbered list, start each line with a number (any number will
25 do) followed by a period:
26
27 1. "1. first line"
28 2. "2. second line"
29 2. "2. third line"
30
31 To create a header, start a line with one or more `#` characters followed
32 by a space and the header text. The number of `#` characters controls the
33 size of the header:
34
35 # # h1
36 ## ## h2
37 ### ### h3
38 #### #### h4
39 ##### ##### h5
40 ###### ###### h6
41
42 To create a horizontal rule, just write three or more dashes or stars on
43 their own line:
44
45 ----
46
47 To quote someone, prefix the quote with ">":
48
49 > To be or not to be,
50 > that is the question.
51
52 To write a code block, indent each line with a tab or 4 spaces:
53
54         10 PRINT "Hello, world!"
55         20 GOTO 10
56
57 To link to an url or email address, you can just put the
58 url in angle brackets: <<http://ikiwiki.info>>, or you can use the
59 form \[link text\]\(url\)
60
61 ----
62
63 In addition to basic html formatting using [[MarkDown]], this wiki lets
64 you use the following additional features:
65
66 * To link to another page on the wiki, place the page's name inside double
67   square brackets. So you would use `\[[WikiLink]]` to link to [[WikiLink]].
68
69 [[!if test="enabled(smiley) and smileys" then="""
70 * Insert [[smileys]] and some other useful symbols. :-)
71 """]]
72
73 [[!if test="enabled(shortcut) and shortcuts" then="""
74 * Use [[shortcuts]] to link to common resources.
75
76         \[[!wikipedia War\_of\_1812]]
77 """]]
78
79 [[!if test="enabled(toc)" then="""
80 * Add a table of contents to a page:
81
82         \[[!toc ]]
83 """]]
84
85
86 [[!if test="enabled(meta)" then="""
87 * Change the title of a page:
88
89         \[[!meta title="full page title"]]
90 """]]
91
92 [[!if test="enabled(inline) and blog" then="""
93 * Create a [[blog]] by inlining a set of pages:
94
95         \[[!inline pages="blog/*"]]
96 """]]
97
98 [[!if test="enabled(template) and templates" then="""
99 * Create and fill out [[templates]] for repeated chunks of
100   parameterized wiki text.
101 """]]