NAME

App::Followme::PodData - Convert Pod files to html

SYNOPSIS

    use App::Followme::PodData;
    my $data = App::Followme::PodData->new();
    my $html = App::Followme::Template->new('example.htm', $data);

DESCRIPTION

This module converts Perl files with POD markup into html and extracts the metadata from the html.

METHODS

All data are accessed through the build method.

my %data = $obj->build($name, $filename);

Build a variable's value. The first argument is the name of the variable. The second argument is the name of the file the metadata is being computed for. If it is undefined, the filename stored in the object is used.

VARIABLES

The Pod metadata class can evaluate the following variables. When passing a name to the build method, the sigil should not be used.

$body

All the contents of the file, minus the title if there is one. Markdown is called on the file's content to generate html before being stored in the body variable.

$description

A one line sentence description of the content.

$title

The title of the page is derived from contents of the top header tag, if one is at the front of the file content, or the filename, if it is not.

CONFIGURATION

The following parameters are used from the configuration:

pod_extension

The extension of files that contain pod documentation. The default value is pm,pod.

pod_directory

The directory containing the pod files

LICENSE

Copyright (C) Bernie Simon.

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

AUTHOR

Bernie Simon <bernie.simon@gmail.com>