HelpOnParsers

HelpContents > HelpForUsers > HelpOnEditing > HelpOnParsers

Parsers

Besides the default MoinMoin wiki markup, different parsers allow the user to enter content into a page or a page section which is interpreted differently.

Additionally to the built-in parsers, you can find more of them on ParserMarket.

1. How Parsers are applied

A parser reads some portion of text, analyzes it and creates some specially formatted output from it. You can choose the parser to use using 2 different techniques:

  1. A #format processing instruction

    A #format processing instruction can be used to tell MoinMoin which parser to use for the whole page content. By default this is the wiki parser (for moin wiki markup). For details see: The #format Processing Instruction

  2. A Parser section - see HelpOnFormatting With the use of a parser section, a parser can be applied to only a part of a page. You specify which parser to call by using a shebang-like construct in the first line. A shebang is a concept known from Unix command line scripts, where they serve the exact same purpose: the first line tells the shell what program to start to process the remaining lines of the script.

1.1. Example: Processing instruction

This is the complete page contents:

#format creole
... **bold** ...

1.2. Example: Parser section

This is a part of a wiki page:

  • {{{#!csv ,
    a,b,c
    d,e,f
    }}}

It renders as:

  • a b c
    d e f

1.3. Parser sections and nesting

Please note that there are 2 ways to solve nesting problems related to }}}:

  • Use more than 3 curly braces for beginning / ending of the parser section (what you use must not be contained in the section you are enclosing). E.g.:
    {{{{
    {{{
    ...
    }}}
    }}}}
  • Use 3 curly braces + some unique string:
    {{{asdfghj
    {{{
    ...
    }}}
    asdfghj}}}

For more information on the possible markup, see HelpOnEditing.

2. Parsers for writing text content

Some of the parsers are intended for writing normal page text (like e.g. a document):

3. csv parser

The CSV parser works on so-called comma separated values, though the comma is now usually and by default a semicolon. The first line is considered to contain column titles that are rendered in bold, so when you don't want table headers, leave the first line empty.

The shebang can contain the following arguments:

  • delimiter or separator: delimiter=, will set the delimiter to a comma

  • quotechar: quotechar=" will allow quoting values with a double-quote

  • show: comma-separated list of columns to show only

  • hide: comma-separated list of columns to hide

  • autofilter: comma-separated list of columns to add auto-filters on

  • name: name of the dataset

  • link: comma-separated list of columns consisting of http://example.com/link description text rather than just text

  • static_cols, static_vals: columns (and respective values) added to each record

  • -N (where N is a number): hide column N (useful when column names are omitted)

The parser also supports the old, deprecated syntax for the shebang.

Example (please see the raw text of this page for the markup used):

MoinMoin Version Date
0.9 2001-05-07
0.8 2001-01-23
0.7 2000-12-06
0.6 2000-12-04
0.5 2000-11-17
0.4 2000-11-01
0.3 2000-10-25
0.2 2000-08-26
0.1 2000-07-29

Another example, utilizes link option to have links in some column:

{{{#!csv delimiter=, link=Server quotechar="
Type,Server
wiki,http://moinmo.in MoinMoin
translation,http://master19.moinmo.in master19
}}}

It renders as:

Type Server
wiki MoinMoin
translation master19

4. diff, cplusplus, python, java, pascal, irc/irssi parsers

These parsers were provided with MoinMoin versions < 1.9 using a moin-specific parsing / syntax highlighting implementation. Since MoinMoin 1.9 these parsers are just shortcuts, calling the highlight parser (see below).

5. highlight parser

MoinMoin comes with a special parser called highlight that uses Pygments internally.

You can use it to highlight many sorts of programming source code, configuration files and other sorts of text files used on computers (just use the corresponding Lexer name from the table below).

Usage:

  • {{{#!highlight python
    class FooBar:
       """ doc string """
    }}}

renders as:

  •    1 class FooBar:
       2    """ doc string """
       3 
    

Info (!) Of course you can also use it for a complete page as a processing instruction, e.g.: #format highlight python

5.1. Arguments

The highlight parser accepts arguments for line numbering:

  • numbers= might be on, off, or disable and defaults to on. on or off means that line numbers are switchable via JavaScript (html formatter). disabled means that line numbers are disabled completely.

  • start= must be a non negative number and defaults to 1,

  • step= must be a non negative number and defaults to 1.

Usage:

  • {{{#!highlight python numbers=disable
    class FooBar:
       """ doc string """
    }}}

renders as:

class FooBar:
   """ doc string """

5.2. Available highlight lexers

Use value in "Lexer names" column as argument for the highlight parser:

Lexer description Lexer names File patterns Mimetypes
ActionScript as, actionscript *.as application/x-actionscript, text/x-actionscript, text/actionscript
ApacheConf apacheconf, aconf, apache .htaccess, apache.conf, apache2.conf text/x-apacheconf
Bash bash, sh *.sh application/x-sh, application/x-shellscript
Batchfile bat *.bat, *.cmd application/x-dos-batch
BBCode bbcode text/x-bbcode
Befunge befunge *.befunge application/x-befunge
Boo boo *.boo text/x-boo
Brainfuck brainfuck, bf *.bf, *.b application/x-brainfuck
C c *.c, *.h text/x-chdr, text/x-csrc
C# csharp, c# *.cs text/x-csharp
C++ cpp, c++ *.cpp, *.hpp, *.c++, *.h++ text/x-c++hdr, text/x-c++src
c-objdump c-objdump *.c-objdump text/x-c-objdump
Common Lisp common-lisp, cl *.cl, *.lisp, *.el text/x-common-lisp
cpp-objdump cpp-objdump, c++-objdumb, cxx-objdump *.cpp-objdump, *.c++-objdump, *.cxx-objdump text/x-cpp-objdump
CSS css *.css text/css
CSS+Django/Jinja css+django, css+jinja text/css+django, text/css+jinja
CSS+Genshi Text css+genshitext, css+genshi text/css+genshi
CSS+Mako css+mako text/css+mako
CSS+Myghty css+myghty text/css+myghty
CSS+PHP css+php text/css+php
CSS+Ruby css+erb, css+ruby text/css+ruby
CSS+Smarty css+smarty text/css+smarty
D d *.d, *.di text/x-dsrc
d-objdump d-objdump *.d-objdump text/x-d-objdump
Debian Control file control control
Debian Sourcelist sourceslist, sources.list sources.list
Delphi delphi, pas, pascal, objectpascal *.pas text/x-pascal
Diff diff *.diff, *.patch text/x-diff, text/x-patch
Django/Jinja django, jinja application/x-django-templating, application/x-jinja
DylanLexer dylan *.dylan text/x-dylan
ERB erb application/x-ruby-templating
Erlang erlang *.erl, *.hrl text/x-erlang
GAS gas *.s, *.S text/x-gas
Genshi genshi, kid, xml+genshi, xml+kid *.kid application/x-genshi, application/x-kid
Genshi Text genshitext application/x-genshi-text, text/x-genshi
Gettext Catalog pot, po *.pot, *.po application/x-gettext, text/x-gettext, text/gettext
Groff groff, nroff, man *.[1234567], *.man application/x-troff, text/troff
Haskell haskell, hs *.hs text/x-haskell
HTML html *.html, *.htm, *.xhtml, *.xslt text/html, application/xhtml+xml
HTML+Django/Jinja html+django, html+jinja text/html+django, text/html+jinja
HTML+Genshi html+genshi, html+kid text/html+genshi
HTML+Mako html+mako text/html+mako
HTML+Myghty html+myghty text/html+myghty
HTML+PHP html+php *.phtml application/x-php, application/x-httpd-php, application/x-httpd-php3, application/x-httpd-php4, application/x-httpd-php5
HTML+Smarty html+smarty text/html+smarty
INI ini, cfg *.ini, *.cfg text/x-ini
IRC logs irc *.weechatlog text/x-irclog
Java java *.java text/x-java
Java Server Page jsp *.jsp application/x-jsp
JavaScript js, javascript *.js application/x-javascript, text/x-javascript, text/javascript
JavaScript+Django/Jinja js+django, javascript+django, js+jinja, javascript+jinja application/x-javascript+django, application/x-javascript+jinja, text/x-javascript+django, text/x-javascript+jinja, text/javascript+django, text/javascript+jinja
JavaScript+Genshi Text js+genshitext, js+genshi, javascript+genshitext, javascript+genshi application/x-javascript+genshi, text/x-javascript+genshi, text/javascript+genshi
JavaScript+Mako js+mako, javascript+mako application/x-javascript+mako, text/x-javascript+mako, text/javascript+mako
JavaScript+Myghty js+myghty, javascript+myghty application/x-javascript+myghty, text/x-javascript+myghty, text/javascript+mygthy
JavaScript+PHP js+php, javascript+php application/x-javascript+php, text/x-javascript+php, text/javascript+php
JavaScript+Ruby js+erb, javascript+erb, js+ruby, javascript+ruby application/x-javascript+ruby, text/x-javascript+ruby, text/javascript+ruby
JavaScript+Smarty js+smarty, javascript+smarty application/x-javascript+smarty, text/x-javascript+smarty, text/javascript+smarty
Literate Haskell lhs, literate-haskell *.lhs text/x-literate-haskell
LLVM llvm *.ll text/x-llvm
Lua lua *.lua text/x-lua, application/x-lua
Makefile make, makefile, mf *.mak, Makefile, makefile text/x-makefile
Mako mako *.mao application/x-mako
MiniD minid *.md text/x-minidsrc
MoinMoin/Trac Wiki markup trac-wiki, moin text/x-trac-wiki
MOOCode moocode *.moo text/x-moocode
MuPAD mupad *.mu
Myghty myghty *.myt, autodelegate application/x-myghty
MySQL mysql text/x-mysql
objdump objdump *.objdump text/x-objdump
Objective-C objective-c, objectivec, obj-c, objc *.m text/x-objective-c
OCaml ocaml *.ml, *.mli, *.mll, *.mly text/x-ocaml
Perl perl, pl *.pl, *.pm text/x-perl, application/x-perl
PHP php, php3, php4, php5 *.php, *.php[345] text/x-php
Python python, py *.py, *.pyw, *.sc, SConstruct, SConscript text/x-python, application/x-python
Python console session pycon text/x-python-doctest
Python Traceback pytb *.pytb text/x-python-traceback
Raw token data raw *.raw application/x-pygments-tokens
Redcode redcode *.cw
reStructuredText rst, rest, restructuredtext *.rst, *.rest text/x-rst
RHTML rhtml, html+erb, html+ruby *.rhtml text/html+ruby
Ruby rb, ruby *.rb, *.rbw, Rakefile, *.rake, *.gemspec, *.rbx text/x-ruby, application/x-ruby
Ruby irb session rbcon, irb text/x-ruby-shellsession
Scheme scheme, scm *.scm text/x-scheme, application/x-scheme
Smarty smarty *.tpl application/x-smarty
SQL sql *.sql text/x-sql
SquidConf squidconf, squid.conf, squid squid.conf text/x-squidconf
TeX tex, latex *.tex, *.aux, *.toc text/x-tex, text/x-latex
Text only text *.txt text/plain
VB.net vb.net, vbnet *.vb, *.bas text/x-vbnet, text/x-vba
VimL vim *.vim, .vimrc text/x-vim
XML xml *.xml, *.xsl, *.rss, *.xslt text/xml, application/xml, image/svg+xml, application/rss+xml, application/atom+xml, application/xsl+xml, application/xslt+xml
XML+Django/Jinja xml+django, xml+jinja application/xml+django, application/xml+jinja
XML+Mako xml+mako application/xml+mako
XML+Myghty xml+myghty application/xml+myghty
XML+PHP xml+php application/xml+php
XML+Ruby xml+erb, xml+ruby application/xml+ruby
XML+Smarty xml+smarty application/xml+smarty