/ 
Posy-0.30
/ Posy::Plugin::Pod

NAME

Posy::Plugin::Pod - Posy plugin to convert POD files to HTML

VERSION

This describes version 0.30 of Posy::Plugin::Pod.

SYNOPSIS

    @plugins = qw(Posy::Core
	...
	Posy::Plugin::EntryTitles
	Posy::Plugin::Pod
	...);
    %file_extensions = (
	txt=>'text',
	html=>'html',
	...
	pm=>'pod',
	pod=>'pod',
    );

DESCRIPTION

This uses the Pod::Simple::HTML module to convert the the POD (Plain Old Documentation) in a .pm or .pod file into HTML. This expects the file_extensions to have been set so that files with appropriate extensions (such as .pm or .pod) will have been set with a file-type of 'pod'. This then converts entries of the 'pod' type.

This replaces the 'parse_entry' method, and calls the parent method for anything other than POD.

This also replaces the 'get_title' method used by Posy::Plugin::EntryTitles, so if one is using that module, one needs to put this after that in the plugin list.

Entry Action Methods

Methods implementing per-entry actions.

parse_entry

$self->parse_entry($flow_state, $current_entry, $entry_state)

Parses $current_entry->{raw} into $current_entry->{title} and $current_entry->{body}

Helper Methods

Methods which can be called from elsewhere.

get_title

$title = $self->get_title($file_id);

Get the title of the given entry file (by reading the file).

Private Methods

_init_pod_obj

Make the Pod::Simple::HTML object.

REQUIRES

Posy
Posy::Core
Pod::Simple::HTML

Test::More

SEE ALSO

perl(1). Posy Pod::Simple::HTML

BUGS

Please report any bugs or feature requests to the author.

AUTHOR

Kathryn Andersen (RUBYKAT)
perlkat AT katspace dot com
http://www.katspace.com

COPYRIGHT AND LICENCE

Copyright (c) 2004-2005 by Kathryn Andersen

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.