Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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

NAME

       Pod::Tree::PerlDist - translate Perl distribution documentation to HTML

SYNOPSIS

	 $perl_map  = new Pod::Tree::PerlMap;
	 $perl_dist = new Pod::Tree::PerlDist $perl_dir, $HTML_dir, $perl_map, %opts;

	 $perl_dist->scan;
	 $perl_dist->index;
	 $perl_dist->translate;

	 $top = $perl_dist->get_top_entry;

DESCRIPTION

       "Pod::Tree::PerlDist" translates documents in the Perl distribution to HTML. These include Changes, README, and assored other files that
       appear in the top level of the Perl source tree.

       Files that contain PODs are parsed as PODs; files that do not contain PODs are converted to HTML as preformatted text.

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

METHODS

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

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

       $perl_dist->"scan"
	   Scans the top level of the Perl source tree for documentation files.  Files that do not generally contain user-level documentation,
	   such as source files, are ignored.  The search does not recurse through subdirectories.

	   Each file that is located is entered into $perl_map.

       $perl_dist->"index"
	   Generates a top-level index of all the distribution documents, and writes it to HTML_dir"/dist.html".

       $perl_dist->"translate"
	   Translates each distribution document found by "scan" to HTML.  The HTML pages are written to HTML_dir.

       $perl_dist->"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::PerlDist" indexes files by their name.  To link to a file named README.win32 write

	   L<README.win32>

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							    2004-10-11						  Pod::Tree::PerlDist(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)
Man Page