= Creole Plugin plugin Creole Markup for DokuWiki
https://www.dokuwiki.org/plugin:creole
very close to the syntax used by DokuWiki.
Only those elements differ:
- Linebreaks (dokuwiki linebreaks are correct in creole 1.0)
- Tables (optional ending pipe not yet supported – I'm working on a new version)
- Subscript (since Creole 1.0, see http://www.wikicreole.org/wiki/CreoleAdditions)
- Superscript (since Creole 1.0, see http://www.wikicreole.org/wiki/CreoleAdditions)
- Monospace (since Creole 1.0, see http://www.wikicreole.org/wiki/CreoleAdditions)
This plugin will interpret Creole elements that are not understood by DokuWiki. If the markup collides (as with the header level order), by default DokuWiki's standard markup takes precedence.1) With the exception of the changed behaviour for linebreaks, all your existing wiki pages will look the same.
If you use this plugin to support the Creole syntax, you might want to list your wiki at http://www.wikicreole.org/wiki/WikisSupportingCreole
Listblock
Creole style ordered and unordered lists use a slightly different markup:
Creole (and DokuWiki):
* Item 1 ( * Item 1 ) ** Item 1.1 ( * Item 1.1 ) * Item 2 ( * Item 2 )
Output:
- Item 1
- Item 1.1
- Item 2
Creole (and DokuWiki):
# Item 1 ( - Item 1 ) ## Item 1.1 ( - Item 1.1 ) # Item 2 ( - Item 2 )
Output:
- Item 1
- Item 1.1
- Item 2
Reverse Headings
In Creole, the header ordering is just the other way round. If you have set the markup precedence option to DokuWiki (default), this plugin will assume headers are DokuWiki style if there are equal signs after the title. In Creole, closing (right-side) equal signs are optional. So if you omit them, headers are interpreted as Creole.
Creole (and DokuWiki):
= Level 1 (====== Level 1 ======) == Level 2 (===== Level 2 ===== ) === Level 3 (==== Level 3 ==== ) ==== Level 4 (=== Level 4 === ) ===== Level 5 (== Level 5 == )
Output:
Level 1
Level 2
Level 3
Level 4
Level 5
Linebreaks
DokuWiki and Creole 1.0 do not care about (single) line breaks. Creole 0.3, however, does treat line breaks in the source as line breaks in the output. This component is mainly the same as Chris Smith's linebreak plugin. Thanks!
Previous versions of this plugin matched Creole 0.3 and so linebreaks were kept as linebreaks. From now on, linebreaks will be replaced by whitespace to match Creole 1.0. The config option linebreak
can be set to Linebreak
to switch back to the Creole 0.3 behaviour and keep the linebreaks.
Preformatted
Creole:
{{{ //This// does **not** get [[formatted]] }}} Some examples of markup are: {{{** <i>this</i> ** }}}
Output:
//This// does **not** get [[formatted]]
Some examples of markup are: ** <i>this</i> **
Tables
Creole (and DokuWiki):
|Heading Col 1 |Heading Col 2 | (^Heading Col 1 ^Heading Col 2 ^) |Cell 1.1 |Cell 1.2 | (|Cell 1.1 |Cell 1.2 |) |Cell 2.1 |Cell 2.2 | (|Cell 2.1 |Cell 2.2 |)
Output:
Heading Col 1 | Heading Col 2 |
Cell 1.1 | Cell 1.2 |
Cell 2.1 | Cell 2.2 |
The difference to DokuWiki is that in Creole there's no special markup for header cells and no cell alignment. In turn, in Creole the ending pipe is optional.
Subscript
Creole:
This is ,,subscripted,, text.
Output:
This is subscripted text.
Superscript
Creole:
This is ^^superscripted^^ text.
Output:
This is superscripted text.
Monospace
Creole:
This is ##monospace## text.
Output:
This is monospace
text.