*********************
HelpOnMoinWikiSyntax
*********************
This page aims to introduce the most important elements of <MoinMoin.txt>'''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.
Inhaltsverzeichnis
1. Headings and table of contents
2. Text Formatting
3. Hyperlinks
1. Internal Links
2. External Links
3. Avoid or Limit Automatic Linking
4. Drawings
1. TWikiDraw
2. AnyWikiDraw
5. Blockquotes and Indentations
6. Lists
1. Unordered Lists
2. Ordered Lists
1. with Numbers
2. with Roman Numbers
3. with Letters
3. Definition Lists
7. Horizontal Rules
8. Tables
1. Tables
2. Cell Width
3. Spanning Rows and Columns
4. Alignment of Cell Contents
5. Coloured Table Cells
6. HTML-like Options for Tables
9. Macros and Variables
1. Macros
2. Variables
10. Smileys and Icons
11. Parsers
1. Verbatim Display
2. Syntax Highlighting
3. Using the wiki parser with css classes
12. Admonitions
13. Comments
Headings and table of contents
==============================
/*see:* <HelpOnHeadlines.txt>/
---%<-------------------------------------------------------------------------
Table of contents:
<<TableOfContents()>>
Table of contents (up to 2nd level headings only):
<<TableOfContents(2)>>
= heading 1st level =
== heading 2nd level ==
=== heading 3rd level ===
==== heading 4th level ====
===== heading 5th level =====
====== no heading 6th level ======
---%<-------------------------------------------------------------------------
Table of contents:
Inhaltsverzeichnis
1. heading 1st level
1. heading 2nd level
1. heading 3rd level
1. heading 4th level
1. heading 5th level
2. no heading 6th level
Table of contents (up to 2nd level headings only):
Inhaltsverzeichnis
1. heading 1st level
1. heading 2nd level
heading 1st level
=================
heading 2nd level
-----------------
heading 3rd level
-----------------
heading 4th level
-----------------
heading 5th level
-----------------
no heading 6th level
--------------------
Text Formatting
===============
/*see:* <HelpOnFormatting.txt>/
+-----------------+--------------+
| *Markup* | *Result* |
+-----------------+--------------+
| '''italic''' | /italic/ |
+-----------------+--------------+
| ''''bold'''' | *bold* |
+-----------------+--------------+
| '`monospace`' | 'monospace' |
+-----------------+--------------+
| '{{{code}}}' | 'code' |
+-----------------+--------------+
| '__underline__' | _underline_ |
+-----------------+--------------+
| '^super^script' | ^superscript |
+-----------------+--------------+
| ',,sub,,script' | _sub_script |
+-----------------+--------------+
| '~-smaller-~' | smaller |
+-----------------+--------------+
| '~+larger+~' | larger |
+-----------------+--------------+
| '--(stroke)--' | __stroke__ |
+-----------------+--------------+
Hyperlinks
==========
/*see:* <HelpOnLinking.txt>/
Internal Links
--------------
+---------------------------------------+-------------------------------------+
| *Markup* | *Result* |
+---------------------------------------+-------------------------------------+
| 'FrontPage' | <FrontPage.txt> |
+---------------------------------------+-------------------------------------+
| '[[FrontPage]]' | <FrontPage.txt> |
+---------------------------------------+-------------------------------------+
| 'HelpOnEditing/SubPages' | <HelpOnEditing.SubPages.txt> |
+---------------------------------------+-------------------------------------+
| '/SubPage' | </SubPage> |
| | [HelpOnMoinWikiSyntax.SubPage.txt] |
+---------------------------------------+-------------------------------------+
| '../SiblingPage' | <../SiblingPage> [SiblingPage.txt] |
+---------------------------------------+-------------------------------------+
| '[[FrontPage|named link]]' | <named link> [FrontPage.txt] |
+---------------------------------------+-------------------------------------+
| '[[#anchorname]]' | <#anchorname> |
| | [HelpOnMoinWikiSyntax.txt] |
+---------------------------------------+-------------------------------------+
| '[[#anchorname|description]]' | <description> |
| | [HelpOnMoinWikiSyntax.txt] |
+---------------------------------------+-------------------------------------+
| '[[PageName#anchorname]]' | <PageName#anchorname> [PageName.txt]|
+---------------------------------------+-------------------------------------+
| '[[PageName#anchorname|description]]' | <description> [PageName.txt] |
+---------------------------------------+-------------------------------------+
| '[[attachment:filename.txt]]' | [attachment:filename.txt] |
+---------------------------------------+-------------------------------------+
External Links
--------------
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| *Markup* | *Result* |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| 'http://moinmo.in/' | http://moinmo.in/ |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| '[[http://moinmo.in/]]' | http://moinmo.in/ |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| '[[http://moinmo.in/|MoinMoin Wiki]]' | MoinMoin Wiki [http://moinmo.in/] |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| '[[http://static.moinmo.in/logos/moinmoin.png]]' | http://static.moinmo.in/logos/moinmoin.png |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| '{{http://static.moinmo.in/logos/moinmoin.png}}' | http://static.moinmo.in/logos/moinmoin.png |
| | [http://static.moinmo.in/logos/moinmoin.png] |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| '[[http://static.moinmo.in/logos/moinmoin.png|moinmoin.png]]' | moinmoin.png [http://static.moinmo.in/logos/moinmoin.png] |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| 'MeatBall:InterWiki' | InterWiki [MeatBall:InterWiki] |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| '[MeatBall:InterWiki|InterWiki page on MeatBall]]' | InterWiki page on MeatBall [MeatBall:InterWiki] |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| '[[file://///server/share/filename%20with%20spaces.txt|link to| link to file filename with spaces.txt |
| filename.txt]]' | [file://///servername/share/full/path/to/file/filename%20with%20spaces.txt] |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
| 'user@example.com' | user@example.com |
+---------------------------------------------------------------+-----------------------------------------------------------------------------+
Avoid or Limit Automatic Linking
--------------------------------
+----------------------------------------+----------------------------------+
| *Markup* | *Result* |
+----------------------------------------+----------------------------------+
| 'Wiki''''''Name' | Wiki**Name |
+----------------------------------------+----------------------------------+
| 'Wiki''Name' | Wiki''Name |
+----------------------------------------+----------------------------------+
| '!WikiName' | WikiName |
+----------------------------------------+----------------------------------+
| 'WikiName''''''s' | <WikiName.txt>**s |
+----------------------------------------+----------------------------------+
| 'WikiName``s' | <WikiName.txt>''s |
+----------------------------------------+----------------------------------+
| 'http://www.example.com' | 'http://www.example.com' |
+----------------------------------------+----------------------------------+
| '[[http://www.example.com/]]notlinked' | http://www.example.com/notlinked |
+----------------------------------------+----------------------------------+
Drawings
========
/*see:* <HelpOnDrawings.txt>/
TWikiDraw
---------
* [drawing:myexample.tdraw]
AnyWikiDraw
-----------
* [drawing:myexample.adraw]
Blockquotes and Indentations
============================
---%<-------------------------------------------------------------------------
indented text
text indented to the 2nd level
---%<-------------------------------------------------------------------------
* indented text
* text indented to the 2nd level
Lists
=====
/*see:* <HelpOnLists.txt>/
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
---%<-------------------------------------------------------------------------
term:
definition
object:
:
description 1
:
description 2
Horizontal Rules
================
/*see:* <HelpOnRules.txt>/
---%<-------------------------------------------------------------------------
----
-----
------
-------
--------
---------
----------
---%<-------------------------------------------------------------------------
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
===============================================================================
*******************************************************************************
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Tables
======
/*see:* <HelpOnTables.txt>/
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 |
+----------------+-------------------+-------------------+
Coloured 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.txt>/
* '<<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.txt>/
* '@''SIG''@' inserts your login name and timestamp of modification
* '@''TIME''@' inserts date and time of modification
Smileys and Icons
=================
':(':(':)':)'B)'B)':))':))';)';)'/!\'/!\'<!>'<!>'(!)'(!)':-?':-?':\':\'>:>'>:>'|)'|)':-(':-(':-)':-)'B-)'B-)':-))':-))';-)';-)'|-)'|-)'(./)'(./)'{OK}'{OK}'{X}'{X}'{i}'{i}'{1}'{1}'{2}'{2}'{3}'{3}'{*}'{*}'{o}'{o}
NotationAnzeigeNotationAnzeigeNotationAnzeigeNotationAnzeige/*see:* <HelpOnSmileys.txt>/ 'X-('X-(':D':D '<:('<:(':o':o
+----+----+----+----+----+----+----+----+----+----+----+
| ** | ** | ** | ** | ** | ** | ** | ** | ** | ** | ** |
+----+----+----+----+----+----+----+----+----+----+----+
| | | | | | | | | | | |
+----+----+----+----+----+----+----+----+----+----+----+
| | | | | | | | | | | |
+----+----+----+----+----+----+----+----+----+----+----+
| | | | | | | | | | | |
+----+----+----+----+----+----+----+----+----+----+----+
| | | | | | | | | | | |
+----+----+----+----+----+----+----+----+----+----+----+
| | | | | | | | | | | |
+----+----+----+----+----+----+----+----+----+----+----+
| | | | | | | | | | | |
+----+----+----+----+----+----+----+----+----+----+----+
| | | | | | | | | | | |
+----+----+----+----+----+----+----+----+----+----+----+
| | | | | | | | | | | |
+----+----+----+----+----+----+----+----+----+----+----+
Parsers
=======
/*see:* <HelpOnParsers.txt>/
Verbatim Display
----------------
---%<-------------------------------------------------------------------------
{{{
def hello():
print "Hello World!"
}}}
---%<-------------------------------------------------------------------------
---%<-------------------------------------------------------------------------
def hello():
print "Hello World!"
---%<-------------------------------------------------------------------------
Syntax Highlighting
-------------------
---%<-------------------------------------------------------------------------
{{{#!highlight python
def hello():
print "Hello World!"
}}}
---%<-------------------------------------------------------------------------
---CodeArea-------------------------------------------------------------------
def hello(): 1
print "Hello World!" 2
---CodeArea-------------------------------------------------------------------
Using the wiki parser with css classes
--------------------------------------
---%<-------------------------------------------------------------------------
{{{#!wiki red/solid
This is wiki markup in a '''div''' with __css__ `class="red solid"`.
}}}
---%<-------------------------------------------------------------------------
This is wiki markup in a *div* with _css_ 'class="red solid"'.
Admonitions
===========
/*see:* <HelpOnAdmonitions.txt>/
---%<-------------------------------------------------------------------------
{{{#!wiki caution
'''Don't overuse admonitions'''
Admonitions should be used with care. A page riddled with admonitions will look
restless and will be harder to follow than a page where admonitions are used
sparingly.
}}}
---%<-------------------------------------------------------------------------
*Don't overuse admonitions*
Admonitions should be used with care. A page riddled with admonitions will look
restless and will be harder to follow than a page where admonitions are used
sparingly.
Comments
========
/*see:* <HelpOnComments.txt>/
---%<-------------------------------------------------------------------------
Click on "Comments" in edit bar to toggle the /* comments */ visibility.
---%<-------------------------------------------------------------------------
Click on "Comments" in edit bar to toggle the comments visibility.
---%<-------------------------------------------------------------------------
{{{#!wiki comment/dotted
This is a wiki parser section with class "comment dotted" (see HelpOnParsers).
Its visibility gets toggled the same way.
}}}
---%<-------------------------------------------------------------------------
This is a wiki parser section with class "comment dotted" (see
<HelpOnParsers.txt>).
Its visibility gets toggled the same way.