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::PerlMap(3pm) 				User Contributed Perl Documentation				   Pod::Tree::PerlMap(3pm)

NAME

       Pod::Tree::PerlMap - map names to URLs

SYNOPSIS

	 $perl_map = new Pod::Tree::PerlMap;

	 $perl_map->add_page  ($name, $file);
	 $perl_map->add_func  ($func, $file);
	 $perl_map->force_func(0);
	 $perl_map->force_func(1);
	 $perl_map->set_depth ($depth);

	 ($base, $page, $section) = $perl_map->map($base, $page, $section);

DESCRIPTION

       "Pod::Tree::PerlMap" maps L<> markups to URLs.

       The "Pod::Tree::Perl*" translators make entries in the map.  "Pod::Tree::HTML" uses the map to translate links before it emits them.

METHODS

       $perl_map->"add_page"($name, $file)
	   Map $name to $file.	$name is the name of a POD, as used in L<> markups.  $file is the path to the HTML file that is the target of the
	   link.

       $perl_map->"add_func"($func, $file)
	   Maps $func to $file.  $func is the name of a function described in perlfunc.pod.  $file is the name of the HTML file where it is
	   described.

       $perl_map->"force_func"($state)
	   Controls interpretation of links of the form L<func>.

	   If $state is true, calls to "map" will interpret L<func> as L<perlfunc/func>.

	   If $state is false, calls to "map" will interpret L<func> normally.

       $perl_map->"set_depth"($depth)
	   Informs $perl_map of the depth of the referring page in the HTML directory tree.  $perl_map needs to know this so that it can construct
	   relative links.

       ($base, $page, $section) = $perl_map->"map"($base, $page, $section)
	   Remaps a link.

	   $base is the base URL for the HTML page, if any.  $page is the page given in an L<> markup.	$section is the section given in the L<>
	   markup, if any.

	   "map" returns a new $base, $page, and $section that can be used to construct a link to the HTML page.

REQUIRES

       Nothing.

EXPORTS

       Nothing.

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::PerlMap(3pm)
Man Page