Pod::Tree::PerlBin: Translate program pods to html

SYNOPSIS

  $perl_map = new Pod::Tree::PerlMap;
  $perl_bin = new Pod::Tree::PerlBin $perl_dir, $HTML_dir, $perl_map, %opts;

  $perl_bin->scan(@path);
  $perl_bin->index;
  $perl_bin->translate;

  $top = $perl_bin->get_top_entry;

DESCRIPTION

\*(C`Pod::Tree::PerlBin\*(C' translates program PODs to \s-1HTML\s0.

It searches for programs in a list of directories (typically a \s-1PATH\s0), and searches for PODs withing the programs. Only text (-T) files are considered.

\*(C`Pod::Tree::PerlBin\*(C' generates a top-level index of all the program PODs, and writes it to HTML_dir\*(C`/bin.html\*(C'.

\*(C`Pod::Tree::PerlBin\*(C' generates and uses an index of the PODs that it finds to construct \s-1HTML\s0 links. Other modules can also use this index.

METHODS

Creates and returns a new \*(C`Pod::Tree::PerlBin\*(C' object. $HTML_dir is the directory where \s-1HTML\s0 files will be written. $perl_map maps program names to URLs. %options are passed through to \*(C`Pod::Tree::HTML\*(C'. The $perl_dir argument is included for consistency with the other \*(C`Pod::Tree::Perl*\*(C' modules, but is currently unused. Scans all the directories in @path for program PODs. Only text (-T) files are considered. The search does not recurse through subdirectories. Each \s-1POD\s0 that is located is entered into $perl_map. Generates a top-level index of all the program PODs, and writes it to HTML_dir\*(C`/bin.html\*(C'. Translates each program \s-1POD\s0 found by \*(C`scan\*(C' to \s-1HTML\s0. The \s-1HTML\s0 pages are written to HTML_dir. Returns a hash reference of the form { URL => $URL, description => $description } \*(C`Pod::Tree::PerlTop\*(C' uses this to build a top-level index of all the Perl PODs.

LINKING

\*(C`Pod::Tree::PerlBin\*(C' expects the second paragraph of the \s-1POD\s0 to have the form

name - description

and enters name into $perl_map. To link to a program \s-1POD\s0 from another \s-1POD\s0, write

L<name>

REQUIRES

5.005 File::Find HTML::Stream Pod::Tree Pod::Tree::HTML Pod::Tree::PerlUtil

EXPORTS

Nothing.

RELATED TO Pod::Tree::PerlBin…

\*(C`Pod::Tree::HTML\*(C', \*(C`Pod::Tree::PerlMap\*(C',

AUTHOR

Steven McDougall, [email protected]

Pod::Tree::PerlBin (3pm)