HelpForUsers > HelpOnEditing > HelpOnProcessingInstructions > HelpOnCreoleSyntax

Creole ¹ is a new wiki markup language - its goal is to become the one common wiki syntax and enable better exchange of content between different wiki engines.

This page introduces you to the most important elements of the creole syntax, showing first the markup verbatim and then how it is rendered by the wiki engine. Please note that some of the features depend on your configuration.

BTW: This very page is written in creole syntax!

Table of Contents

**Contents** (up to the 2nd level)
<<TableOfContents(2)>>

Contents (up to the 2nd level)

Headings

<<TableOfContents()>>

= heading 1st level =
== heading 2nd level ==
=== heading 3rd level ===
==== heading 4th level ====
===== heading 5th level =====

heading 1st level

1. heading 2nd level

1.1. heading 3rd level

1.1.1. heading 4th level

1.1.1.1. heading 5th level

Text Formatting

* //emphasized (italics)//
* **boldface**
* **//bold italics//**, //**italics bold**//
* {{{monospace}}}

• emphasized (italics)
• boldface
• bold italics, italics bold
• monospace

Hyperlinks

1. Internal Links

* [[FrontPage]]
* [[HelpOnEditing/SubPages]]
* [[/SubPage]]
* [[../SiblingPage]]
* [[FrontPage|named link]]
* [[#anchorname]]
* [[#anchorname|description]]
* [[PageName#anchorname]]
* [[PageName#anchorname|description]]
* [[attachment:filename.txt]]

• FrontPage
• HelpOnEditing/SubPages
• /SubPage
• ../SiblingPage
• named link
• #anchorname
• description
• PageName#anchorname
• description
• attachment:filename.txt

2. External Links

* http://moinmo.in/
* [[http://moinmo.in/]]
* [[http://moinmo.in/|MoinMoin Wiki]]
* [[http://static.moinmo.in/logos/moinmoin.png]]
* {{http://static.moinmo.in/logos/moinmoin.png}}
* [[http://static.moinmo.in/logos/moinmoin.png|moinmoin.png]]
* [[MeatBall:InterWiki|InterWiki page on MeatBall]]
* [[file://///servername/share/full/path/to/file/filename%20with%20spaces.txt|link to file filename with spaces.txt]]
* [[mailto:[email protected]]]

• http://moinmo.in/
• http://moinmo.in/
• MoinMoin Wiki
• http://static.moinmo.in/logos/moinmoin.png
• 
• moinmoin.png
• InterWiki page on MeatBall
• link to file filename with spaces.txt
• mailto:[email protected]

3. Avoid or Limit Automatic Linking

 * {{{http://www.example.com}}}
 * ~http://www.example.com/

• http://www.example.com
• http://www.example.com/

Drawings

{{drawing:myexample}}

Lists

1. Unordered Lists

* item 1

* item 2 (preceding white space)
** item 2.1
*** item 2.1.1
* item 3

• item 1

• item 2 (preceding white space)
  • item 2.1
    • item 2.1.1
• item 3

2. Ordered Lists

# item 1
## item 1.1
## item 1.2
# item 2

1. item 1
   1. item 1.1
   2. item 1.2
2. item 2

Horizontal Rule

----

Tables

|=A |=B |=C |
| 1 | 2 | 3 |

Other

forced\\linebreak

forced
linebreak

Macros and Variables

1. Macros

• <<Anchor(anchorname)>> inserts a link anchor anchorname
• <<BR>> inserts a hard line break
• <<FootNote(Note)>> inserts a footnote saying Note
• <<Include(HelpOnMacros/Include)>> inserts the contents of the page HelpOnMacros/Include inline
• <<MailTo(user AT example DOT com)>> obfuscates the email address [email protected] to users not logged in

2. Variables

• @SIG@ inserts your login name and timestamp of modification
• @TIME@ inserts date and time of modification

Parsers

1. Verbatim Display

{{{
def hello():
    print "Hello World!"
}}}

def hello():
    print "Hello World!"

2. Syntax Highlighting

{{{
#!python
def hello():
    print "Hello World!"
}}}

   1 def hello():
   2     print "Hello World!"

See also CreoleCheatCheet (PNG image)