1Gtk2::Ex::PodViewer::PaUrsseerr(C3o)ntributed Perl DocumGetnkt2a:t:iEoxn::PodViewer::Parser(3)
2
3
4

NAME

6       Gtk2::Ex::PodViewer::Parser - a custom POD Parser for
7       Gtk2::Ex::PodViewer.
8

SYNOPSIS

10               $Gtk2::Ex::PodViewer::Parser::LINK_TEXT_TEMPLATE = '{section} in the {document} manpage';
11
12               my $parser = Gtk2::Ex::PodViewer::Parser->new(
13                       buffer  => $Gtk2TextView->get_buffer,
14               );
15
16               $parser->parse_from_file($file);
17

DESCRIPTION

19       Gtk2::Ex::PodViewer::Parser is a custom Pod parser for the
20       Gtk2::Ex::PodViewer widget. You should never need to use it directly.
21
22       It is based on Pod::Parser.
23

METHODS

25       One neat method not implemented by Pod::Parser is
26
27               $parser->parse_from_string($string);
28
29       This parses a scalar containing POD data, using IO::Scalar to create a
30       tied filehandle.
31

IMPORTABLE FUNCTIONS

33               use Gtk2::Ex::PodViewer::Parser qw(decode_entities);
34               my $text = decode_entities($pod);
35
36       This function takes a string of POD, and returns it with all the POD
37       entities (eg "E<gt>" => ">") decoded into readable characters.
38

VARIABLES

40       The $LINK_TEXT_TEMPLATE class variable contains a string that is used
41       to generate link text for POD links for the form
42
43               LE<lt>foo/barE<gt>
44
45       This string is run through the gettext() function from Locale::gettext
46       (if installed) before it is used, so if your application supports
47       internationalisation, then the string will be translated if it appears
48       in your translation domain. It contains two tokens, "{section}" and
49       "{document}", that are replaced with "foo" and "bar" respectively.
50

SEE ALSO

52       •   Gtk2::Ex::PodViewer
53
54       •   Pod::Parser
55
56       •   Locale::gettext
57

AUTHORS

59       Gavin Brown, Torsten Schoenfeld and Scott Arrington.
60

62       (c) 2003-2005 Gavin Brown (gavin.brown@uk.com). All rights reserved.
63       This program is free software; you can redistribute it and/or modify it
64       under the same terms as Perl itself.
65
66
67
68perl v5.36.0                      2023-01-20    Gtk2::Ex::PodViewer::Parser(3)
Impressum