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

VERSION

9       This document refers to version 0.09 of Pod::Simple::Wiki, released May
10       24 2008.
11

SYNOPSIS

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

DESCRIPTION

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

METHODS

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

Supported Formats

80       The following wiki formats are supported by "Pod::Simple::Wiki":
81
82       wiki
83           This is the original Wiki format as used on Ward Cunningham's
84           Portland repository of Patterns. See http://c2.com/cgi/wiki
85
86       kwiki
87           This is the format as used by Brian Ingerson's Kwiki:
88           http://www.kwiki.org
89
90       usemod
91           This is the format used by the Usemod wikis. See:
92           http://www.usemod.com/cgi-bin/wiki.pl
93
94       twiki
95           This is the format used by TWiki wikis.  See: http://twiki.org/
96
97       tiddlywiki
98           This is the format used by the TiddlyWiki.  See:
99           http://www.tiddlywiki.com/
100
101       wikipedia or mediawiki
102           This is the format used by Wikipedia and MediaWiki wikis.  See:
103           http://www.mediawiki.org/
104
105       moinmoin
106           This is the format used by MoinMoin wikis.  See:
107           http://moinmo.in/MoinMoinWiki
108
109       confluence
110           This is the format used by Confluence.  See:
111           http://www.atlassian.com/software/confluence/
112
113       If no format is specified the parser defaults to "wiki".
114
115       Any other parameters in "new" will be passed on to the parent
116       "Pod::Simple" object. See Pod::Simple for more details.
117

Porting New Wiki Formats

119       If you are interested in porting a new wiki format have a look at
120       Pod::Simple::Wiki::Template.
121

TODO

127       ·   Add more code, more tests and a few more users if possible.
128
129       ·   Add other Wiki formats. Send requests or patches.
130
131       ·   Fix some of the "=over" edge cases. See the TODOs in the test
132           programs.
133

ACKNOWLEDGEMENTS

135       Thanks to Sean M. Burke for "Pod::Simple". It may not be simple but
136       sub-classing it is. ":-)"
137
138       Thanks to Sam Tregar for TWiki support.
139
140       Thanks Tony Sidaway for Wikipedia/MediaWiki support.
141
142       Thanks to Michael Matthews for MoinMoin support.
143
144       Thanks to Christopher J. Madsen for several MediaWiki additions and
145       tests.
146
147       Thanks Tim Bunce for the TiddlyWiki prod and Ron Savage for the port.
148
149       Thanks to David Bartle, Andrew Hobbs and Jim Renwick for conlfuence
150       patches.
151

DISCLAIMER OF WARRANTY

153       Because this software is licensed free of charge, there is no warranty
154       for the software, to the extent permitted by applicable law. Except
155       when otherwise stated in writing the copyright holders and/or other
156       parties provide the software "as is" without warranty of any kind,
157       either expressed or implied, including, but not limited to, the implied
158       warranties of merchantability and fitness for a particular purpose. The
159       entire risk as to the quality and performance of the software is with
160       you. Should the software prove defective, you assume the cost of all
161       necessary servicing, repair, or correction.
162
163       In no event unless required by applicable law or agreed to in writing
164       will any copyright holder, or any other party who may modify and/or
165       redistribute the software as permitted by the above licence, be liable
166       to you for damages, including any general, special, incidental, or
167       consequential damages arising out of the use or inability to use the
168       software (including but not limited to loss of data or data being
169       rendered inaccurate or losses sustained by you or third parties or a
170       failure of the software to operate with any other software), even if
171       such holder or other party has been advised of the possibility of such
172       damages.
173

AUTHOR

175       John McNamara jmcnamara@cpan.org
176

COPYRIGHT

178       AX MMIII-MMVIII, John McNamara.
179
180       All Rights Reserved. This module is free software. It may be used,
181       redistributed and/or modified under the same terms as Perl itself.
182
183
184
185perl v5.12.0                      2008-05-24              Pod::Simple::Wiki(3)