revive the original index.html patches, which are for the source side, not
[ikiwiki.git] / doc / 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 To create a horizontal rule, just write three or more dashes or stars on
36 their own line:
37
38 ----
39
40 To quote someone, prefix the quote with ">":
41
42 > To be or not to be,
43 > that is the question.
44
45 To write a code block, indent each line with a tab or 4 spaces:
46
47         10 PRINT "Hello, world!"
48         20 GOTO 10
49
50 To link to another page on the wiki, place the page's name inside double
51 square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].
52
53 To link to any other web page, or to an email address, you can just put the
54 url in angle brackets: <<http://ikiwiki.info>>, or you can use the
55 form \[link text\]\(url\)
56
57 ----
58
59 You can also use [[PreProcessorDirective]]s to do additional cool stuff.
60
61 [[if test="enabled(inline)" then="""
62 This wiki has the inline plugin enabled, so you can create a [[blog]] on any
63 page.
64 """]]
65
66 [[if test="enabled(smiley)" then="""
67 This wiki has the smiley plugin enabled, so you can insert [[smileys]] and some
68 other useful symbols.
69 """]]
70
71 [[if test="enabled(shortcut)" then="""
72 This wiki has the shortcut plugin enabled, so you can use [[shortcuts]] to link
73 to common resources.
74 """]]
75
76 [[if test="enabled(template)" then="""
77 This wiki has the template plugin enabled, so you can create and use
78 [[templates]] for repeated chunks of parameterized wiki text.
79 """]]