NAME

Pod::Tree::PerlDist - translate Perl distribution documentation to HTML

SYNOPSIS

  $perl_map  = Pod::Tree::PerlMap->new;
  $perl_dist = Pod::Tree::PerlDist->new( $perl_dir, $HTML_dir, $perl_map, %opts );
  $perl_dist->scan;
  $perl_dist->index;
  $perl_dist->translate;
  $top = $perl_dist->get_top_entry;

DESCRIPTION

"Pod::Tree::PerlDist" translates documents in the Perl distribution to HTML. These include Changes, README, and assored other files that appear in the top level of the Perl source tree.

Files that contain PODs are parsed as PODs; files that do not contain PODs are converted to HTML as preformatted text.

"Pod::Tree::PerlDist" generates and uses an index of the files that it finds to construct HTML links. Other modules can also use this index.

METHODS

$perl_dist = "new" "Pod::Tree::PerlDist" $perl_dir, $HTML_dir, $perl_map, %options

Creates and returns a new "Pod::Tree::PerlDist" 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 file names to URLs.

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

$perl_dist->"scan"

Scans the top level of the Perl source tree for documentation files. Files that do not generally contain user-level documentation, such as source files, are ignored. The search does not recurse through subdirectories.

Each file that is located is entered into $perl_map.

$perl_dist->"index"

Generates a top-level index of all the distribution documents, and writes it to HTML_dir"/dist.html".

$perl_dist->"translate"

Translates each distribution document found by "scan" to HTML. The HTML pages are written to HTML_dir.

$perl_dist->"get_top_entry"

Returns a hash reference of the form

  { URL         => $URL,
    description => $description }

"Pod::Tree::PerlTop" uses this to build a top-level index of all the Perl PODs.

LINKING

"Pod::Tree::PerlDist" indexes files by their name. To link to a file named README.win32 write

    L<README.win32>

REQUIRES

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

EXPORTS

Nothing.

AUTHOR

Steven McDougall, swmcd@world.std.com