.\" 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 "Pod::Simple::Wiki::Mediawiki 3pm"
.TH Pod::Simple::Wiki::Mediawiki 3pm "2015-11-09" "perl v5.20.2" "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"
Pod::Simple::Wiki::Mediawiki \- A class for creating Pod to Mediawiki wiki filters.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This module isn't used directly. Instead it is called via \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR:
.PP
.Vb 1
\&    #!/usr/bin/perl \-w
\&
\&    use strict;
\&    use Pod::Simple::Wiki;
\&
\&
\&    my $parser = Pod::Simple::Wiki\->new(\*(Aqmediawiki\*(Aq, \e%opts);
\&
\&    ...
.Ve
.PP
Convert Pod to a Mediawiki wiki format using the installed \f(CW\*(C`pod2wiki\*(C'\fR utility:
.PP
.Vb 1
\&    pod2wiki \-\-style mediawiki file.pod > file.wiki
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Pod::Simple::Wiki::Mediawiki\*(C'\fR module is used for converting Pod text to Wiki text.
.PP
Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation.
.PP
For an introduction to Mediawiki see: http://www.mediawiki.org/wiki/MediaWiki
.PP
This module isn't generally invoked directly. Instead it is called via \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR. See the Pod::Simple::Wiki and pod2wiki documentation for more information.
.SH "METHODS"
.IX Header "METHODS"
Pod::Simple::Wiki::Mediawiki inherits all of the methods of \f(CW\*(C`Pod::Simple\*(C'\fR and \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR. See Pod::Simple and Pod::Simple::Wiki for more details.
.SS "new"
.IX Subsection "new"
The following options are supported by the \f(CW\*(C`Pod::Simple::Wiki::Mediawiki\*(C'\fR constructor:
.IP "\fBcustom_tags\fR" 4
.IX Item "custom_tags"
This option accepts a hashref containing the \s-1HTML\s0 tag to MediaWiki mappings.
.Sp
For example, if your MediaWiki installation has the SyntaxHighlight GeSHi <http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi> extension installed, you could pass the following custom tags to enable your verbatim paragraphs to be syntax highlighted:
.Sp
.Vb 6
\&    {
\&        custom_tags => {
\&            \*(Aq<pre>\*(Aq     => "<syntaxhighlight lang=\e"perl\e">\en",
\&            \*(Aq</pre>\*(Aq    => "\en</syntaxhighlight>\en",
\&        }
\&    }
.Ve
.Sp
Any custom tags you define will override the classes' default tags as defined in the \f(CW$tags\fR variable.
.Sp
Defaults to \*(L"{}\*(R".
.IP "\fBtransformer_lists\fR" 4
.IX Item "transformer_lists"
If enabled, modify the item list output to better support the Pod::Elemental::Transformer::List style of lists (as used by many Dist::Zilla based distros via Pod::Weaver).
.Sp
For example, the output of the following list definition:
.Sp
.Vb 5
\&    =for :list
\&    * Point one
\&    This is pointy
\&    * Point two
\&    That hurts
.Ve
.Sp
will be transformed into:
.Sp
.Vb 2
\&    * Point one<p>This is pointy</p>
\&    * Point two<p>That hurts</p>
.Ve
.Sp
This will be rendered as a bulleted with list headings that have correctly indented paragraph blocks immediately beneath.
.Sp
Defaults to 0.
.IP "\fBlink_prefix\fR" 4
.IX Item "link_prefix"
If set, all links without any extra qualifier text are prefixed with the given \s-1URL.  A\s0 useful \s-1URL\s0 to set this option to is: \f(CW\*(C`http://search.cpan.org/perldoc?\*(C'\fR, which will enable the links to be correctly resolved to the external links when used within your internal MediaWiki site.
.Sp
Defaults to 0.
.IP "\fBsentence_case_headers\fR" 4
.IX Item "sentence_case_headers"
This option will modify any \f(CW\*(C`=head1\*(C'\fR header by lower-casing it and then upper-casing the first character.
.Sp
For example, this header:
.Sp
.Vb 1
\&    =head1 DESCRIPTION
.Ve
.Sp
becomes:
.Sp
.Vb 1
\&    =head1 Description
.Ve
.Sp
This option is inspired from <http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Article_titles> in the Wikipedia \*(L"Manual of Style\*(R".
.Sp
Defaults to 0.
.IP "\fBremove_name_section\fR" 4
.IX Item "remove_name_section"
If enabled, modify the resultant wiki output text to remove the \*(L"\s-1NAME\*(R" \s0(or \*(L"Name\*(R") section, but first parse out the embedded abstract text and place that at the top of the wiki page, as a brief introduction.
.Sp
Defaults to 0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module also installs a \f(CW\*(C`pod2wiki\*(C'\fR command line utility. See \f(CW\*(C`pod2wiki \-\-help\*(C'\fR for details.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Thanks Tony Sidaway for initial Wikipedia/MediaWiki support. Christopher J. Madsen for several major additions and tests. Peter Hallam added several MediaWiki enhancements.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
Please refer to the \s-1DISCLAIMER OF WARRANTY\s0 in Pod::Simple::Wiki.
.SH "AUTHORS"
.IX Header "AUTHORS"
John McNamara jmcnamara@cpan.org
.PP
Christopher J. Madsen perl@cjmweb.net
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
MMIII-MMXV, John McNamara.
.PP
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.