Pod::Tree::PerlPod(3pm) | User Contributed Perl Documentation | Pod::Tree::PerlPod(3pm) |
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" generates a top-level index of all the PODs that it finds, and writes it to HTML_dir"/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.
$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".
{ URL => $URL, description => $description }
"Pod::Tree::PerlTop" uses this to build a top-level index of all the Perl PODs.
"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",
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.
2022-11-19 | perl v5.36.0 |