Redirected from page "MoinMoin/TextFormatting"

Clear message

HelpOnMoinWikiSyntax

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 Automatic Linking
  6. Drawings
  7. Blockquotes and Indentations
  8. Lists
    1. Unordered Lists
    2. Ordered Lists
    3. Definition Lists
  9. Horizontal Rules
  10. 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
  11. Macros and Variables
    1. Macros
    2. Variables
  12. Smileys and Icons
  13. Parsers
    1. Verbatim Display
    2. Syntax Highlighting
    3. Using the wiki parser with css classes
  14. Admonitions
  15. Comments

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

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

All text is available under the terms of the GNU Free Documentation License.