logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Locale::Po4a::Pod - convert POD data from/to PO files

Authors

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

Description

       Locale::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.

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

Name

       Locale::Po4a::Pod - convert POD data from/to PO files

See Also

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

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

Synopsis

           use Locale::Po4a::Pod;
           my $parser = Locale::Po4a::Pod->new();

           # 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');

See Also