.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::Tree::PerlTop 3pm"
.TH Pod::Tree::PerlTop 3pm "2019-02-25" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pod::Tree::PerlTop \- generate a top\-level index for Perl PODs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  $perl_map = Pod::Tree::PerlMap\->new;
\&  $perl_top = Pod::Tree::PerlTop\->new( $perl_dir, $HTML_dir, $perl_map, %opts );
\&  
\&  $perl_top\->index(@translators);
\&  $perl_top\->translate;
\&  
\&  $top = $perl_top\->get_top_entry;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Pod::Tree::PerlTop\*(C'\fR generates a top-level index for Perl PODs.
.PP
It also translates \fIperl.pod\fR to \fIperl.html\fR
The translator is specially hacked to insert links into the big verbatim
paragraph that lists all the other Perl PODs.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "\fI\f(CI$perl_top\fI\fR = ""new"" ""Pod::Tree::PerlTop"" \fI\f(CI$perl_dir\fI\fR, \fI\f(CI$HTML_dir\fI\fR, \fI\f(CI$perl_map\fI\fR, \fI\f(CI%options\fI\fR" 4
.el .IP "\fI\f(CI$perl_top\fI\fR = \f(CWnew\fR \f(CWPod::Tree::PerlTop\fR \fI\f(CI$perl_dir\fI\fR, \fI\f(CI$HTML_dir\fI\fR, \fI\f(CI$perl_map\fI\fR, \fI\f(CI%options\fI\fR" 4
.IX Item "$perl_top = new Pod::Tree::PerlTop $perl_dir, $HTML_dir, $perl_map, %options"
Creates and returns a new \f(CW\*(C`Pod::Tree::PerlTop\*(C'\fR object.
.Sp
\&\fI\f(CI$perl_dir\fI\fR is the root of the Perl source tree.
.Sp
\&\fI\f(CI$HTML_dir\fI\fR is the directory where \s-1HTML\s0 files will be written.
.Sp
\&\fI\f(CI$perl_map\fI\fR maps \s-1POD\s0 names to URLs.
\&\f(CW\*(C`Pod::Tree::PerlTop\*(C'\fR uses it to resolve links in the \fIperl.pod\fR page.
.Sp
\&\fI\f(CI%options\fI\fR are passed through to \f(CW\*(C`Pod::Tree::HTML\*(C'\fR.
.ie n .IP "\fI\f(CI$perl_top\fI\fR\->""index""(\fI\f(CI@translators\fI\fR)" 4
.el .IP "\fI\f(CI$perl_top\fI\fR\->\f(CWindex\fR(\fI\f(CI@translators\fI\fR)" 4
.IX Item "$perl_top->index(@translators)"
Generates a top-level index of all the PODs. 
The index is written to \fIHTML_dir\fR\f(CW\*(C`/index.html\*(C'\fR.
.Sp
\&\fI\f(CI@translators\fI\fR is a list of other \f(CW\*(C`Pod::Tree::Perl*\*(C'\fR translator objects.
\&\f(CW\*(C`index\*(C'\fR makes a \f(CW\*(C`get_top_entry\*(C'\fR call on each of them to obtain
URLs and descriptions of the pages that it links to.
.ie n .IP "\fI\f(CI$perl_top\fI\fR\->""translate""" 4
.el .IP "\fI\f(CI$perl_top\fI\fR\->\f(CWtranslate\fR" 4
.IX Item "$perl_top->translate"
Translates the \fIperl.pod\fR file to \s-1HTML.\s0
The \s-1HTML\s0 page is written to \fIHTML_dir\fR\f(CW\*(C`/pod/perl.html\*(C'\fR
.ie n .IP "\fI\f(CI$perl_top\fI\fR\->""get_top_entry""" 4
.el .IP "\fI\f(CI$perl_top\fI\fR\->\f(CWget_top_entry\fR" 4
.IX Item "$perl_top->get_top_entry"
Returns a hash reference of the form
.Sp
.Vb 2
\&  { URL         => $URL,
\&    description => $description }
.Ve
.Sp
\&\f(CW\*(C`Pod::Tree::PerlTop\*(C'\fR uses this to build a top-level index of all the 
Perl PODs.
.SH "REQUIRES"
.IX Header "REQUIRES"
.Vb 3
\&    5.005;
\&    Pod::Tree::HTML;
\&    Pod::Tree::PerlUtil;
.Ve
.SH "EXPORTS"
.IX Header "EXPORTS"
Nothing.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`Pod::Tree::HTML\*(C'\fR, \f(CW\*(C`Pod::Tree::PerlMap\*(C'\fR,
.SH "AUTHOR"
.IX Header "AUTHOR"
Steven McDougall, swmcd@world.std.com
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
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.