WikiCreole markup overview

Features currently not working with moin’s WikiCreole parser are marked with CREOLETODO.

Features currently not working with moin’s rst parser are marked with RSTTODO.

Headings

Markup:

= Level 1
== Level 2
=== Level 3
==== Level 4
===== Level 5
====== Level 6

Result:

Level 1

Intentionally not rendered as level 1 so it does not interfere with Sphinx’s indexing

Level 2

Level 3

Level 4

Level 5
Level 6

Notes:

Closing equals signs are optional and do not affect the output. Also, whitespace between the first word of the heading and the opening equals sign will not be shown in the output (ie. leading whitespace is stripped).

Text formatting

The following is a table of inline markup that can be used to format text in Creole.

Markup Result
**Bold Text** Bold text
//Italic Text// Italic Text
//**Bold and Italic**// Bold and Italic
__Underline__ Underline
{{{Monospace}}} Monospace
First line\\Second line
First line
Second line

RSTTODO: Restructured Text line blocks are not working in Moin2

Images and Transclusions

Markup Comment
{{example.png}} Embed example.png inline
{{example.png|Alt text}} Embed example.png inline or display “Alt text” if not available
{{ItemName}} Transclude (embed the contents of) ItemName inline.
{{/SubItem}} Transclude SubItem inline.

Paragraphs

Markup:

You can leave an empty line to start a new paragraph.

Single breaks are ignored.
To force a line break, use <<BR>> or \\.

Result:

You can leave an empty line to start a new paragraph.

Single breaks are ignored. To force a line break, use
or
.

RSTTODO: reStructuredText line blocks are not working in Moin2

Horizontal rules

Markup:

A horizontal rule can be added by typing four dashes.

----

This text will be displayed below the rule.

Result:

A horizontal rule can be added by typing four dashes.


This text will be displayed below the rule.

Preformatted text

Markup:

{{{
This text will [[escape]] **special** WikiCreole //markup//
    It will also preserve indents

And whitespace.
}}}
~[[This text will not be a link, because it uses the tilde (~) escape character]]

Result:

This text will [[escape]] **special** WikiCreole //markup//
    It will also preserve indents

And whitespace.

[[This text will not be a link, because it uses the tilde (~) escape character]]

Notes:

This tilde character (~) makes the parser ignore the character following it, which can be used to prevent links from appearing as links or prevent bold text from appearing as bold. For example “~**Not bold~**” would output “**Not bold**”).

Syntax Highlighting

Markup:

{{{
#!python
#Python syntax highlighting
import this

def spam():
    print('Spam, glorious spam!')

spam()
}}}

Result:

#Python syntax highlighting
import this

def spam():
    print('Spam, glorious spam!')

spam()

CREOLETODO:The use of syntax highlighting currently crashes moin.

Lists

Ordered lists

Ordered lists are formed of lines that start with number signs (#). The number of ‘#’ signs at the beginning of a line determines the current level.

Markup:

# First item
# Second item
## First item (second level)
## Second item (second level)
### First item (third level)
# Third item

Result:

  1. First item
  2. Second item
  1. First item (second level)
  2. Second item (second level)
  1. First item (third level)
  1. Third item

Unordered lists

Markup:

* List item
* List item
** List item (second level)
*** List item (third level)
* List item

Result:

  • List item
  • List item
  • List item (second level)
  • List item (third level)
  • List item

Mixed lists

Markup:

# First item
# Second item
** Bullet point one
** Bullet point two
# Third item
# Fourth item

Result:

  1. First item
  2. Second item
  • Bullet point one
  • Bullet point two
  1. Third item
  2. Fourth item

Tables

Markup:

|= Header one |= Header two |
| Cell one    | Cell two
| Cell three  | Cell four   |

Result:

Header one Header two
Cell one Cell two
Cell three Cell four

Notes:

Table cells start with a pipe symbol (|), and header cells start with a pipe symbol and equals sign (|=). The closing pipe symbol at the end of a row is optional.

Macros

Macros are extensions to standard Creole markup that allow developers to add extra features. The following is a table of MoinMoin’s Creole macros.

Markup Comment
<<Anchor(anchorname)>> Inserts an anchor named “anchorname”
<<BR>> Inserts a forced linebreak
<<Date()>> Inserts current date, or unix timestamp or ISO 8601 date
<<DateTime()>> Inserts current datetime, or unix timestamp or ISO 8601
<<GetText(Settings)>> Loads I18N texts, Einstellungen if browser is set to German
<<GetVal(WikiDict,var1)>> Loads var1 value from metadata of item named WikiDict
<<FootNote(Note here)>> Inserts a footnote saying “Note here”
<<Include(ItemOne/SubItem)>> Embeds the contents of ItemOne/SubItem inline
<<MailTo(user AT example DOT org, write me)>> If the user is logged in this macro will display user@example.org, otherwise it will display the obfuscated email address supplied (user AT example DOT org) The second parameter containing link text is optional.
<<PageNameList()>> Inserts names of all wiki items
<<RandomItem(3)>> Inserts names of 3 random items
<<TableOfContents(2)>> Shows a table of contents up to level 2
<<Verbatim(`same` __text__)>> Inserts text as entered