Scroll to navigation

Pod::Simple::Wiki::Mediawiki(3pm) User Contributed Perl Documentation Pod::Simple::Wiki::Mediawiki(3pm)

NAME

Pod::Simple::Wiki::Mediawiki - A class for creating Pod to Mediawiki wiki filters.

SYNOPSIS

This module isn't used directly. Instead it is called via "Pod::Simple::Wiki": 

    #!/usr/bin/perl -w

    use strict;
    use Pod::Simple::Wiki;


    my $parser = Pod::Simple::Wiki->new('mediawiki', \%opts);

    ...

Convert Pod to a Mediawiki wiki format using the installed "pod2wiki" utility:

    pod2wiki --style mediawiki file.pod > file.wiki

DESCRIPTION

The "Pod::Simple::Wiki::Mediawiki" module is used for converting Pod text to Wiki text.

Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation.

For an introduction to Mediawiki see: http://www.mediawiki.org/wiki/MediaWiki

This module isn't generally invoked directly. Instead it is called via "Pod::Simple::Wiki". See the Pod::Simple::Wiki and pod2wiki documentation for more information.

METHODS

Pod::Simple::Wiki::Mediawiki inherits all of the methods of "Pod::Simple" and "Pod::Simple::Wiki". See Pod::Simple and Pod::Simple::Wiki for more details.

new

The following options are supported by the "Pod::Simple::Wiki::Mediawiki" constructor:
custom_tags
This option accepts a hashref containing the HTML tag to MediaWiki mappings.

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:

    {
        custom_tags => {
            '<pre>'     => "<syntaxhighlight lang=\"perl\">\n",
            '</pre>'    => "\n</syntaxhighlight>\n",
        }
    }

Any custom tags you define will override the classes' default tags as defined in the $tags variable.

Defaults to "{}".

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

For example, the output of the following list definition:

    =for :list
    * Point one
    This is pointy
    * Point two
    That hurts

will be transformed into:

    * Point one<p>This is pointy</p>
    * Point two<p>That hurts</p>

This will be rendered as a bulleted with list headings that have correctly indented paragraph blocks immediately beneath.

Defaults to 0.

link_prefix
If set, all links without any extra qualifier text are prefixed with the given URL. A useful URL to set this option to is: "http://search.cpan.org/perldoc?", which will enable the links to be correctly resolved to the external links when used within your internal MediaWiki site.

Defaults to 0.

sentence_case_headers
This option will modify any "=head1" header by lower-casing it and then upper-casing the first character.

For example, this header:

    =head1 DESCRIPTION

becomes:

    =head1 Description

This option is inspired from <http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Article_titles> in the Wikipedia "Manual of Style".

Defaults to 0.

remove_name_section
If enabled, modify the resultant wiki output text to remove the "NAME" (or "Name") section, but first parse out the embedded abstract text and place that at the top of the wiki page, as a brief introduction.

Defaults to 0.

SEE ALSO

This module also installs a "pod2wiki" command line utility. See "pod2wiki --help" for details.

ACKNOWLEDGEMENTS

Thanks Tony Sidaway for initial Wikipedia/MediaWiki support. Christopher J. Madsen for several major additions and tests. Peter Hallam added several MediaWiki enhancements.

DISCLAIMER OF WARRANTY

Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.

AUTHORS

John McNamara jmcnamara@cpan.org

Christopher J. Madsen perl@cjmweb.net

COPYRIGHT

MMIII-MMXV, John McNamara.

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.

2015-11-09 perl v5.20.2