/ 
Pod-TikiWiki-0.1
/ Pod::TikiWiki

NAME

Pod::TikiWiki - converts a POD file to a TikiWiki page.

SYNOPSIS

use Pod::TikiWiki;

my $p = new Pod::TikiWiki;
$p->parse_from_file('in.pod');

DESCRIPTION

This class converts a file in POD syntax to the TikiWiki syntax. See http://tikiwiki.org/tiki-index.php?page=WikiSyntax for a description of the syntax.

Pod::TikiWiki derives from Pod::Parser and therefore inherits all its methods.

Supported formatting

  • Heading directives (=head[1234]) are handled with the appropriate number of bangs.

    =head1 NAME    --> !NAME
=head2 Methods --> !!Methods

  • List items are rendered with a number of hashes (#, for ordered lists) or asterisks (*, for unordered lists).

    =over

=item *
               --> * Text
Text

=over

=item 1
               --> ## Text
Text

=back

=back

    Items with a string are rendered into a definition list, the definition being the next paragraph

    =item Text
               --> ;Text: Definition
Definition

  • Interior sequences B, I, F, and C are honored. Both F and C are rendered as monospaced text.

    B<bold>       --> __bold__
I<italic>     --> ''italic''
F<file>       --> -+file+-
C<code>       --> -+code+-

LIMITATIONS

  • Only the above four interior sequences are handled. S, L, X, E are ignored.

  • Tiki syntax being unstructured, the nesting of list item and regular paragraphs may not be well rendered on the final page.

  • ...

SEE ALSO

perlpod, Pod::Parser

AUTHOR

Copyright © 2004 Cédric Bouvier <cbouvi@cpan.org>

This module is free software. You can redistribute and/or modify it under the terms of the GNU General Public License.