NAME

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

VERSION

This describes version 0.42 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.

INSTALLATION

Installation needs will vary depending on the particular setup a person has.

Administrator, Automatic

If you are the administrator of the system, then the dead simple method of installing the modules is to use the CPAN or CPANPLUS system.

cpanp -i Posy::Plugin::Pod

This will install this plugin in the usual places where modules get installed when one is using CPAN(PLUS).

Administrator, By Hand

If you are the administrator of the system, but don't wish to use the CPAN(PLUS) method, then this is for you. Take the *.tar.gz file and untar it in a suitable directory.

To install this module, run the following commands:

perl Build.PL
./Build
./Build test
./Build install

Or, if you're on a platform (like DOS or Windows) that doesn't like the "./" notation, you can do this:

perl Build.PL
perl Build
perl Build test
perl Build install

User With Shell Access

If you are a user on a system, and don't have root/administrator access, you need to install Posy somewhere other than the default place (since you don't have access to it). However, if you have shell access to the system, then you can install it in your home directory.

Say your home directory is "/home/fred", and you want to install the modules into a subdirectory called "perl".

Download the *.tar.gz file and untar it in a suitable directory.

perl Build.PL --install_base /home/fred/perl
./Build
./Build test
./Build install

This will install the files underneath /home/fred/perl.

You will then need to make sure that you alter the PERL5LIB variable to find the modules, and the PATH variable to find the scripts (posy_one, posy_static).

Therefore you will need to change: your path, to include /home/fred/perl/script (where the script will be)

PATH=/home/fred/perl/script:${PATH}

the PERL5LIB variable to add /home/fred/perl/lib

PERL5LIB=/home/fred/perl/lib:${PERL5LIB}

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.