NAME

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

SYNOPSIS

To create a simple pod2wiki filter:

#!/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__

DESCRIPTION

The Pod::Simple::Wiki module is used for converting Pod text to Wiki text.

Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation.

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://en.wikipedia.org/wiki/Wiki

METHODS

new()

The new method is used to create a new Pod::Simple::Wiki object. It is also used to set the output Wiki format.

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:

wiki

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

kwiki

This is the format as used by Brian Ingerson's CGI::Kwiki: http://search.cpan.org/dist/CGI-Kwiki/

usemod

This is the format used by the Usemod wikis. See: http://www.usemod.com/cgi-bin/wiki.pl?WikiFormat

twiki

This is the format used by TWiki wikis. See: http://www.twiki.org/

wikipedia or mediawiki

This is the format used by Wikipedia and MediaWiki wikis. See: http://www.wikipedia.org/

moinmoin

This is the format used by MoinMoin wikis. See: http://moinmoin.wikiwikiweb.de/

If no format is specified the parser defaults to wiki.

Any other parameters in new will be passed on to the parent Pod::Simple object. See Pod::Simple for more details.

Other methods

Pod::Simple::Wiki inherits all of the methods of Pod::Simple. See Pod::Simple for more details.

TODO

• Add more code, more tests and a few more users if possible.

• Add other Wiki formats. Send requests or patches.

• Fix some of the =over edge cases. See the TODOs in the test programs.

SEE ALSO

This module also installs a pod2wiki command line utility. See pod2wiki --help for details.

ACKNOWLEDGEMENTS

Thanks to Sean M. Burke for Pod::Simple. It may not be simple but sub-classing it is. :-)

Thanks to Sam Tregar for TWiki support.

Thanks Tony Sidaway for Wikipedia/MediaWiki support.

Thanks to Michael Matthews for MoinMoin support.

AUTHOR

John McNamara jmcnamara@cpan.org

COPYRIGHT

© MMIII-MMVII, 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.

cpanm Pod::Simple::Wiki

perl -MCPAN -e shell
install Pod::Simple::Wiki