Gavin Brown > Gtk2-Ex-PodViewer > Gtk2::Ex::PodViewer::Parser

Download:
Gtk2-Ex-PodViewer-0.18.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  13
Open  0
View/Report Bugs
Source  

NAME ^

Gtk2::Ex::PodViewer::Parser - a custom POD Parser for Gtk2::Ex::PodViewer.

SYNOPSIS ^

        $Gtk2::Ex::PodViewer::Parser::LINK_TEXT_TEMPLATE = '{section} in the {document} manpage';

        my $parser = Gtk2::Ex::PodViewer::Parser->new(
                buffer  => $Gtk2TextView->get_buffer,
        );

        $parser->parse_from_file($file);

DESCRIPTION ^

Gtk2::Ex::PodViewer::Parser is a custom Pod parser for the Gtk2::Ex::PodViewer widget. You should never need to use it directly.

It is based on Pod::Parser.

METHODS ^

One neat method not implemented by Pod::Parser is

        $parser->parse_from_string($string);

This parses a scalar containing POD data, using IO::Scalar to create a tied filehandle.

IMPORTABLE FUNCTIONS ^

        use Gtk2::Ex::PodViewer::Parser qw(decode_entities);
        my $text = decode_entities($pod);

This function takes a string of POD, and returns it with all the POD entities (eg E<gt> => ">") decoded into readable characters.

VARIABLES ^

The $LINK_TEXT_TEMPLATE class variable contains a string that is used to generate link text for POD links for the form

        LE<lt>foo/barE<gt>

This string is run through the gettext() function from Locale::gettext (if installed) before it is used, so if your application supports internationalisation, then the string will be translated if it appears in your translation domain. It contains two tokens, {section} and {document}, that are replaced with foo and bar respectively.

SEE ALSO ^

AUTHORS ^

Gavin Brown, Torsten Schoenfeld and Scott Arrington.

COPYRIGHT ^

(c) 2003-2005 Gavin Brown (gavin.brown@uk.com). 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: