NAME

Pod::BBCode - converts a POD file to a page using BB code.

SYNOPSIS

    use Pod::BBCode;

    my $p = new Pod::BBCode(-headcolor=>'red',-itemcolor=>'blue',-textcolor=>'black');
    $p->parse_from_file('in.pod');

DESCRIPTION

This class converts a file in POD syntax to the BBCode syntax, in order to simplify the posting process on vBulletin forums. See any vBulletin forum's help for a description of the BBCode syntax.

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

This module was modified from Pod::TikiWiki module. Thanks to the original author.

Supported formatting

Heading directives (=head[1234]) are handled with [size][/size] tag.

    =head1 NAME    --> [size=5]NAME[/size]
    =head2 Methods --> [size=4]Methods[/size]

List items are rendered with [list=1][/list] (for ordered lists) or [list][/list] (for unordered lists) tag.

    =over               [list]

    =item *
                   -->  [*]
    Text                Text

    =over               [list=1]

    =item 1
                   -->  [*]
    Text                Text

    =back               [/list]

    =back               [/list]

Items with a string are rendered into a asterisked list

    =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>       --> [b]bold[/b]
    I<italic>     --> [i]italic[/i]
    F<file>       --> [pre]file[/pre]
    C<code>       --> [pre]code[/pre]

LIMITATIONS

Only the above four interior sequences are handled. S, L, X, E are ignored.
BBCode-like text can't display correctly in non-verbatim environment, so be careful.
...

AUTHOR

chaoslawful (chaoslaw@cpan.org)

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

Thanks to the author of Pod::TikiWiki again!

CPAN RT