Brad Adkins > Pod-WikiText-0.12 > Pod::WikiText

Download:
Pod-WikiText-0.12.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.12   Source  

NAME ^

Pod::WikiText - Support for the use of Wiki markup.

SUMMARY ^

Support the use of Wiki markup for general documentation purposes. This module uses the Text-Tiki module for markup support. The purpose of this module is to provide a convenient way to incorporate Wiki markup into lots of different types of documents including, but not limited to, your own Perl source files.

SYNOPSIS ^

    use Pod::WikiText;

    my $formatter = Pod::WikiText->new(
        format  => 'html',
        author  => 'Brad Adkins',
        infile  => 'test.pl',
        outfile => 'stdout',
        title   => 'Example',
    );

    $formatter->format;

You can create multiple Pod::WikiText objects if needed.

RATIONALE ^

Provided an alternative for documentation of Perl source files which allows the use of a robust flavor of Wiki markup in place of POD markup. This allows the creation of more expressive POD in your Perl source files, and hence better documentation when published.

DESCRIPTION ^

POD sections in source files are marked in the standard way with 'begin' and 'cut' tags. The 'begin' tag must be followed by the keyword 'wiki', as in: "=begin wiki". (See this source file for examples.)

This module can be used for many purporses beyond Perl source documentation. Presentations and other forms of documentaiton are candiates for use. This is possible because the markup support provided by the Text::Tiki module is very good, and several options are provided by Pod::WikiText specifically with general documentation purposes in mind.

Caveat: You should probably not use WikiText as POD in source files that you plan to upload to CPAN, unless you include normal POD as well. :-)

ADDITIONAL INFORMATION ^

Please see the WikiText documentation embedded in this source file for additional details on how to use WikiText.pm. You can view this documentation using WikiText.pm itself to format the WikiText content in this file. Hint: download and install WikiText.pm.

Thank you!

COPYRIGHT ^

Copyright 2008 Brad Adkins <dbijcl@gmail.com>.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.

AUTHOR ^

Brad Adkins, dbijcl@gmail.com

syntax highlighting: