1Locale::Po4a::Pod(3pm)            Po4a Tools            Locale::Po4a::Pod(3pm)
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 with /usr/lib/perl5/Tk/MainWindow.pod (and some other pages, see
26       below) which contains:
27
28         C<" #n">
29
30       Lack of luck, in the po4a version, this was split on the space by the
31       wrapping. As result, in the original version, the man page contains
32
33        " #n"
34
35       and mine contains
36
37        "" #n""
38
39       which is logic since C<foobar> is rewritten "foobar".
40
41       Complete list of pages having this problem on my box (from 564 pages;
42       note that it depends on the chosen wrapping column):
43       /usr/lib/perl5/Tk/MainWindow.pod /usr/share/perl/5.8.0/overload.pod
44       /usr/share/perl/5.8.0/pod/perlapi.pod
45       /usr/share/perl/5.8.0/pod/perldelta.pod
46       /usr/share/perl/5.8.0/pod/perlfaq5.pod
47       /usr/share/perl/5.8.0/pod/perlpod.pod
48       /usr/share/perl/5.8.0/pod/perlre.pod
49       /usr/share/perl/5.8.0/pod/perlretut.pod
50

INTERNALS

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

SEE ALSO

104       Pod::Parser, Locale::Po4a::Man(3pm), Locale::Po4a::TransTractor(3pm),
105       po4a(7)
106

AUTHORS

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

112       Copyright © 2002 SPI, Inc.
113
114       This program is free software; you may redistribute it and/or modify it
115       under the terms of GPL (see the COPYING file).
116
117
118
119Po4a Tools                        2021-02-23            Locale::Po4a::Pod(3pm)
Impressum