Locale::Po4a::Pod(3pm)

NOME
Locale::Po4a::Pod - converte dados POD de/para arquivos PO

SINOPSE
    use Locale::Po4a::Pod;
    my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);

    # Lê um POD da STDIN e escreve para a STDOUT.
    $parser->parse_from_filehandle;

    # Lê um POD do arquivo.pod e escreve para arquivo.txt.
    $parser->parse_from_file ('arquivo.pod', 'arquivo.txt');

DESCRIÇÃO
Locale::Po4a::Pod é um módulo para ajudar a tradução de documentação no formato POD (a linguagem preferido para documentar Perl) para outros idiomas.

ESTADO DESTE MÓDULO
Eu penso que este módulos está bem consolidado, e há apenas um erro conhecido com /usr/lib/perl5/Tk/MainWindow.pod (e alguns outras páginas, veja abaixo), o qual contém:

  C<" #n">

Por falta de sorte, na versão do po4a, isso foi divido no espaço pelo dimensionamento. Como resultado, na versão original, a página man contém:

 " #n"

e o meu contém:

 "" #n""

o qual faz sentido, já que C<foobar> é reescrito como "foobar".

Lista completa de páginas com esse problema na minha caixa (de 564 páginas; observe que depende da coluna escolhida para quebra de texto):

 /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

INTERNO
Como uma classe derivada de Pod::Parser, Locale::Po4a::Pod tem suporte aos mesmos métodos e interfaces. Veja Pod::Parser para todos os detalhes. De forma resumida, cria-se um novo analisador com "Locale::Po4a::Pod->new()" e, então, chama-se parse_from_filehandle() ou parse_from_file().

new() pode receber opções, na forma de pares chave/valor, que controla o comportamento do analisador. As opções reconhecidas a todos os filhos de Pod::Parser:

alt Se definido com um valor verdadeiro, seleciona um formato de saída alternativo que, dentre outras coisas, usa um estilo de cabeçalho diferente e marca entradas =item com um caractere de dois-pontos (:) na margem esquerda. O padrão é falso.

code
    Se definido com um valor verdadeiro, as partes não-POD do arquivo de saída serão incluídas na saída. Útil para visualizar o código documentado com blocos POD com o POD renderizado e o código intacto.

indent
    O número de espaços para recuar ("indentar") o texto comum e o recuo padrão para os blocos =over. O padrão é 4.

loose
    Se definido com um valor verdadeiro, uma linha em branco é mostrada após um cabeçalho =head1. Se definido com falso (o padrão), nenhuma linha em branco é exibida após =head1, porém uma ainda é mostrada após =head2. Esse é o padrão porque é a formatação esperada para as páginas de manual; Se você estiver formatando documentos de texto arbitrário, definir isso para verdadeiro pode resultar em um resultado mais agradável.

quotes
    Define os sinais de aspas para envolver textos C<>. Se o valor for um único caractere, ele for usado em ambas aspas da esquerda e da direita; se ele for dois caracteres, o primeiro caractere é usado como aspas da esquerda e o segundo como a aspas da direita; e se ele for quarto caracteres, os primeiros dois são usados como as aspas da esquerda e os dois últimos são usados como as aspas da direita.

    Esse valor também pode ser definido com o valor especial none, caso em que aspas não são adicionadas em volta de textos C<>.

sentence
    Se definido com um valor verdadeiro, Locale::Po4a::Pod vai presumir que cada sentença termina com dois espaços e vai tentar preservar aquele espaçamento. Se definido com falso, todos os espaços em branco consecutivos em parágrafos não-literais são comprimidos em um único espaço. O padrão é verdadeiro.

width
    A coluna na qual se deve realizar dimensionamento no lado direito. O padrão é 76.

VEJA TAMBÉM
Pod::Parser, Locale::Po4a::Man(3pm), Locale::Po4a::TransTractor(3pm), po4a(7)

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

COPYRIGHT E LICENÇA
Copyright © 2002 SPI, Inc.

Esse programa é um software livre; você pode redistribuí-lo e/ou modificá-lo sob os termos da GPL v2.0 ou posterior (veja o arquivo COPYING).