Locale::Po4a::Pod(3) User Contributed Perl Documentation Locale::Po4a::Pod(3)NAMELocale::Po4a::Pod - convert POD data from/to PO files
SYNOPSIS
use Locale::Po4a::Pod;
my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
# Read POD from STDIN and write to STDOUT.
$parser->parse_from_filehandle;
# Read POD from file.pod and write to file.txt.
$parser->parse_from_file ('file.pod', 'file.txt');
DESCRIPTIONLocale::Po4a::Pod is a module to help the translation of documentation
in the POD format (the preferred language for documenting Perl) into
other [human] languages.
STATUS OF THIS MODULE
I think that this module is rock stable, and there is only one known
bug with /usr/lib/perl5/Tk/MainWindow.pod (and some other pages, see
below) which contains:
C<" #n">
Lack of luck, in the po4a version, this was split on the space by the
wrapping. As result, in the original version, the man page contains
" #n"
and mine contains
"" #n""
which is logic since C<foobar> is rewritten "foobar".
Complete list of pages having this problem on my box (from 564 pages;
note that it depends on the chosen wrapping column):
/usr/lib/perl5/Tk/MainWindow.pod /usr/share/perl/5.8.0/overload.pod
/usr/share/perl/5.8.0/pod/perlapi.pod
/usr/share/perl/5.8.0/pod/perldelta.pod
/usr/share/perl/5.8.0/pod/perlfaq5.pod
/usr/share/perl/5.8.0/pod/perlpod.pod
/usr/share/perl/5.8.0/pod/perlre.pod
/usr/share/perl/5.8.0/pod/perlretut.pod
INTERNALS
As a derived class from Pod::Parser, Locale::Po4a::Pod supports the
same methods and interfaces. See Pod::Parser for all the details;
briefly, one creates a new parser with "Locale::Po4a::Pod->new()" and
then calls either parse_from_filehandle() or parse_from_file().
new() can take options, in the form of key/value pairs, that control
the behavior of the parser. The recognized options common to all
Pod::Parser children are:
alt If set to a true value, selects an alternate output format that,
among other things, uses a different heading style and marks =item
entries with a colon in the left margin. Defaults to false.
code
If set to a true value, the non-POD parts of the input file will be
included in the output. Useful for viewing code documented with
POD blocks with the POD rendered and the code left intact.
indent
The number of spaces to indent regular text, and the default
indentation for =over blocks. Defaults to 4.
loose
If set to a true value, a blank line is printed after a =head1
heading. If set to false (the default), no blank line is printed
after =head1, although one is still printed after =head2. This is
the default because it's the expected formatting for manual pages;
if you're formatting arbitrary text documents, setting this to true
may result in more pleasing output.
quotes
Sets the quote marks used to surround C<> text. If the value is a
single character, it is used as both the left and right quote; if
it is two characters, the first character is used as the left quote
and the second as the right quote; and if it is four characters,
the first two are used as the left quote and the second two as the
right quote.
This may also be set to the special value none, in which case no
quote marks are added around C<> text.
sentence
If set to a true value, Locale::Po4a::Pod will assume that each
sentence ends in two spaces, and will try to preserve that spacing.
If set to false, all consecutive whitespace in non-verbatim
paragraphs is compressed into a single space. Defaults to true.
width
The column at which to wrap text on the right-hand side. Defaults
to 76.
SEE ALSO
Pod::Parser, Locale::Po4a::Man(3pm), Locale::Po4a::TransTractor(3pm),
po4a(7)AUTHORS
Denis Barbier <barbier@linuxfr.org>
Martin Quinson (mquinson#debian.org)
COPYRIGHT AND LICENSE
Copyright 2002 by SPI, inc.
This program is free software; you may redistribute it and/or modify it
under the terms of GPL (see the COPYING file).
perl v5.16.3 2012-05-17 Locale::Po4a::Pod(3)
