more details on ikiwiki directives
[ikiwiki.git] / doc / plugins / creole.mdwn
1 [[!template id=plugin name=creole author="BerndZeimetz"]]
2 [[!tag type/format]]
3
4 This plugin allows ikiwiki to process pages written in
5 [WikiCreole](http://www.wikicreole.org/) format.
6 To use it, you need to have the [[!cpan Text::WikiCreole]] perl
7 module installed, enable the plugin, then files with the extention `.creole`
8 will be processed as creole.
9
10 The creole format is based on common elements across many different
11 wiki markup formats, so should be fairly easy to guess at. There is also a
12 [CheatSheet](http://www.wikicreole.org/wiki/CheatSheet).
13
14 Links are standard [[WikiLinks|ikiwiki/WikiLink]]. Links and
15 [[directives|ikiwiki/directive]] inside `{{{ }}}` blocks are still expanded,
16 since this happens before the creole format is processed. (You need to escape
17 them manually, via \\\[[directives]], the ~ escaping of creole doesn't work on
18 this.)
19
20 The standard ikiwiki [[WikiLinks|ikiwiki/WikiLink]] is almost the same as Creole link, except that creole uses \[[pagename|description]] while ikiwiki uses \[[description|pagename]].
21
22