Pod::Simple::Wiki(3pm)

1Pod::Simple::Wiki(3)  User Contributed Perl Documentation Pod::Simple::Wiki(3)
2
3
4

NAME

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

SYNOPSIS

9       To create a simple filter to convert from Pod to a wiki format:
10
11           #!/usr/bin/perl
12
13           use strict;
14           use warnings;
15           use Pod::Simple::Wiki;
16
17
18           my $parser = Pod::Simple::Wiki->new('kwiki');
19
20           if ( defined $ARGV[0] ) {
21               open IN, $ARGV[0] or die "Couldn't open $ARGV[0]: $!\n";
22           }
23           else {
24               *IN = *STDIN;
25           }
26
27           if ( defined $ARGV[1] ) {
28               open OUT, ">$ARGV[1]" or die "Couldn't open $ARGV[1]: $!\n";
29           }
30           else {
31               *OUT = *STDOUT;
32           }
33
34           $parser->output_fh( *OUT );
35           $parser->parse_file( *IN );
36
37           __END__
38
39       To convert Pod to a wiki format using the installed "pod2wiki" utility:
40
41           pod2wiki --style mediawiki file.pod > file.wiki
42

DESCRIPTION

44       The "Pod::Simple::Wiki" module is used for converting Pod text to Wiki
45       text.
46
47       Pod (Plain Old Documentation) is a simple markup language used for
48       writing Perl documentation.
49
50       A Wiki is a user extensible web site. It uses very simple mark-up that
51       is converted to Html. For an introduction to Wikis see:
52       <http://en.wikipedia.org/wiki/Wiki>
53

METHODS

55   new('wiki_format')
56       The "new" method is used to create a new "Pod::Simple::Wiki" object. It
57       is also used to set the output Wiki format.
58
59           my $parser1 = Pod::Simple::Wiki->new( 'wiki' );
60           my $parser2 = Pod::Simple::Wiki->new( 'mediawiki' );
61           my $parser3 = Pod::Simple::Wiki->new(); # Defaults to 'wiki'
62
63       The currently supported formats are:
64
65           wiki
66           kwiki
67           usemod
68           twiki
69           tiddlywiki
70           textile
71           wikipedia or mediawiki
72           markdown
73           moinmoin
74           confluence
75
76   Other methods
77       Pod::Simple::Wiki inherits all of the methods of "Pod::Simple". See
78       Pod::Simple for more details.
79

Supported Formats

81       The following wiki formats are supported by "Pod::Simple::Wiki":
82
83       wiki
84           This is the original Wiki format as used on Ward Cunningham's
85           Portland repository of Patterns. See <http://c2.com/cgi/wiki>.
86
87       kwiki
88           This is the format as used by Brian Ingerson's Kwiki:
89           <http://www.kwiki.org>.
90
91       usemod
92           This is the format used by the Usemod wikis. See:
93           <http://www.usemod.com/cgi-bin/wiki.pl>.
94
95       twiki
96           This is the format used by TWiki wikis. See: <http://twiki.org/>.
97
98       tiddlywiki
99           This is the format used by the TiddlyWiki. See:
100           <http://www.tiddlywiki.com/>.
101
102       textile
103           The Textile markup format as used on GitHub. See:
104           <http://textile.thresholdstate.com/>.
105
106       wikipedia or mediawiki
107           This is the format used by Wikipedia and MediaWiki wikis. See:
108           <http://www.mediawiki.org/>.
109
110       markdown
111           This is the format used by GitHub and other sites. See:
112           <http://daringfireball.net/projects/markdown/syntax>.
113
114       moinmoin
115           This is the format used by MoinMoin wikis. See:
116           <http://moinmo.in/MoinMoinWiki>.
117
118       muse
119           Emacs Muse (also known as "Muse" or "Emacs-Muse") is an authoring
120           and publishing environment for Emacs.
121
122       confluence
123           This is the format used by Confluence. See:
124           <http://www.atlassian.com/software/confluence/>.
125
126       If no format is specified the parser defaults to "wiki".
127
128       Any other parameters in "new" will be passed on to the parent
129       "Pod::Simple" object. See Pod::Simple for more details.
130

Porting New Wiki Formats

132       If you are interested in porting a new wiki format have a look at
133       Pod::Simple::Wiki::Template.
134
135       The "Pod::Simple::Wiki" git repository is:
136       <http://github.com/jmcnamara/pod-simple-wiki/>.
137

TODO

143       •   Fix some of the "=over" edge cases. See the TODOs in the test
144           programs.
145

ACKNOWLEDGEMENTS

147       Thanks to Sean M. Burke for "Pod::Simple". It may not be simple but
148       sub-classing it is. ":-)"
149
150       Thanks to Zoffix Znet for various pull requests and fixes.
151
152       Thanks to Sam Tregar for TWiki support.
153
154       Thanks Tony Sidaway for Wikipedia/MediaWiki support.
155
156       Thanks to Daniel T. Staal for Markdown support.
157
158       Thanks to Michael Matthews for MoinMoin support.
159
160       Thanks to Christopher J. Madsen for several MediaWiki additions and
161       tests.
162
163       Thanks Tim Bunce for the TiddlyWiki prod and Ron Savage for the port.
164
165       Thanks to Olivier 'dolmen' Mengué for various TiddlyWiki patches.
166
167       Thanks to David Bartle, Andrew Hobbs and Jim Renwick for confluence
168       patches.
169
170       Thanks to Peter Hallam for MediaWiki enhancements.
171
172       Thanks to Marco Pessotto for the Muse format.
173

DISCLAIMER OF WARRANTY

175       Because this software is licensed free of charge, there is no warranty
176       for the software, to the extent permitted by applicable law. Except
177       when otherwise stated in writing the copyright holders and/or other
178       parties provide the software "as is" without warranty of any kind,
179       either expressed or implied, including, but not limited to, the implied
180       warranties of merchantability and fitness for a particular purpose. The
181       entire risk as to the quality and performance of the software is with
182       you. Should the software prove defective, you assume the cost of all
183       necessary servicing, repair, or correction.
184
185       In no event unless required by applicable law or agreed to in writing
186       will any copyright holder, or any other party who may modify and/or
187       redistribute the software as permitted by the above licence, be liable
188       to you for damages, including any general, special, incidental, or
189       consequential damages arising out of the use or inability to use the
190       software (including but not limited to loss of data or data being
191       rendered inaccurate or losses sustained by you or third parties or a
192       failure of the software to operate with any other software), even if
193       such holder or other party has been advised of the possibility of such
194       damages.
195

LICENSE

197       Either the Perl Artistic Licence
198       <http://dev.perl.org/licenses/artistic.html> or the GPL
199       <http://www.opensource.org/licenses/gpl-license.php>.
200

AUTHOR

202       John McNamara jmcnamara@cpan.org
203

COPYRIGHT

205       MMIII-MMIV, John McNamara.
206
207       All Rights Reserved. This module is free software. It may be used,
208       redistributed and/or modified under the same terms as Perl itself.
209
210
211
212perl v5.34.0                      2022-01-21              Pod::Simple::Wiki(3)