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

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

NAME

       Tk::Pod::Tree - list Pod file hierarchy

SYNOPSIS

	   use Tk::Pod::Tree;

	   $parent->PodTree;

WIDGET-SPECIFIC OPTIONS
       Name: -showcommand
	   Specifies a callback for selecting a Pod module (Button-1 binding).

       Name: -showcommand2
	   Specifies a callback for selecting a Pod module in a different window (Button-2 binding).

       Name: -usecache
	   True, if a cache of Pod modules should be created and used. The default is true.

DESCRIPTION

       The Tk::Pod::Tree widget shows all available Perl Pod documentation in a tree.

WIDGET METHODS

       $tree->Fill(?-nocache => 1?, ?-forked => 0|1?, ?-fillcb => ...?)
	   Find Pod modules and fill the tree widget. If -nocache is specified, then no cache will be used for loading.

	   A cache of Pod modules is written unless the -usecache configuration option of the widget is set to false.

	   If "-forked" is specified, then searching for Pods is done in the background, if possible. Note that the default is currently
	   unspecified.

	   A callback may be specified with the "-fillcb" option and will be called after the tree is filled.

       $tree->SeePath($path)
	   Move the anchor/selection and view to the given $path and open subtrees to make the $path visible, if necessary.

SEE ALSO

       Tk::Tree, Tk::Pod, tkpod, Tk::Pod::FindPods.

AUTHOR

       Slaven ReziX <slaven@rezic.de>

       Copyright (c) 2001,2004 Slaven ReziX.  All rights reserved.  This program is free software; you can redistribute it and/or modify it under
       the same terms as Perl itself.

perl v5.14.2							    2012-03-05							    Pod::Tree(3pm)

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

NAME

       Pod::Tree::PerlTop - generate a top-level index for Perl PODs

SYNOPSIS

	 $perl_map = new Pod::Tree::PerlMap;
	 $perl_top = new Pod::Tree::PerlTop $perl_dir, $HTML_dir, $perl_map, %opts;

	 $perl_top->index(@translators);
	 $perl_top->translate;

	 $top = $perl_top->get_top_entry;

DESCRIPTION

       "Pod::Tree::PerlTop" generates a top-level index for Perl PODs.

       It also translates perl.pod to perl.html The translator is specially hacked to insert links into the big verbatim paragraph that lists all
       the other Perl PODs.

METHODS

       $perl_top = "new" "Pod::Tree::PerlTop" $perl_dir, $HTML_dir, $perl_map, %options
	   Creates and returns a new "Pod::Tree::PerlTop" 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 POD names to URLs.  "Pod::Tree::PerlTop" uses it to resolve links in the perl.pod page.

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

       $perl_top->"index"(@translators)
	   Generates a top-level index of all the PODs.  The index is written to HTML_dir"/index.html".

	   @translators is a list of other "Pod::Tree::Perl*" translator objects.  "index" makes a "get_top_entry" call on each of them to obtain
	   URLs and descriptions of the pages that it links to.

       $perl_top->"translate"
	   Translates the perl.pod file to HTML.  The HTML page is written to HTML_dir"/pod/perl.html"

       $perl_top->"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.

REQUIRES

	   5.005;
	   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							    2006-04-17						   Pod::Tree::PerlTop(3pm)