Pod::Simple::Wiki::Mediawiki(3pm)

1Pod::Simple::Wiki::MediUasweirkiC(o3n)tributed Perl DocuPmoedn:t:aStiimopnle::Wiki::Mediawiki(3)
2
3
4

NAME

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

SYNOPSIS

10       This module isn't used directly. Instead it is called via
11       "Pod::Simple::Wiki":
12
13           #!/usr/bin/perl -w
14
15           use strict;
16           use Pod::Simple::Wiki;
17
18
19           my $parser = Pod::Simple::Wiki->new('mediawiki', \%opts);
20
21           ...
22
23       Convert Pod to a Mediawiki wiki format using the installed "pod2wiki"
24       utility:
25
26           pod2wiki --style mediawiki file.pod > file.wiki
27

DESCRIPTION

29       The "Pod::Simple::Wiki::Mediawiki" module is used for converting Pod
30       text to Wiki text.
31
32       Pod (Plain Old Documentation) is a simple markup language used for
33       writing Perl documentation.
34
35       For an introduction to Mediawiki see:
36       http://www.mediawiki.org/wiki/MediaWiki
37
38       This module isn't generally invoked directly. Instead it is called via
39       "Pod::Simple::Wiki". See the Pod::Simple::Wiki and pod2wiki
40       documentation for more information.
41

METHODS

43       Pod::Simple::Wiki::Mediawiki inherits all of the methods of
44       "Pod::Simple" and "Pod::Simple::Wiki". See Pod::Simple and
45       Pod::Simple::Wiki for more details.
46
47   new
48       The following options are supported by the
49       "Pod::Simple::Wiki::Mediawiki" constructor:
50
51       custom_tags
52           This option accepts a hashref containing the HTML tag to MediaWiki
53           mappings.
54
55           For example, if your MediaWiki installation has the SyntaxHighlight
56           GeSHi
57           <http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi>
58           extension installed, you could pass the following custom tags to
59           enable your verbatim paragraphs to be syntax highlighted:
60
61               {
62                   custom_tags => {
63                       '<pre>'     => "<syntaxhighlight lang=\"perl\">\n",
64                       '</pre>'    => "\n</syntaxhighlight>\n",
65                   }
66               }
67
68           Any custom tags you define will override the classes' default tags
69           as defined in the $tags variable.
70
71           Defaults to "{}".
72
73       transformer_lists
74           If enabled, modify the item list output to better support the
75           Pod::Elemental::Transformer::List style of lists (as used by many
76           Dist::Zilla based distros via Pod::Weaver).
77
78           For example, the output of the following list definition:
79
80               =for :list
81               * Point one
82               This is pointy
83               * Point two
84               That hurts
85
86           will be transformed into:
87
88               * Point one<p>This is pointy</p>
89               * Point two<p>That hurts</p>
90
91           This will be rendered as a bulleted with list headings that have
92           correctly indented paragraph blocks immediately beneath.
93
94           Defaults to 0.
95
96       link_prefix
97           If set, all links without any extra qualifier text are prefixed
98           with the given URL.  A useful URL to set this option to is:
99           "http://search.cpan.org/perldoc?", which will enable the links to
100           be correctly resolved to the external links when used within your
101           internal MediaWiki site.
102
103           Defaults to 0.
104
105       sentence_case_headers
106           This option will modify any "=head1" header by lower-casing it and
107           then upper-casing the first character.
108
109           For example, this header:
110
111               =head1 DESCRIPTION
112
113           becomes:
114
115               =head1 Description
116
117           This option is inspired from
118           <http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Article_titles>
119           in the Wikipedia "Manual of Style".
120
121           Defaults to 0.
122
123       remove_name_section
124           If enabled, modify the resultant wiki output text to remove the
125           "NAME" (or "Name") section, but first parse out the embedded
126           abstract text and place that at the top of the wiki page, as a
127           brief introduction.
128
129           Defaults to 0.
130

ACKNOWLEDGEMENTS

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

DISCLAIMER OF WARRANTY

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

AUTHORS

144       John McNamara jmcnamara@cpan.org
145
146       Christopher J. Madsen perl@cjmweb.net
147

COPYRIGHT

149       MMIII-MMXV, John McNamara.
150
151       All Rights Reserved. This module is free software. It may be used,
152       redistributed and/or modified under the same terms as Perl itself.
153
154
155
156perl v5.32.1                      2021-01-27   Pod::Simple::Wiki::Mediawiki(3)