GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  GTK2::EX::PODVIEWER::PARSER (3)

.ds Aq ’

NAME

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

CONTENTS

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

o Gtk2::Ex::PodViewer
o Pod::Parser
o Locale::gettext

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.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 GTK2::EX::PODVIEWER::PARSER (3) 2008-10-04

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.