* Add wikitext markup plugin, which supports ".wiki" pages written in the
[ikiwiki.git] / doc / plugins / wikitext.mdwn
1 This plugin allows ikiwiki to process pages written in the original wiki
2 text format. To use it, you need to have the Text::WikiFormat perl module
3 installed, enable the plugin, then files with the extention `.wiki` will be
4 processed as wiki text.
5
6 Wiki formatting is very simple. An item wrapped in three single quotes is
7 strong. An item wrapped in two single quotes is emphasized. Any word with
8 multiple CapitalLetters (e. g., StudlyCaps) will become a link (standard
9 [[WikiLinks|WikiLink]] work too). Four or more
10 hyphen characters at the start of a line create a horizontal line.
11 Newlines turn into the appropriate tags. Headers are matching equals signs
12 around the header text -- the more signs, the lesser the header.
13
14 Lists are indented text, by one tab or four spaces. In unordered lists,
15 where each item has its own bullet point, each item needs a leading
16 asterisk and space. Ordered lists consist of items marked with combination
17 of one or more alphanumeric characters followed by a period and an optional
18 space. Any indented text without either marking is code, handled literally.
19 You can nest lists.
20
21 This plugin is included in ikiwiki, but is not enabled by default.