Pod::Tree::PerlFunc (3pm)

  $perl_map  = new Pod::Tree::PerlMap;
  $perl_func = new Pod::Tree::PerlFunc $perl_dir, $HTML_dir, $perl_map, %opts;

  $perl_func->scan;
  $perl_func->index;
  $perl_func->translate;

\*(C`Pod::Tree::PerlFunc\*(C' translates perlfunc.pod to \s-1HTML\s0. It creates a separate \s-1HTML\s0 page for each function description in perlfunc.pod. The pages for the individual descriptions are named after the function and written to a func/ subdirectory. perlfunc.html is generated as an index to all the pages in func/.

\*(C`Pod::Tree::PerlFunc\*(C' generates and uses an index of the functions that it finds in perlfunc.pod to construct \s-1HTML\s0 links. Other modules can also use this index.

Creates and returns a new \*(C`Pod::Tree::PerlFunc\*(C' object. $perl_dir is the root of the Perl source tree. $HTML_dir is the directory where \s-1HTML\s0 files will be written. $perl_map maps function names to URLs. %options are passed through to \*(C`Pod::Tree::HTML\*(C'. Reads perlfunc.pod and identifies all the functions in it. Each function that is identified is entered into $perl_map. Generates a top-level index of all the functions. The index is written to HTML_dir\*(C`/pod/perlfunc.html\*(C'. Translates each function found by \*(C`scan\*(C' to \s-1HTML\s0. The \s-1HTML\s0 pages are written to HTML_dir\*(C`/pod/func/\*(C'.

\*(C`Pod::Tree::PerlFunc\*(C' indexes every \*(C`=item\*(C' paragraph in perlfunc.html. To link, for example, to the \*(C`abs\*(C' function, write

L<func/abs>

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

Nothing.

\*(C`Pod::Tree::HTML\*(C', \*(C`Pod::Tree::PerlMap\*(C',

Steven McDougall, [email protected]

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 itself.