pod::tree::perllib(3pm) [debian man page]

Pod::Tree::PerlLib(3pm) 				User Contributed Perl Documentation				   Pod::Tree::PerlLib(3pm)

NAME

       Pod::Tree::PerlLib - translate module PODs to HTML

SYNOPSIS

	 $perl_map = new Pod::Tree::PerlMap;
	 $perl_lib = new Pod::Tree::PerlLib $perl_dir, $HTML_dir, $perl_map, %opts;

	 $perl_lib->scan(@INC);
	 $perl_lib->index;
	 $perl_lib->translate;

	 $top = $perl_lib->get_top_entry;

DESCRIPTION

       "Pod::Tree::PerlLib" translates module PODs to HTML.  It does a recursive subdirectory search through a list of directories (typically
       @INC) to find PODs.

       "Pod::Tree::PerlLib" generates a top-level index of all the PODs that it finds, and writes it to HTML_dir"/lib.html".

       "Pod::Tree::PerlLib" generates and uses an index of the PODs that it finds to construct HTML links.  Other modules can also use this index.

METHODS

       $perl_lib = "new" "Pod::Tree::PerlLib" $perl_dir, $HTML_dir, $perl_map, %options
	   Creates and returns a new "Pod::Tree::PerlLib" object.

	   $HTML_dir is the directory where HTML files will be written.

	   $perl_map maps module names to URLs.

	   %options are passed through to "Pod::Tree::HTML".

	   The $perl_dir argument is included for consistency with the other "Pod::Tree::Perl*" modules, but is currently unused.

       $perl_lib->"scan"(@INC)
	   Does a recursive subdirectory search through @INC to locate module PODs.  Each module that is identified is entered into $perl_map.

       $perl_lib->"index"
	   Generates a top-level index of all the modules.  The index is written to HTML_dir"/lib.html".

       $perl_lib->"translate"
	   Translates each module POD found by "scan" to HTML.	The HTML pages are written to HTML_dir"/lib/", in a subdirectory hierarchy that
	   maps the module names.

       $perl_lib->"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::PerlLib" expects the second paragraph of the POD to have the form

	   Foo::Bar - description

       and enters Foo::Bar into $perl_map.  To link to a module POD, write

	   L<Foo::Bar>

REQUIRES

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

EXPORTS

       Nothing.

SEE ALSO

       "Pod::Tree::HTML", "Pod::Tree::PerlMap"

AUTHOR

       Steven McDougall, swmcd@world.std.com

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.

perl v5.10.1							    2007-04-07						   Pod::Tree::PerlLib(3pm)

Check Out this Related Man Page

Pod::Tree::Pod(3pm)					User Contributed Perl Documentation				       Pod::Tree::Pod(3pm)

NAME

       Pod::Tree::Pod - Convert a Pod::Tree back to a POD

SYNOPSIS

	 use Pod::Tree::Pod;

	 $tree =  new Pod::Tree;

	 $dest =  new IO::File;
	 $dest = "file.pod";

	 $pod  =  new Pod::Tree::Pod $tree, $dest;

	 $pod->translate;

DESCRIPTION

       "Pod::Tree::Pod" converts a Pod::Tree back to a POD.  The destination is fixed when the object is created.  The "translate" method does the
       actual translation.

       For convenience, Pod::Tree::Pod can write the POD to a variety of destinations.	The "new" method resolves the $dest argument.

   Destination resolution
       "Pod::Tree::Pod" can write HTML to either of 2 destinations.  "new" resolves $dest by checking these things, in order:

       1.  If $dest is a reference, then it is taken to be an "IO::File" object that is already open on the file where the POD will be written.

       2.  If $dest is not a reference, then it is taken to be the name of the file where the POD will be written.

METHODS

       $pod = "new" "Pod::Tree::Pod" $tree, $dest
	   Creates a new "Pod::Tree::Pod" object.

	   $tree is a "Pod::Tree" object that represents a POD.  $pod writes the POD to $dest.	See "Destination resolution" for details.

       $pod->"translate"
	   Writes the text of the POD.	This method should only be called once.

DIAGNOSTICS

       "Pod::Tree::Pod::new: not enough arguments"
	   (F) "new" called with fewer than 2 arguments.

       "Pod::Tree::HTML::new: Can't open $dest: $!"
	   (F) The destination file couldn't be opened.

NOTES

       o   The destination doesn't actually have to be an "IO::File" object.  It may be any object that has a "print" method.

SEE ALSO

       perl(1), "Pod::Tree", "Pod::Tree::Node"

AUTHOR

       Steven McDougall, swmcd@world.std.com

COPYRIGHT

       Copyright (c) 2000-2003 by Steven McDougall. This module is free software; you can redistribute it and/or modify it under the same terms as
       Perl itself.

perl v5.10.1							    2004-10-11						       Pod::Tree::Pod(3pm)

Linux and UNIX Man Pages

pod::tree::perllib(3pm) [debian man page]

Check Out this Related Man Page