Pod::Simple::Wiki - A class for creating Pod to Wiki filters.
To create a simple pod2wiki filter:
pod2wiki
#!/usr/bin/perl -w use strict; use Pod::Simple::Wiki; my $parser = Pod::Simple::Wiki->new(); if (defined $ARGV[0]) { open IN, $ARGV[0] or die "Couldn't open $ARGV[0]: $!\n"; } else { *IN = *STDIN; } if (defined $ARGV[1]) { open OUT, ">$ARGV[1]" or die "Couldn't open $ARGV[1]: $!\n"; } else { *OUT = *STDOUT; } $parser->output_fh(*OUT); $parser->parse_file(*IN); __END__
The Pod::Simple::Wiki module is used for converting Pod text to Wiki text.
Pod::Simple::Wiki
A Wiki is a user extensible web site. It uses very simple mark-up that is converted to Html.
For an introduction to Wikis see: http://c2.com/cgi/wiki?WikiGettingStartedFaq and http://c2.com/cgi/wiki?WikiWikiWebFaq
The new method is used to create a new Pod::Simple::Wiki object. It is also used to set the output Wiki format.
new
my $parser1 = Pod::Simple::Wiki->new('wiki'); my $parser2 = Pod::Simple::Wiki->new('kwiki'); my $parser3 = Pod::Simple::Wiki->new(); # Defaults to 'wiki'
The currently supported formats are:
This is the original Wiki format as used on Ward Cunningham's Portland repository of Patterns. The formatting rules are given at http://c2.com/cgi/wiki?TextFormattingRules
This is the format as used by Brian Ingerson's CGI::Kwiki: http://search.cpan.org/dist/CGI-Kwiki/
This is the format used by the Usemod wikis. See: http://www.usemod.com/cgi-bin/wiki.pl?WikiFormat
If no format is specified the parser defaults to wiki.
wiki
Any other parameters in new will be passed on to the parent Pod::Simple object. See Pod::Simple for more details.
Pod::Simple::Wiki inherits all of the methods of Pod::Simple. See Pod::Simple for more details.
Add more code, more tests and a few more users if possible.
Add other Wiki formats such as TWiki and Wikipedia.
This module also installs a pod2wiki command line utility. See pod2wiki --help for details.
pod2wiki --help
Thanks to Sean M. Burke for Pod::Simple. It may not be simple but sub-classing it is. :-)
Pod::Simple
:-)
John McNamara jmcnamara@cpan.org
© MMIII-MMIV, 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.
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in '©'. Assuming CP1252
To install Pod::Simple::Wiki, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Simple::Wiki
CPAN shell
perl -MCPAN -e shell install Pod::Simple::Wiki
For more information on module installation, please visit the detailed CPAN module installation guide.