releasing version 1.5
[ikiwiki.git] / basewiki / helponformatting.mdwn
1 # Help on formatting text
2
3 Text on this wiki is written in a form very close to how you might write
4 text for an email message.
5
6 Leave blank lines between paragraphs.
7
8 You can \**emphasise*\* or \*\***strongly emphasise**\*\* text by placing it
9 in single or double asterisks.
10
11 To create a list, start each line with an asterisk:
12
13 * "* this is my list"
14 * "* another item"
15
16 To make a numbered list, start each line with a number (any number will
17 do) followed by a period:
18
19 1. "1. first line"
20 2. "2. second line"
21 2. "2. third line"
22
23 To create a header, start a line with one or more `#` characters followed
24 by a space and the header text. The number of `#` characters controls the
25 size of the header:
26
27 # # h1
28 ## ## h2
29 ### ### h3
30 #### #### h4
31
32 To create a horizontal rule, just write three or more dashes on their own
33 line:
34
35 ----
36
37 To quote someone, prefix the quote with ">":
38
39 > To be or not to be,
40 > that is the question.
41
42 To write a code block, indent each line with a tab or 8 spaces:
43
44         10 PRINT "Hello, world!"
45         20 GOTO 10
46
47 To link to another page on the wiki, place the page's name inside double
48 square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].
49
50 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
51 \[link text\]\(url\)
52
53 ----
54
55 Advanced users can use [[PreProcessorDirective]]s to do additional cool
56 stuff.
57
58 Also, if the smiley plugin is enabled in your wiki, you can insert
59 [[smileys]] and some other useful symbols.
60
61 ----
62
63 This style of text formatting is called [[MarkDown]].