1
2=head1 NAME
3
4Tk::Pod_usage - How to use the perl/Tk Pod browser widget
5
6=head1 DESCRIPTION
7
8To navigate through the documentation one could use
9
10=head2 Hyperlinks
11
12A B<click> on a hyperlink display the corresponding Pod documentation
13(if there is any) in the same window. An URL will be displayed in a
14web browser. A man page will be displayed in a man viewer (if one is
15available).
16
17With <Button-2> the documentation is loaded into a new window
18(<Shift-Button-1> works also for those with only a 2 button mouse).
19
20=head2 Selection
21
22A B<double click> tries to load the documentation for the selected
23word in the same window.
24
25If the C<Shift> key is simultaneously pressed a new browser window
26is opened.
27
28=head2 Key bindings
29
30The L<Tk::Pod::Text> widget is based on the L<Tk::More> widget
31inheriting its key bindings.
32
33=head2 Search
34
35Pressing <Key-/> lets you search in the displayed documentation.
36
37=head2 Section Menu
38
39The Section Menu
40
41The 'Section' menu allows one to directly jump to the start of a
42section in the documentation.
43
44=head2 Action Menu
45
46If you press the right mouse button you get a popup menu
47that allows:
48
49=over 4
50
51=item o Back
52
53in history of displayed documentation
54
55=item o Forward
56
57in history of displayed documentation
58
59=item o Reload
60
61the documentation
62
63=item o Edit Pod
64
65Start editor with source of the displayed document.
66
67The used editor is selected by the first definition of the environment
68variables C<TKPODEDITOR>, C<XEDITOR>, C<VISUAL>, C<EDITOR> or as default
69F</usr/bin/vi>. If no terminal is available (or on Windows platforms),
70the L<ptked|ptked> editor (bundled with Perl/Tk) will be used instead.
71
72See also the menu entries 'File' -E<gt> 'Edit' and 'File' -E<gt> 'Edit
73with ptked'.
74
75=item o Search fulltext
76
77Full text search of the Pod in the perl library directories. (Note: to
78use it one has to install the perlindex distribution and build an
79index for the perl documentation, see L<Text::English|Text::English>)
80
81=back
82
83The remaining menu entries are the same as in normal C<Text> widgets.
84
85=head2 Tree view
86
87You can toggle the tree view of all installed modules on or off with
88the 'View' -E<gt> 'Pod Tree' menu entry. The tree view is organized in
89three sections: Perl language (general documentation about Perl),
90Pragmata, and Modules. The labels in the tree are colored, where green
91means E<quot>standard module which comes with the Perl core
92distributionE<quot>, red means E<quot>locally installed module,
93probably from CPANE<quot>, and grey means E<quot>no module available,
94look at the subtreeE<quot>.
95
96The tree data is cached in a temporary directory on a per-perl-version
97and per-user basis. A reload can be forced with the B<Reload> entry in
98the action menu of the tree view. With the B<Search> entry a search in
99the tree can be performed. The B<Show modules at CPAN> entry is highly
100experimental - you can download, extract and look at the
101documentation of all CPAN modules.
102
103=head1 SEE ALSO
104
105L<tkpod>,
106L<perlpod>,
107L<pod2man>,
108L<pod2text>,
109L<pod2html>,
110L<Tk::Pod>,
111L<Tk::Pod::Text>,
112L<Tk::Pod::Tree>,
113L<Tk::More>,
114L<Text::English>.
115
116=head1 KEYWORDS
117
118pod, browser, tk, hypertext
119
120=head1 AUTHOR
121
122Achim Bohnet <F<ach@mpe.mpg.de>>
123
124Current maintainer is Slaven Rezic <F<slaven@rezic.de>>
125
126Copyright (c) 1997-1998 Achim Bohnet. All rights reserved.  This
127documentation is free software; you can redistribute it and/or modify
128it under the same terms as Perl itself.
129
130=cut
131
132