.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MojoMojo::Formatter 3pm"
.TH MojoMojo::Formatter 3pm "2010-05-23" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MojoMojo::Formatter \- Base class for all formatters
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package MojoMojo::Formatter::Simple;
\&
\&    use parent qw/MojoMojo::Formatter/;
\&
\&    sub format_content_order { 14 }
\&    # so that it runs after inclusion of obscene web sites
\&    # (MojoMojo::Formatter::Include runs at 6)
\&
\&    sub format_content {
\&        my ($class, $content, $c) = @_;
\&        $$content =~ s/fuck/f**k/g;
\&        return $content;
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is the class to inherit from if you want to write your own formatter.
.SH "WRITING YOUR OWN FORMATTER"
.IX Header "WRITING YOUR OWN FORMATTER"
See the synopsis for a really simple formatter example. MojoMojo uses
Module::Pluggable::Ordered to process all the formatter plugins. Just
specify when you want to trigger your formatter by providing a format_content_order
method which returns a number to specify when you want to run. The plugin order
for the default plugins is currently as follows:
.IP "1  \- MojoMojo::Formatter::Redirect \- handles {{redirect /path}}" 4
.IX Item "1 - MojoMojo::Formatter::Redirect - handles {{redirect /path}}"
.PD 0
.IP "5  \- MojoMojo::Formatter::Include \- handles {{include <url>}} before all other plugins, so that transcluded sections from the same wiki get parsed for markup" 4
.IX Item "5 - MojoMojo::Formatter::Include - handles {{include <url>}} before all other plugins, so that transcluded sections from the same wiki get parsed for markup"
.IP "10 \- MojoMojo::Formatter::CPANHyperlink \- handles {{cpan My::Module}}" 4
.IX Item "10 - MojoMojo::Formatter::CPANHyperlink - handles {{cpan My::Module}}"
.IP "10 \- MojoMojo::Formatter::YouTube \- handles {{youtube <url>}}" 4
.IX Item "10 - MojoMojo::Formatter::YouTube - handles {{youtube <url>}}"
.IP "10 \- MojoMojo::Formatter::Wiki \- handles [[wikilinks]]" 4
.IX Item "10 - MojoMojo::Formatter::Wiki - handles [[wikilinks]]"
.IP "10 \- MojoMojo::Formatter::Pod \- handles {{pod}} ... {{end}} blocks" 4
.IX Item "10 - MojoMojo::Formatter::Pod - handles {{pod}} ... {{end}} blocks"
.IP "14 \- MojoMojo::Formater::IRCLog \- handles {{irc}} ... {{end}} blocks" 4
.IX Item "14 - MojoMojo::Formater::IRCLog - handles {{irc}} ... {{end}} blocks"
.IP "14 \- MojoMojo::Formatter::SyntaxHighlight \- Performs syntax highlighting on code blocks" 4
.IX Item "14 - MojoMojo::Formatter::SyntaxHighlight - Performs syntax highlighting on code blocks"
.IP "15 \- Main formatter (MojoMojo::Formatter::Markdown or MojoMojo::Formatter::Textile)" 4
.IX Item "15 - Main formatter (MojoMojo::Formatter::Markdown or MojoMojo::Formatter::Textile)"
.IP "16 \- MojoMojo::Formatter::Defang \- removes harmful \s-1HTML\s0 and \s-1XSS\s0" 4
.IX Item "16 - MojoMojo::Formatter::Defang - removes harmful HTML and XSS"
.IP "91 \- MojoMojo::Formatter::Comment \- handles {{comments}}, inserts a comment box" 4
.IX Item "91 - MojoMojo::Formatter::Comment - handles {{comments}}, inserts a comment box"
.IP "95 \- MojoMojo::Formatter::TOC \- replaces {{toc}} with a table of contents" 4
.IX Item "95 - MojoMojo::Formatter::TOC - replaces {{toc}} with a table of contents"
.PD
.PP
Note that if your formatter expects \s-1HTML\s0 text, it should run after the
main formatter.
.SH "METHODS"
.IX Header "METHODS"
.SS "format_content"
.IX Subsection "format_content"
If you want your formatter to do something, you also need to override
\&\f(CW\*(C`format_content\*(C'\fR. It gets passed its classname, a scalar ref to the content,
and the context object. It should return the scalar ref.
.SS "main_format_content"
.IX Subsection "main_format_content"
Override this method if your formatter is a primary one (equivalent to Markdown or
Textile). It gets passed the same arguments as \*(L"format_content\*(R". Also make sure
to update \*(L"Site settings\*(R" (/.admin).
.PP
Note that the main formatter runs at 15.
.SS "module_loaded"
.IX Subsection "module_loaded"
Return true if a formatter module is loaded.
.SS "gen_re"
.IX Subsection "gen_re"
.Vb 1
\&    gen_re(qr/irc/)
.Ve
.PP
Returns a regular expression for the given tag between matching double braces.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MojoMojo, MojoMojo::Formatter::Textile, MojoMojo::Formatter::Markdown
.SH "AUTHORS"
.IX Header "AUTHORS"
Marcus Ramberg <mramberg@cpan.org>
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.