| [FrontPage] [TitleIndex] [WordIndex]

# SyntaxReference

This page aims to introduce the most important elements of MoinMoin ``'s syntax at a glance, showing first the markup verbatim and then how it is rendered by the wiki engine. Additionally, you'll find links to the relative help pages. Please note that some of the features depend on your configuration.

# Table of Contents

    '''Contents''' (up to the 2nd level)
    [[TableOfContents(2)]]

Contents (up to the 2nd level)

Contents

1. Table of Contents
2. Headings
3. heading 1st level
   1. heading 2nd level
4. Text Formatting
5. Hyperlinks
   1. Internal Links
   2. External Links
   3. Avoid or Limit Automatical Linking
6. Blockquotes and Indentions
7. Lists
   1. Unordered Lists
   2. Ordered Lists
   3. Definition Lists
8. Horizontal Rules
9. Tables
   1. Tables
   2. Cell Width
   3. Spanning Rows and Columns
   4. Alignment of Cell Contents
   5. Coulored Table Cells
   6. HTML-like Options for Tables
10. Macros and Variables
    1. Macros
    2. Variables
11. Smileys and Icons
12. Source code
    1. Verbatim Display
    2. Syntax Highlighting

# Headings

see: HelpOnHeadlines

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

# heading 1st level

## heading 2nd level

### heading 3rd level

#### heading 4th level

##### heading 5th level

# Text Formatting

see: HelpOnFormatting

     * ''emphasized (italics)''
     * '''boldface'''
     * '''''bold italics'''''
     * `monospace`
     * {{{source code}}}
     * __underline__
     * ,,sub,,script
     * ^super^script
     * ~-smaller-~
     * ~+larger+~
     * --(strike through)--

- emphasized (italics)

- boldface

- bold italics

- `monospace`

- `source code`

- underline

- subscript

- superscript

- smaller

- larger

- strike through

# Hyperlinks

see: HelpOnLinking

## Internal Links

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

- FrontPage

- FrontPage

- HelpOnEditing/SubPages

- /SubPage

- ../SiblingPage

- named link

- #anchorname

- description

- wiki:Self:PageName#anchorname

- description

- Upload new attachment "filename.txt"

## External Links

     * http://moinmoin.wikiwikiweb.de/
     * [http://moinmoin.wikiwikiweb.de/]
     * [http://moinmoin.wikiwikiweb.de/ MoinMoin Wiki]
     * [http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png]
     * http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png
     * [http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png moinmoin.png]
     * MeatBall:InterWiki
     * wiki:MeatBall/InterWiki
     * [wiki:MeatBall/InterWiki]
     * [wiki:MeatBall/InterWiki InterWiki page on MeatBall]
     * [file://///servername/share/full/path/to/file/filename%20with%20spaces.txt link to file filename with spaces.txt]
     * user@example.com

- http://moinmoin.wikiwikiweb.de/

- http://moinmoin.wikiwikiweb.de/

- MoinMoin Wiki

- moinmoin.png

- InterWiki

- InterWiki

- wiki:MeatBall/InterWiki

- InterWiki page on MeatBall

- link to file filename with spaces.txt

- user@example.com

## Avoid or Limit Automatical Linking

     * Wiki''''''Name
     * Wiki``Name
     * !WikiName
     * WikiName''''''s
     * WikiName``s
     * `http://www.example.com`

- WikiName

- Wiki``Name

- WikiName

- WikiNames

- WikiName ``s

- `http://www.example.com`

# Blockquotes and Indentions

     indented text
      text indented to the 2nd level

- indented text
  - text indented to the 2nd level

# Lists

see: HelpOnLists

## Unordered Lists

     * item 1

     * item 2 (preceding white space)
      * item 2.1
       * item 2.1.1
     * item 3
      . item 3.1 (bulletless)
     . item 4 (bulletless)
      * item 4.1
       . item 4.1.1 (bulletless)

- item 1
- item 2 (preceding white space)
  - item 2.1
    - item 2.1.1
- item 3
  - item 3.1 (bulletless)
- item 4 (bulletless)
  - item 4.1
    - item 4.1.1 (bulletless)

## Ordered Lists

### with Numbers

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

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

### with Roman Numbers

     I. item 1
       i. item 1.1
       i. item 1.2
     I. item 2

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

### with Letters

     A. item A
       a. item A. a)
       a. item A. b)
     A. item B

1. item A
   1. item A. a)
   2. item A. b)
2. item B

## Definition Lists

     term:: definition
     object:: description 1
     :: description 2
     Action Items::
     :: First Item
     :: Second Item

term
  definition
object
  description 1
  description 2
Action Items
  First Item
  Second Item

# Horizontal Rules

see: HelpOnRules

    ----
    -----
    ------
    -------
    --------
    ---------
    ----------

# Tables

see: HelpOnTables

## Tables

    ||'''A'''||'''B'''||'''C'''||
    ||1      ||2      ||3      ||

A | B | C
1 | 2 | 3

## Cell Width

    ||minimal width ||<99%>maximal width ||

minimal width | maximal width

## Spanning Rows and Columns

    ||<|2> cell spanning 2 rows ||cell in the 2nd column ||
    ||cell in the 2nd column of the 2nd row ||
    ||<-2> cell spanning 2 columns ||
    ||||use empty cells as a shorthand ||

cell spanning 2 rows | cell in the 2nd column
cell in the 2nd column of the 2nd row
cell spanning 2 columns
use empty cells as a shorthand

## Alignment of Cell Contents

    ||<^|3> top (combined) ||<:99%> center (combined) ||<v|3> bottom (combined) ||
    ||<)> right ||
    ||<(> left ||

top (combined) | center (combined) | bottom (combined)
right
left

## Coulored Table Cells

    ||<#0000FF> blue ||<#00FF00> green    ||<#FF0000> red    ||
    ||<#00FFFF> cyan ||<#FF00FF> magenta  ||<#FFFF00> yellow ||

blue | green | red
cyan | magenta | yellow

## HTML-like Options for Tables

    ||A ||<rowspan="2"> like <|2> ||
    ||<bgcolor="#00FF00"> like <#00FF00> ||
    ||<colspan="2"> like <-2>||

A | like <|2>
like <#00FF00>
like <-2>

# Macros and Variables

## Macros

see: HelpOnMacros

- `[[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 `user@example.com` to users not logged in

## Variables

see: HelpOnVariables

- `@``SIG``@` inserts your login name and timestamp of modification

- `@``TIME``@` inserts date and time of modification

# Smileys and Icons

see: HelpOnSmileys

Markup | Display | Filename |  | Markup | Display | Filename |  | Markup | Display | Filename
`(!)` |  | `idea.png` |  | `(./)` |  | `checkmark.png` |  | `/!\` |  | `alert.png`
`:(` |  | `sad.png` |  | `:)` |  | `smile.png` |  | `:))` |  | `smile3.png`
`:-(` |  | `sad.png` |  | `:-)` |  | `smile.png` |  | `:-))` |  | `smile3.png`
`:-?` |  | `tongue.png` |  | `:D` |  | `biggrin.png` |  | `:\` |  | `ohwell.png`
`:o` |  | `redface.png` |  | `;)` |  | `smile4.png` |  | `;-)` |  | `smile4.png`
`<!>` |  | `attention.png` |  | `<:(` |  | `frown.png` |  | `>:>` |  | `devil.png`
`B)` |  | `smile2.png` |  | `B-)` |  | `smile2.png` |  | `X-(` |  | `angry.png`
`{*}` |  | `star_on.png` |  | `{1}` |  | `prio1.png` |  | `{2}` |  | `prio2.png`
`{3}` |  | `prio3.png` |  | `{OK}` |  | `thumbs-up.png` |  | `{X}` |  | `icon-error.png`
`{i}` |  | `icon-info.png` |  | `{o}` |  | `star_off.png` |  | `|)` |  | `tired.png`
`|-)` |  | `tired.png` |  |  |  |  |  |  |  |

# Source code

see: HelpOnParsers

## Verbatim Display

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

Remove spaces between "`{ { {`" and "`} } }`".

    def hello():
        print "Hello World!"

## Syntax Highlighting

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

Remove spaces between "`{ { {`" and "`} } }`".

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

2007-07-30 15:45