Slaven Rezić > Tk-Pod-0.9942 > Tk::Pod::Text

Download:
Tk-Pod-0.9942.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 5.31   Source  

NAME ^

Tk::Pod::Text - Pod browser widget

SYNOPSIS ^

    use Tk::Pod::Text;

    $pod = $parent->Scrolled("PodText",
                             -file       => $file,
                             -scrollbars => "osoe",
                            );

    $file = $pod->cget('-path');   # ?? the name path is confusing :-(

DESCRIPTION ^

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

OPTIONS ^

-file

The named (pod) file to be displayed.

-path

Return the expanded path of the currently displayed Pod. Useable only with the cget method.

-poddone

A callback to be called if parsing and displaying of the Pod is done.

-wrap

Set the wrap mode. Default is word.

-scrollbars

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.

ENVIRONMENT ^

TKPODDEBUG

Turn debugging mode on if set to a true value.

TKPODPRINT

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 ...
TKPODEDITOR

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.

TKPODMANVIEWER

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.

SEE ALSO ^

Tk::More Tk::Pod Tk::Pod::SimpleBridge Tk::Pod::Styles Tk::Pod::Search Tk::Pod::Search_db perlpod tkpod perlindex

KNOWN BUGS ^

See TODO file of Tk-Pod distribution

POD TO VERIFY PodText WIDGET ^

For PodText see Tk::Pod::Text.

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:

auml: ä ä,
Auml: Ä Ä,
ouml: ö ö,
Ouml: Ö Ö,
Uuml: ü ü,
Uuml: Ü Ü,
sz: ß ß.

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

    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:

  1. First
  2. Second
  3. Thirs

Itemize with bullets:

TESTING HEAD1 ^

TESTING HEAD2

TESTING HEAD3

TESTING HEAD4

Other Pod docu: Tk::Font, Tk::BrowseEntry (not underlined, but double-clickable in Tk::Pod)

AUTHOR ^

Nick Ing-Simmons <nick@ni-s.u-net.com>

Current maintainer is Slaven Rezić <slaven@rezic.de>.

Copyright (c) 1998 Nick Ing-Simmons. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: