---
name: "Gtk2::PodViewer::Parser"
section: "3pm"
platform: "linux"
package: "libgtk2-podviewer-perl"
version: "0.09-2"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/Gtk2::PodViewer::Parser"
---

# Gtk2::PodViewer::Parser(3pm)

a custom POD Parser for Gtk2::PodViewer.

## NAME

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

## SYNOPSIS

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

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

```
        $parser->parse_from_file($file);
```

## DESCRIPTION

Gtk2::PodViewer::Parser is a custom Pod parser for the Gtk2::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::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 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

- •

  Gtk2::PodViewer

- •

  Pod::Parser

- •

  Locale::gettext

## AUTHORS

Gavin Brown, Torsten Schoenfeld and Scott Arrington.

## COPYRIGHT

(c) 2004 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.