Rechercher une page de manuel
Pod::Tree::PerlPod.3pm
Langue: en
Version: 2004-10-11 (ubuntu - 24/10/10)
Section: 3 (Bibliothèques de fonctions)
NAME
Pod::Tree::PerlPod - translate Perl PODs to HTMLSYNOPSIS
$perl_map = new Pod::Tree::PerlMap; $perl_pod = new Pod::Tree::PerlPod $perl_dir, $HTML_dir, $perl_map, %opts; $perl_pod->scan; $perl_pod->index; $perl_pod->translate; $top = $perl_pod->get_top_entry;
DESCRIPTION
"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.
METHODS
- $perl_pod = "new" "Pod::Tree::PerlPod" $perl_dir, $HTML_dir, $perl_map, %options
- 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".
- $perl_pod->"scan";
- Does a recursive subdirectory search through $perl_dir to locate PODs. Each POD that is located is entered into $perl_map.
- $perl_pod->"index"
- Generates a top-level index of all the PODs. The index is written to HTML_dir"/pod.html".
- $perl_pod->"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.
- $perl_pod->"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::PerlPod" indexes PODs by the base name of the POD file. To link to perlsub.pod, writeL<perlsub>
REQUIRES
5.005; File::Find; HTML::Stream; IO::File; Pod::Tree::HTML; Pod::Tree::PerlUtil;
EXPORTS
Nothing.SEE ALSO
"Pod::Tree::HTML", "Pod::Tree::PerlMap",AUTHOR
Steven McDougall, swmcd@world.std.comCOPYRIGHT
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.Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre