Tk::Pod::Text(3pm)

1Pod::Text(3)          User Contributed Perl Documentation         Pod::Text(3)
2
3
4

NAME

6       Tk::Pod::Text - Pod browser widget
7

SYNOPSIS

9           use Tk::Pod::Text;
10
11           $pod = $parent->Scrolled("PodText",
12                                    -file       => $file,
13                                    -scrollbars => "osoe",
14                                   );
15
16           $file = $pod->cget('-path');   # ?? the name path is confusing :-(
17

DESCRIPTION

19       Tk::Pod::Text is a readonly text widget that can display Pod
20       documentation.
21

OPTIONS

23       -file
24           The named (pod) file to be displayed.
25
26       -path
27           Return the expanded path of the currently displayed Pod. Useable
28           only with the "cget" method.
29
30       -poddone
31           A callback to be called if parsing and displaying of the Pod is
32           done.
33
34       -wrap
35           Set the wrap mode. Default is "word".
36
37       -scrollbars
38           The position of the scrollbars, see also Tk::Scrolled. By default,
39           the vertical scrollbar is on the right on Windows systems and on
40           the left on X11 systems.
41
42           Note that it is not necessary and usually will do the wrong thing
43           if you put a "Tk::Pod::Text" widget into a "Scrolled" component.
44
45       Other options are propagated to the embedded Tk::More widget.
46

ENVIRONMENT

48       TKPODDEBUG
49           Turn debugging mode on if set to a true value.
50
51       TKPODPRINT
52           Use the specified program for printing the current pod. If the
53           string contains a %s, then filename substitution is used, otherwise
54           the filename of the Pod document is appended to the value of
55           "TKPODPRINT". Here is a silly example to send the Pod to a web
56           browser:
57
58               env TKPODPRINT="pod2html %s > %s.html; galeon %s.html" tkpod ...
59
60       TKPODEDITOR
61           Use the specified program for editing the current pod. If
62           "TKPODEDITOR" is not specified then the first defined value of
63           "XEDITOR", "VISUAL", or "EDITOR" is used on Unix. As a last
64           fallback, "ptked" or "vi" are used, depending on platform and
65           existance of a terminal.
66
67       TKPODMANVIEWER
68           Use the specified program as the manpage viewer. The manpage viewer
69           should accept a manpage URL ("man://"manpage(section)).
70           Alternatively the special viewer "internal" may be used. As
71           fallback, the default GNOME and/or KDE manpage viewer will be
72           called.
73

KNOWN BUGS

79       See TODO file of Tk-Pod distribution
80

POD TO VERIFY PodText WIDGET

82       For PodText see Tk::Pod::Text.
83
84       A "fixed width" font.
85
86       Text in slant italics.
87
88       A <=for> paragraph is hidden between here
89
90       and there.
91
92       A file: /usr/local/bin/perl.  A variable $a without markup.
93
94       boofar is in S<>.
95
96       Indexed items are not supported in Tk::Pod.
97
98       Zero-effect formatting.
99
100       German umlauts:
101
102       auml: ä ä,
103       Auml: Ä Ä,
104       ouml: ö ö,
105       Ouml: Ö Ö,
106       Uuml: ü ü,
107       Uuml: Ü Ü,
108       sz: ß ß.
109
110       Unicode outside Latin1 range: € (euro sign).
111
112       Pod with umlaut: ExtUtils::MakeMaker.
113
114       Details:  perlpod or perl, perlfunc.
115
116       External links: <http://www.cpan.org> (URL), URL with link text
117       <http://www.cpan.org>, perl(1) (man page), Berliner Fernsehturm
118       <geo:52.520685,13.409461> (geo: URL)
119
120       Links to local sections: a section (SYNOPSIS), an item (-file,
121       currently wrong), a working item (auml).
122
123       Links to external sections: a section (DESCRIPTION in perl.pod), an
124       item (Uncuddled elses in perlstyle.pod).
125
126       Here some code in a as is paragraph
127
128           use Tk;
129           my $mw = MainWindow->new;
130           ...
131           MainLoop
132           __END__
133
134       Fonts: "fixed", bold, italics, normal, or file /path/to/a/file
135
136       Mixed Fonts: "bold-fixed", bold-italics
137
138       Non-breakable text: The quick brown fox jumps over the lazy fox.
139
140       Modern Pod constructs (multiple <>): italic, "fixed with embedded < and
141       >".
142
143       Itemize with numbers:
144
145       1.  First
146
147       2.  Second
148
149       3.  Thirs
150
151       Itemize with bullets:
152
153       •   First
154
155       •   Second
156
157       •   Thirs
158

TESTING HEAD1

160   TESTING HEAD2
161       TESTING HEAD3
162
163       TESTING HEAD4
164
165       Other Pod docu: Tk::Font, Tk::BrowseEntry (not underlined, but double-
166       clickable in Tk::Pod)
167

AUTHOR

169       Nick Ing-Simmons <nick@ni-s.u-net.com>
170
171       Current maintainer is Slaven Rezić <slaven@rezic.de>.
172
173       Copyright (c) 1998 Nick Ing-Simmons.  Copyright (c) 2015 Slaven Rezic.
174       All rights reserved. This program is free software; you can
175       redistribute it and/or modify it under the same terms as Perl itself.
176

POD ERRORS

178       Hey! The above document had some coding errors, which are explained
179       below:
180
181       Around line 1564:
182           Non-ASCII character seen before =encoding in 'ä,'. Assuming CP1252
183
184
185
186perl v5.34.0                      2021-07-23                      Pod::Text(3)