Tk::Pod::Text - Pod browser widget |
Tk::Pod::Text - Pod browser widget
use Tk::Pod::Text;
$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.
cget
method.
word
.
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 the Tk::More manpage widget.
%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 ...
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.
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 the Tk::Pod::Text manpage.
A fixed width
font.
Text in slant italics.
A <=for> paragraph is hidden between here
and there.
A file: /usr/local/bin/perl. A variable $a without markup.
boofar is in S<>.
Indexed items are not supported in Tk::Pod.
Zero-effect formatting.
German umlauts:
Unicode outside Latin1 range: &0x20ac; (euro sign).
Pod with umlaut: the ExtUtils::MakeMaker manpage.
Details: the perlpod manpage 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
use Tk; my $mw = MainWindow->new; ... MainLoop __END__
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 >
.
Itemize with numbers:
Itemize with bullets:
Other Pod docu: Tk::Font, Tk::BrowseEntry (not underlined, but double-clickable in Tk::Pod)
Nick Ing-Simmons <nick@ni-s.u-net.com>
Current maintainer is Slaven Rezi&0x107; <slaven@rezic.de>.
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.
Tk::Pod::Text - Pod browser widget |