Differences between revisions 4 and 9 (spanning 5 versions)
Revision 4 as of 2009-01-21 17:03:48
Size: 4668
Editor: 18913042242
Comment:
Revision 9 as of 2009-07-09 11:28:13
Size: 8877
Editor: PaulBoddie
Comment: Removed superfluous syntax highlighting section.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#pragma section-numbers off
##language:en

{{{
#pragma section-numbers off
#acl All:admin,read,write,delete,revert
##language:en
}}}

This page tries to use each supported markup element at least once.

{{{
'''Index'''
[[TableOfContents(2)]]
}}}
'''Index'''
## Please edit system and help pages ONLY in the master wiki!
## For more information, please see MoinMoin:MoinDev/Translation.
## page was renamed from SyntaxReference
##master-page:Unknown-Page
##master-date:Unknown-Date
#acl -All:write Default
#format wiki
#language en

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)
Line 18: Line 16:

= Headers =
== Header 2 ==
=== Header 3 ===
==== Header 4 ====
===== Header 5 =====

= Font styles =
{{{
^, `typewriter` and {{{typewriter}}}.

== Syntax Hilighting ==
 {{{
#!python
# python code
print code.colorize("abc", 1 + 1)
}}}

= Smileys =
<<ShowSmileys>>
}}}
'''Contents''' (up to the 2nd level)
<<TableOfContents(2)>>

= 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__
 * ,,sub,,script
 * ^super^script
 * ~-smaller-~
 * ~+larger+~
 * --(strike through)--
Line 40: Line 63:
== Internal ==
{{{
 * MoinMoin
 * MoinMoin/TextFormatting
 * MoinMoin/InstallDocs
 * ../InstallDocs
'''''see:''' HelpOnLinking''
== Internal Links ==
{{{
 * FrontPage
 * [[FrontPage]]
 * HelpOnEditing/SubPages
Line 47: Line 70:
 * Self:InterWiki
}}}
 * MoinMoin
 * MoinMoin/TextFormatting
 * MoinMoin/InstallDocs
 * ../InstallDocs
 * ../SiblingPage
 * [[FrontPage|named link]]
 * [[#anchorname]]
 * [[#anchorname|description]]
 * [[PageName#anchorname]]
 * [[PageName#anchorname|description]]
 * [[attachment:filename.txt]]
}}}
 * FrontPage
 * [[FrontPage]]
 * HelpOnEditing/SubPages
Line 54: Line 82:
 * InterWiki

{{{
[#anchorname Anchor Link]
}}}
[[#anchorname|Anchor Link]]

== External ==
{{{
 * http://moin.sourceforge.net/
 * [http://moin.sourceforge.net/]
 * [http://moin.sourceforge.net/ MoinMoin Sourceforge Homepage]
 * [^http://moin.sourceforge.net/ MoinMoin Sourceforge Homepage - in new window]
 * [http://moin.sourceforge.net/moinmoin.gif]
 * http://moin.sourceforge.net/moinmoin.gif
 * [http://moin.sourceforge.net/moinmoin.gif moinmoin.gif]
 * MeatBall:InterWiki
 * wiki:MeatBall/InterWiki
 * [wiki:MeatBall/InterWiki]
 * [wiki:MeatBall/InterWiki InterWiki page on MeatBall]
 * [file://servername/full/path/to/file/filename%20with%20spaces.txt Click here to read filename with spaces.txt]
 * jh@web.de
}}}
 * http://moin.sourceforge.net/
 * [[http://moin.sourceforge.net/]]
 * [[http://moin.sourceforge.net/|MoinMoin Sourceforge Homepage]]
 * [^http://moin.sourceforge.net/ MoinMoin Sourceforge Homepage - in new window]
 * [[http://moin.sourceforge.net/moinmoin.gif]]
 * {{http://moin.sourceforge.net/moinmoin.gif}}
 * [[http://moin.sourceforge.net/moinmoin.gif|moinmoin.gif]]
 * MeatBall:InterWiki
 * MeatBall:InterWiki
 * ../SiblingPage
 * [[FrontPage|named link]]
 * [[#anchorname]]
 * [[#anchorname|description]]
 * [[PageName#anchorname]]
 * [[PageName#anchorname|description]]
 * [[attachment:filename.txt]]

== 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]]
Line 88: Line 100:
 * [[file://servername/full/path/to/file/filename%20with%20spaces.txt|Click here to read filename with spaces.txt]]
 * jh@web.de
== Escaping WikiNames ==
{{{
Wiki''''''Name
Wiki``Name
}}}
Wiki''''''Name
Wiki``Name

= Blockquote =
{{{
 This is indented
  Even more
}}}
 This is indented
  Even more

= Bullet list =
 * [[file://///servername/share/full/path/to/file/filename%20with%20spaces.txt|link to file filename with spaces.txt]]
 * user@example.com
}}}
 * 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
 * [[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

== Avoid or Limit Automatic Linking ==
{{{
 * Wiki''''''Name
 * Wiki``Name
 * !WikiName
 * WikiName''''''s
 * WikiName``s
 * `http://www.example.com`
 * [[http://www.example.com/]]notlinked
}}}
 * Wiki''''''Name
 * Wiki``Name
 * !WikiName
 * WikiName''''''s
 * WikiName``s
 * `http://www.example.com`
 * [[http://www.example.com/]]notlinked

= Drawings =
 {{drawing:myexample}}

= Blockquotes and Indentations =
{{{
 indented text
  text indented to the 2nd level
}}}
 indented text
  text indented to the 2nd level

= Lists =
'''''see:''' HelpOnLists''
== Unordered Lists ==
Line 110: Line 149:
 * item 2, with gap  * item 2 (preceding white space)
  * item 2.1
   * item 2.1.1
Line 112: Line 153:
   * item 3.1   . item 3.1 (bulletless)
 . item 4 (bulletless)
  * item 4.1
   . item 4.1.1 (bulletless)
Line 116: Line 160:
 * item 2, with gap  * item 2 (preceding white space)
  * item 2.1
   * item 2.1.1
Line 118: Line 164:
   * item 3.1
= Numbered list =
  . item 3.1 (bulletless)
 . item 4 (bulletless)
  * item 4.1
   . item 4.1.1 (bulletless)

== Ordered Lists ==
=== with Numbers ===
Line 122: Line 173:
   i. item 1
   i. item 2
   1. item 1.1
   1. item 1.2
 1
. item 2
Line 126: Line 178:
   i. item 1
   i. item 2
{{{
   1. item 1.1
   1. item 1.2
Line 130: Line 181:
   a. item 1
   a. item 2
}}}
 1. item 2
   a. item 1
   a. item 2
= Decriptions + Definitions =
{{{
 Term:: Decription
 Label:: Definition
}}}
 Term:: Decription
 Label:: Definition
= Code display =
 {{{ {{{
line 1
    indented 4 characters
}\}} }}}
 {{{
line 1
    indented 4 characters
}}}

= Tables =
== General table layout and HTML like options ==
{{{
 ||||||<tablewidth="80%">'''Heading'''||
 ||cell 1||cell2||cell 3||
 ||<rowspan=2> spanning rows||||<bgcolor='#E0E0FF'> spanning 2 columns||
 ||<rowbgcolor="#FFFFE0">cell2||cell 3||
}}}
 ||||||<tablewidth="80%">'''Heading'''||
 ||cell 1||cell2||cell 3||
 ||<rowspan=2> spanning rows||||<bgcolor='#E0E0FF'> spanning 2 columns||
 ||<rowbgcolor="#FFFFE0">cell2||cell 3||

== Cell width ==
{{{
 || narrow ||<:99%> wide ||
}}}
 || narrow ||<:99%> wide ||

== Spanning rows and columns ==
{{{
 ||<|2> 2 rows || row 1 ||
 || row 2 ||
 ||<-2> row 3 over 2 columns ||
}}}
 ||<|2> 2 rows || row 1 ||
 || row 2 ||
 ||<-2> row 3 over 2 columns ||

== Alignment ==
{{{
 ||<(> left ||<^|3> top ||<v|3> bottom ||
 ||<:> centered ||
 ||<)> right ||
}}}
 ||<(> left ||<^|3> top ||<v|3> bottom ||
 ||<:> centered ||
 ||<)> right ||

== Colors ==
{{{
 ||<#FF8080> red ||<#80FF80> green ||<#8080FF> blue ||
}}}
 ||<#FF8080> red ||<#80FF80> green ||<#8080FF> blue ||

== CSV Tables ==
{{{
#!CSV -2
Col1;Col2;Col3;Col4
1;2;3;4
a;b;c;d
}}}
 {{{#!CSV -2
Col1;Col2;Col3;Col4
1;2;3;4
a;b;c;d
}}}

= Rules =
{{{
--- (not a rule)

=== with Roman Numbers ===
{{{
 I. item 1
   i. item 1.1
   i. item 1.2
 I. item 2
}}}
 I. item 1
   i. item 1.1
   i. item 1.2
 I. item 2

=== with Letters ===
{{{
 A. item A
   a. item A. a)
   a. item A. b)
 A. item B
}}}
 A. item A
   a. item A. a)
   a. item A. b)
 A. item B

== Definition Lists ==
{{{
 term:: definition
 object::
 :: description 1
 :: description 2
}}}
 term:: definition
 object::
 :: description 1
 :: description 2

= Horizontal Rules =
'''''see:''' HelpOnRules''
{{{
Line 221: Line 228:
-------------------------------------------- (not thicker than 10)
}}}
--- (not a rule)
}}}
Line 231: Line 236:
-------------------------------------------- (not thicker than 10)

= Macros =
{{{
[[Anchor(anchorname)]]
'''[[PageCount]]''' pages
[[RandomPage]]
}}}
<<Anchor(anchorname)>>
'''<<PageCount>>''' pages
<<RandomPage>>

= 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 ||<99%>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 ||
}}}
||<|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 ||

== Alignment of Cell Contents ==
{{{
||<^|3> top (combined) ||<:99%> center (combined) ||<v|3> bottom (combined) ||
||<)> right ||
||<(> left ||
}}}
||<^|3> top (combined) ||<:99%> center (combined) ||<v|3> bottom (combined) ||
||<)> right ||
||<(> left ||

== Coloured Table Cells ==
{{{
||<#0000FF> blue ||<#00FF00> green ||<#FF0000> red ||
||<#00FFFF> cyan ||<#FF00FF> magenta ||<#FFFF00> yellow ||
}}}
||<#0000FF> blue ||<#00FF00> green ||<#FF0000> red ||
||<#00FFFF> cyan ||<#FF00FF> magenta ||<#FFFF00> yellow ||

== HTML-like Options for Tables ==
{{{
||A ||<rowspan="2"> like <|2> ||
||<bgcolor="#00FF00"> like <#00FF00> ||
||<colspan="2"> like <-2>||
}}}
||A ||<rowspan="2"> like <|2> ||
||<bgcolor="#00FF00"> like <#00FF00> ||
||<colspan="2"> 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''
<<ShowSmileys>>

= Parsers =
'''''see:''' HelpOnParsers''
== Verbatim Display ==
{{{{
{{{
def hello():
    print "Hello World!"
}}}
}}}}

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

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

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

== Using the wiki parser with css classes ==
{{{{
{{{#!wiki red/solid
This is wiki markup in a '''div''' with __css__ `class="red solid"`.
}}}
}}}}

{{{#!wiki red/solid
This is wiki markup in a '''div''' with __css__ `class="red solid"`.
}}}

= Admonitions =
'''''see:''' HelpOnAdmonitions''

{{{{
{{{#!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 then a page where admonitions are used sparingly.
}}}
}}}}

{{{#!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 then a page where admonitions are used sparingly.
}}}


= Comments =
'''''see:''' HelpOnComments''

{{{
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.
}}}
}}}}

{{{#!wiki comment/dotted
This is a wiki parser section with class "comment dotted" (see HelpOnParsers).

Its visibility gets toggled the same way.
}}}

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)

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

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

 * 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
 * [[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

Avoid or Limit Automatic Linking

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

Drawings

  • myexample.tdraw

Blockquotes and Indentations

 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
term
definition
object
description 1
description 2

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

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

  • <<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 Markup Display Markup Display Markup Display
X-( X-( :D :D <:( <:( :o :o
:( :( :) :) B) B) :)) :))
;) ;) /!\ /!\ <!> <!> (!) (!)
:-? :-? :\ :\ >:> >:> |) |)
:-( :-( :-) :-) B-) B-) :-)) :-))
;-) ;-) |-) |-) (./) (./) {OK} {OK}
{X} {X} {i} {i} {1} {1} {2} {2}
{3} {3} {*} {*} {o} {o}    

Parsers

see: HelpOnParsers

Verbatim Display

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

def hello():
    print "Hello World!"

Syntax Highlighting

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

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

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

{{{#!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 then 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 then a page where admonitions are used sparingly.

Comments

see: HelpOnComments

Click on "Comments" in edit bar to toggle the /* comments */ visibility.

Click on "Comments" in edit bar to toggle the visibility.

{{{#!wiki comment/dotted
This is a wiki parser section with class "comment dotted" (see HelpOnParsers).

Its visibility gets toggled the same way.
}}}

SyntaxReference (last edited 2009-07-09 11:28:13 by PaulBoddie)

Unable to edit the page? See the FrontPage for instructions.