pod::tree::pod(3pm) [debian 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)

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

NAME

       Pod::Tree::PerlFunc - translate perlfunc.pod to HTML

SYNOPSIS

	 $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;

DESCRIPTION

       "Pod::Tree::PerlFunc" translates perlfunc.pod to HTML.  It creates a separate HTML 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/.

       "Pod::Tree::PerlFunc" generates and uses an index of the functions that it finds in perlfunc.pod to construct HTML links.  Other modules
       can also use this index.

METHODS

       $perl_func = "new" "Pod::Tree::PerlFunc" $perl_dir, $HTML_dir, $perl_map, %options
	   Creates and returns a new "Pod::Tree::PerlFunc" 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 function names to URLs.

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

       $perl_func->"scan"
	   Reads perlfunc.pod and identifies all the functions in it.  Each function that is identified is entered into $perl_map.

       $perl_func->"index"
	   Generates a top-level index of all the functions.  The index is written to HTML_dir"/pod/perlfunc.html".

       $perl_func->"translate"
	   Translates each function found by "scan" to HTML.  The HTML pages are written to HTML_dir"/pod/func/".

LINKING

       "Pod::Tree::PerlFunc" indexes every "=item" paragraph in perlfunc.html. To link, for example, to the "abs" function, write

	   L<func/abs>

REQUIRES

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

perl v5.10.1							    2006-04-17						  Pod::Tree::PerlFunc(3pm)