Tk::Pod::Text - Pod browser widget
$pod = $parent->Scrolled("PodText",
-file => $file,
-scrollbars => "osoe",
$file = $pod->cget('-path'); # ?? the name path is confusing :-(
Tk::Pod::Text is a readonly text widget that can display Pod documentation.
The named (pod) file to be displayed.
Return the expanded path of the currently displayed Pod. Useable only with the cget method.
A callback to be called if parsing and displaying of the Pod is done.
Set the wrap mode. Default is word.
The position of the scrollbars, see also Tk::Scrolled. By default, the vertical scrollbar is on the right on Windows systems and on the left on X11 systems.
Note that it is not necessary and usually will do the wrong thing if you put a Tk::Pod::Text widget into a Scrolled component.
Other options are propagated to the embedded Tk::More widget.
Turn debugging mode on if set to a true value.
Use the specified program for printing the current pod. If the string contains a %s, then filename substitution is used, otherwise the filename of the Pod document is appended to the value of TKPODPRINT. Here is a silly example to send the Pod to a web browser:
env TKPODPRINT="pod2html %s > %s.html; galeon %s.html" tkpod ...
Use the specified program for editing the current pod. If TKPODEDITOR is not specified then the first defined value of XEDITOR, VISUAL, or EDITOR is used on Unix. As a last fallback, ptked or vi are used, depending on platform and existance of a terminal.
Use the specified program as the manpage viewer. The manpage viewer should accept a manpage URL (man://manpage(section)). Alternatively the special viewer "internal" may be used. As fallback, the default GNOME and/or KDE manpage viewer will be called.
Tk::More Tk::Pod Tk::Pod::SimpleBridge Tk::Pod::Styles Tk::Pod::Search Tk::Pod::Search_db perlpod tkpod perlindex
See TODO file of Tk-Pod distribution
For PodText see Tk::Pod::Text.
A fixed width font.
Text in slant italics.
A <=for> paragraph is hidden between here
A file: /usr/local/bin/perl. A variable $a without markup.
boofar is in S<>.
Indexed items are not supported in Tk::Pod.
Unicode outside Latin1 range: € (euro sign).
Pod with umlaut: ExtUtils::MakeMaker.
Details: perlpod or perl, perlfunc.
External links: http://www.cpan.org (URL), URL with link text, perl(1) (man page), Berliner Fernsehturm (geo: URL)
Links to local sections: a section (SYNOPSIS), an item (-file, currently wrong), a working item (auml).
Links to external sections: a section (DESCRIPTION in perl.pod), an item (Uncuddled elses in perlstyle.pod).
Here some code in a as is paragraph
my $mw = MainWindow->new;
Fonts: fixed, bold, italics, normal, or file /path/to/a/file
Mixed Fonts: bold-fixed, bold-italics
Non-breakable text: The quick brown fox jumps over the lazy fox.
Modern Pod constructs (multiple <>): italic, fixed with embedded < and >.
fixed with embedded < and >
Itemize with numbers:
Itemize with bullets:
Other Pod docu: Tk::Font, Tk::BrowseEntry (not underlined, but double-clickable in Tk::Pod)
Nick Ing-Simmons <email@example.com>
Current maintainer is Slaven Rezić <firstname.lastname@example.org>.
Copyright (c) 1998 Nick Ing-Simmons. Copyright (c) 2015 Slaven Rezic. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in 'ä,'. Assuming CP1252
To install Tk::Pod, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.