NAME
SYNOPSIS
DESCRIPTION
METHODS
LINKING
REQUIRES
EXPORTS
SEE ALSO
AUTHOR
COPYRIGHT

NAME

Pod::Tree::PerlFunc - translate perlfunc.pod to HTML

SYNOPSIS

  $perl_map  = new Pod::Tree::PerlMap;
  $perl_func = new Pod::Tree::PerlFunc $perl_dir, $HTML_dir, $perl_map, %opts;

  $perl_func->scan;
  $perl_func->index;
  $perl_func->translate;

DESCRIPTION

Pod::Tree::PerlFunc translates perlfunc.pod to HTML. It creates a separate HTML page for each function description in perlfunc.pod. The pages for the individual descriptions are named after the function and written to a func/ subdirectory. perlfunc.html is generated as an index to all the pages in func/.

Pod::Tree::PerlFunc generates and uses an index of the functions that it finds in perlfunc.pod to construct HTML links. Other modules can also use this index.

METHODS

$perl_func = new Pod::Tree::PerlFunc $perl_dir, $HTML_dir, $perl_map, %options

Creates and returns a new Pod::Tree::PerlFunc object.

$perl_dir is the root of the Perl source tree.

$HTML_dir is the directory where HTML files will be written.

$perl_map maps function names to URLs.

%options are passed through to Pod::Tree::HTML.

$perl_func->scan

Reads perlfunc.pod and identifies all the functions in it. Each function that is identified is entered into $perl_map.

$perl_func->index

Generates a top-level index of all the functions. The index is written to HTML_dir/pod/perlfunc.html.

$perl_func->translate

Translates each function found by scan to HTML. The HTML pages are written to HTML_dir/pod/func/.

LINKING

Pod::Tree::PerlFunc indexes every =item paragraph in perlfunc.html. To link, for example, to the abs function, write

    L<func/abs>

REQUIRES

    5.005;
    Pod::Tree;
    Pod::Tree::HTML;
    Pod::Tree::PerlUtil;

EXPORTS

Nothing.

AUTHOR

Steven McDougall, swmcd@world.std.com