/ 
Pod-IkiWiki-0.0.4
River stage zero No dependents
/ Pod::IkiWiki

NAME

Pod::IkiWiki - Pod translator to IkiWiki's Markdown format

VERSION

This documentation refers to Pod::IkiWiki version 0.0.3

SYNOPSIS

	use Pod::IkiWiki;

    my $parser = Pod::IkiWiki->new();

    $parser->parse_from_file( $my_input_file );

    print STDOUT $parser->dump_as_ikiwiki();

DESCRIPTION

This package provides a POD translator for ikiwiki's markdown format.

SUBROUTINES/METHODS

This package inherits from Pod::Parser and his public methods are the same.

There are some particularities in some public methods such as the cleaning process of empty lines.

new( )

Build a new parser object and adds a private data structure under the key _PACKAGE_.

Accepts the following options:

indent

Set the number of the blank spaces for every indentation level. By default is four (4) spaces.

no_metadata

Disable the metadata scanning. By default is enabled.

Disable the build of wikilinks for all links without protocol scheme. By default is enabled.

formatters

Add one or more formatter's names for included in the markdown source. By default only the ikiwiki special formatter is enabled.

command( )

This method process the following groups of POD commands:

headers

If it found a level one header the function tries to extract special information about the document, such as the author name, the title or the license.

lists

Support nested, ordered and unordered lists.

special formatters

By now the function acknowledges the special formatter ikiwiki and ignores everything else.

dump_as_ikiwiki( )

After a succesfull parse of the POD source, this object method returns a IkiWiki source file.

verbatim( )

Verbatim copy of the source paragraph without interpolating.

textblock( )

Interpolate, clean and save the paragraph and respect the indentation.

interior_sequence( )

This function support several special sequences, such as italic text, bold text, code text, filename, non-breaking spaces and some escaped characters.

On the other hand it provides support for POD links and ikiwiki metalinks. If the link begins with a scheme name such as http or ftp the function make a direct link; otherwise it builds a ikiwiki link.

DIAGNOSTICS

A list of every error and warning message that the module can generate.

CONFIGURATION AND ENVIRONMENT

Don't need any special configuration or environment changes.

DEPENDENCIES

Pod::Parser

BUGS AND LIMITATIONS

There are no known bugs in this module; please report problems to the author. Patches are welcome also.

AUTHOR

Victor Moral <victor@taquiones.net>

LICENSE AND COPYRIGHT

Copyright (C) 2007 <Victor Moral>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.