summaryrefslogtreecommitdiff
path: root/doc/plugins/creole.mdwn
blob: 6961e8d1d2e7755898c893b0d7032d17fa697f94 (plain)

[[!template id=plugin name=creole author="BerndZeimetz"]] [[!tag type/format]]

This plugin allows ikiwiki to process pages written in WikiCreole format. To use it, you need to have the [[!cpan Text::WikiCreole]] perl module installed, enable the plugin, then files with the extention .creole will be processed as creole.

The creole format is based on common elements across many different wiki markup formats, so should be fairly easy to guess at. There is also a CheatSheet.

Links are standard [[WikiLinks|ikiwiki/WikiLink]]. Links and [[directives|ikiwiki/directive]] inside {{{ }}} blocks are still expanded, since this happens before the creole format is processed. (You need to escape them manually, via \[[directives]], the ~ escaping of creole doesn't work on this.)

The standard ikiwiki [[WikiLinks|ikiwiki/WikiLink]] is almost the same as Creole link, except that creole uses [[pagename|description]] while ikiwiki uses [[description|pagename]].