summaryrefslogtreecommitdiff
path: root/helponformatting.mdwn
blob: 57bddf35a9891569a941fb89c363f7704ae24cce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
[[!meta title="Help on formatting wiki pages"]]

Text on this wiki is, by default, written in a form very close to how you
might write text for an email message. This style of text formatting is
called [[MarkDown]], and it works like this:

Simple Formatting
-----------------

Leave blank lines between paragraphs.

You can \**emphasise*\* or \*\***strongly emphasise**\*\* text by placing it
in single or double asterisks.

To quote someone, prefix the quote with ">":

	> To be or not to be,
	> that is the question.

becomes:

> To be or not to be,
> that is the question.

To write a code block, indent each line with a tab or 4 spaces:

	10 PRINT "Hello, world!"
	20 GOTO 10

And to produce 'code' (monospaced) font in an existing paragraph, use back ticks (\`) just like `` `this is` ``.


Lists
-----

To create a list, start each line with an asterisk, a plus, or a minus (your choice!), a space, and then your text. To have sub-points, simply add three spaces in front of the list symbol you chose.

	* First main bullet point
	   * Indented once (three spaces)
	      * Indented once more (another three spaces)
	* Second main bullet point

becomes:

* First main bullet point
   * Indendented once (three spaces)
      * Indended once more (another three spaces)
* Second main bullet point

To make a numbered list, start each line with a number (any number will
do) followed by a period:

1. "1. first line"
2. "2. second line"
2. "2. third line"

Headers and Rules
-----------------

To create a header, start a line with one or more `#` characters followed by a space and the header text. The number of `#` characters controls the size of the header:

# # h1
## ## h2
### ### h3
#### #### h4
##### ##### h5
###### ###### h6

Alternatively, you can create a H1 header by underlining a line with equal signs '=', and a H2 header by underlining a line with dashes '-'.

To create a horizontal rule, just write three or more dashes or stars on
their own line:


	----

then becomes

----

Links
-----

To link to an url or email address, you can just put the url in angle brackets: 

	<http://ikiwiki.info>

becomes

<http://ikiwiki.info>

You can also use the form \[link text\]\(url\), so that

	[Link to ikiwiki home](http://ikiwiki.info)

becomes

[Link to ikiwiki home](http://ikiwiki.info)

ikiwiki Specific Features
-------------------------

In addition to basic html formatting using [[MarkDown]], ikiwiki gives you markup features, too.

To link to another page on the wiki, place the page's name inside double square brackets. So you would use `\[[WikiLink]]` to link to [[WikiLink]].

To link to another page with text, use `\[[see_the_schedule_page|schedule]]` becomes [[see_the_schedule_page|Schedule]]. Note the ludicrous use of underscores instead of spaces. Sorry about that, hopefully they'll fix that one day.

Also, you can look into:

[[!if test="enabled(smiley) and smileys" then="""
* Insert [[smileys]] and some other useful symbols. :-)
"""]]

[[!if test="enabled(shortcut) and shortcuts" then="""
* Use [[shortcuts]] to make it easy to link to common urls.
"""]]

[[!if test="enabled(toc)" then="""
* Add a table of contents to a page:

	\[[toc ]]
"""]]


[[!if test="enabled(meta)" then="""
* Change the title of a page by using:

	\[[meta title="full page title"]]
"""]]

[[!if test="enabled(inline) and blog" then="""
* Create a [[blog]] by inlining a set of pages:

	\[[inline pages="blog/*"]]
"""]]

[[!if test="enabled(template) and templates" then="""
* Create and fill out [[templates]] for repeated chunks of
  parameterized wiki text.
"""]]

Tables
------

Finally, there are tables through an ikiwiki plugin:

	\[[table data="""
	Customer|Amount
	Fulanito|134,34
	Menganito|234,56
	Menganito|234,56
	"""]]

becomes

[[!table data="""
Customer|Amount
Fulanito|134,34
Menganito|234,56
Menganito|234,56
"""]]