1Locale::Po4a::Pod(3)  User Contributed Perl Documentation Locale::Po4a::Pod(3)
2
3
4

NAME

6       Locale::Po4a::Pod - Convert POD data from/to PO files
7

SYNOPSIS

9           use Locale::Po4a::Pod;
10           my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
11
12           # Read POD from STDIN and write to STDOUT.
13           $parser->parse_from_filehandle;
14
15           # Read POD from file.pod and write to file.txt.
16           $parser->parse_from_file ('file.pod', 'file.txt');
17

DESCRIPTION

19       Locale::Po4a::Pod is a module to help the translation of documentation
20       in the POD format (the preferred language for documenting Perl) into
21       other [human] languages.
22

STATUS OF THIS MODULE

24       I think that this module is rock stable, and there is only one known
25       bug:
26
27       I have another problem with /usr/lib/perl5/Tk/MainWindow.pod (and some
28       other pages, see below) which contains:
29
30         CE<lt>" #n"E<gt>
31
32       Lack of luck, in the po4a version, this was splited on the space by the
33       wrapping. As result, in the original version, the man contain
34
35        " #n"
36
37       and mine contain
38
39        "" #n""
40
41       which is logic since "foobar" is rewritten "foobar"
42
43       Complete list of pages having this problem on my box (from 564 pages ;
44       note that it depends on the chosen wrapping column):
45       /usr/lib/perl5/Tk/MainWindow.pod /usr/share/perl/5.8.0/overload.pod
46       /usr/share/perl/5.8.0/pod/perlapi.pod
47       /usr/share/perl/5.8.0/pod/perldelta.pod /usr/share/perl/5.8.0/pod/perl‐
48       faq5.pod /usr/share/perl/5.8.0/pod/perlpod.pod
49       /usr/share/perl/5.8.0/pod/perlre.pod /usr/share/perl/5.8.0/pod/perlre‐
50       tut.pod
51

INTERNALS

53       As a derived class from Pod::Parser, Locale::Po4a::Pod supports the
54       same methods and interfaces.  See Pod::Parser for all the details;
55       briefly, one creates a new parser with "Locale::Po4a::Pod->new()" and
56       then calls either parse_from_filehandle() or parse_from_file().
57
58       new() can take options, in the form of key/value pairs, that control
59       the behavior of the parser.  The recognized options common to all
60       Pod::Parser children are:
61
62       alt If set to a true value, selects an alternate output format that,
63           among other things, uses a different heading style and marks
64           "=item" entries with a colon in the left margin.  Defaults to
65           false.
66
67       code
68           If set to a true value, the non-POD parts of the input file will be
69           included in the output.  Useful for viewing code documented with
70           POD blocks with the POD rendered and the code left intact.
71
72       indent
73           The number of spaces to indent regular text, and the default inden‐
74           tation for "=over" blocks.  Defaults to 4.
75
76       loose
77           If set to a true value, a blank line is printed after a "=head1"
78           heading.  If set to false (the default), no blank line is printed
79           after "=head1", although one is still printed after "=head2".  This
80           is the default because it's the expected formatting for manual
81           pages; if you're formatting arbitrary text documents, setting this
82           to true may result in more pleasing output.
83
84       quotes
85           Sets the quote marks used to surround C<> text.  If the value is a
86           single character, it is used as both the left and right quote; if
87           it is two characters, the first character is used as the left quote
88           and the second as the right quoted; and if it is four characters,
89           the first two are used as the left quote and the second two as the
90           right quote.
91
92           This may also be set to the special value "none", in which case no
93           quote marks are added around C<> text.
94
95       sentence
96           If set to a true value, Locale::Po4a::Pod will assume that each
97           sentence ends in two spaces, and will try to preserve that spacing.
98           If set to false, all consecutive whitespace in non-verbatim para‐
99           graphs is compressed into a single space.  Defaults to true.
100
101       width
102           The column at which to wrap text on the right-hand side.  Defaults
103           to 76.
104

SEE ALSO

106       Pod::Parser, po4a(7), Locale::Po4a::TransTractor(3pm),
107       Locale::Po4a::Man(3pm),
108

AUTHORS

110        Denis Barbier <barbier@linuxfr.org>
111        Martin Quinson (mquinson#debian.org)
112

114       Copyright 2002 by SPI, inc.
115
116       This program is free software; you may redistribute it and/or modify it
117       under the terms of GPL (see the COPYING file).
118
119
120
121perl v5.8.8                       2008-06-01              Locale::Po4a::Pod(3)
Impressum