Pod::Tree::PerlPod - translate Perl PODs to HTML
$perl_map = Pod::Tree::PerlMap->new; $perl_pod = Pod::Tree::PerlPod->new( $perl_dir, $HTML_dir, $perl_map, %opts ); $perl_pod->scan; $perl_pod->index; $perl_pod->translate; $top = $perl_pod->get_top_entry;
Pod::Tree::PerlPod translates Perl PODs to HTML. It does a recursive subdirectory search through $perl_dir to find PODs.
Pod::Tree::PerlPod
Pod::Tree::PerlPod generates a top-level index of all the PODs that it finds, and writes it to HTML_dir/pod.html.
/pod.html
Pod::Tree::PerlPod generates and uses an index of the PODs that it finds to construct HTML links. Other modules can also use this index.
new
Creates and returns a new Pod::Tree::PerlPod 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 POD names to URLs.
%options are passed through to Pod::Tree::HTML.
Pod::Tree::HTML
scan
Does a recursive subdirectory search through $perl_dir to locate PODs. Each POD that is located is entered into $perl_map.
index
Generates a top-level index of all the PODs. The index is written to HTML_dir/pod.html.
translate
Translates each POD found by scan to HTML. The HTML pages are written to HTML_dir, in a subdirectory hierarchy that mirrors the the Perl source distribution.
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.
Pod::Tree::PerlTop
Pod::Tree::PerlPod indexes PODs by the base name of the POD file. To link to perlsub.pod, write
L<perlsub>
5.005; File::Find; HTML::Stream; IO::File; Pod::Tree::HTML; Pod::Tree::PerlUtil;
Nothing.
Pod::Tree::HTML, Pod::Tree::PerlMap,
Pod::Tree::PerlMap
Steven McDougall, swmcd@world.std.com
Copyright (c) 2000 by Steven McDougall. This module is free software; you can redistribute it and/or modify it under the same terms as Perl.
To install Pod::Tree, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Tree
CPAN shell
perl -MCPAN -e shell install Pod::Tree
For more information on module installation, please visit the detailed CPAN module installation guide.