oracular (3) Text::Markup::Mediawiki.3pm.gz

Name

       Text::Markup::Mediawiki - MediaWiki syntax parser for Text::Markup

Synopsis

         my $html = Text::Markup->new->parse(file => 'README.mediawiki');
         my $raw  = Text::Markup->new->parse(
             file    => 'README.mediawiki',
             options => [ {}, { raw => 1 } ],
         );

Description

       This is the MediaWiki syntax <https://en.wikipedia.org/wiki/Help:Contents/Editing_Wikipedia> parser for
       Text::Markup. It reads in the file (relying on a BOM
       <https://www.unicode.org/unicode/faq/utf_bom.html#BOM>), hands it off to Text::MediawikiFormat for
       parsing, and then returns the generated HTML as an encoded UTF-8 string with an
       "http-equiv="Content-Type"" element identifying the encoding as UTF-8.

       It recognizes files with the following extensions as MediaWiki:

       .mediawiki
       .mwiki
       .wiki

       To change it the files it recognizes, load this module directly and pass a regular expression matching
       the desired extension(s), like so:

         use Text::Markup::Mediawiki qr{kwiki?};

       Text::Markup::Mediawiki supports the two Text::MediawikiFormat arguments, a hash reference for tags and a
       hash reference of options. The supported options include:

       "prefix"
       "extended"
       "implicit_links"
       "absolute_links"
       "process_html"

       Normally this module returns the output wrapped in a minimal HTML document skeleton. If you would like
       the raw output without the skeleton, you can pass the "raw" option via that second hash reference of
       options.

Author

       David E. Wheeler <david@justatheory.com>

Copyright and License

       Copyright (c) 2011-2024 David E. Wheeler. Some Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl
       itself.