table of contents
Locale::Po4a::Pod(3pm) | Ferramentas Po4a | Locale::Po4a::Pod(3pm) |
NOME¶
Locale::Po4a::Pod - converte dados POD de/para ficheiros PO
SINOPSE¶
use Locale::Po4a::Pod; my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78); # Ler POD de STDIN e escrever em STDOUT. $parser->parse_from_filehandle; # Ler POD de file.pod e escrever para file.txt. $parser->parse_from_file ('file.pod', 'file.txt');
DESCRIÇÃO¶
Locale::Po4a:: Pod é um módulo para ajudar a tradução da documentação em formato POD (o idioma preferido para documentar Perl) em outralíngua [humana].
STATUS DESTE MÓDULO¶
Eu acho que este módulo é rocha estável, e há apenas um erro conhecido com /usr/lib/perl5/Tk/MainWindow.pod (e algumas outras páginas, veja abaixo) que contém:
C<" #n">
Falta de sorte, na versão po4a, este foi dividido no espaço por o envolvimento. Como resultado, na versão original, a página do manual contém
" #n"
e a minha contém
"" #n""
O que é lógico desde que C<foobar> é rescrito "foobar".
Lista completa de páginas com este problema na minha caixa (de 564 páginas, note que depende da coluna envolvida escolhida):/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
INTERNAS¶
Como uma classe derivada de Pod::Parser, Locale::Po4a::Pod suporta o mesmo métodos e interfaces. Ver Pod::Parser para todos os detalhes, com brevidade, cria um novo analisador com "Locale::Po4a::Pod->new()" e depois invoca também parse_from_filehandle() ou parse_from_file().
novo() pode tomar opções, na forma de pares chave/valor, que controlam a o comportamento do analisador. As opções comuns reconhecidas para todos Pod::Parser as crianças são:
- alt
- Se for definido para um valor verdadeiro, seleciona um formato de saída alternativo que, entre outras as coisas, usa um título de estilo diferente e marca as entradas b<=item> com uma coluna na margem esquerda. Padrão é falso.
- code
- Se for definido para um valor de verdade, as partes não-POD do ficheiro de entrada será incluída na saída. Útil para visualização de código documentado com blocos POD com o POD prestado e o código deixado intacto.
- indent
- O número de espaços para texto normal recuado, e o recuo padrão para =over blocos. Padrão é 4.
- loose
- Se for definido para um valor de verdade, uma linha em branco é impressa depois de um título =head1. Se definido como falso (o padrão), nenhuma linha em branco é impressa após =head1 embora um ainda é impresso após =head2. Este é o padrão porque é a formatação esperada para as páginas de manual, se você está a formatar documentos de texto arbitrários, definindo-os como verdadeiro pode resultar numa saída mais agradável.
- quotes
- Define a citação marcada usada para cercar o texto
C<>. Se o valor é um caractere único, é
utilizado como citação à esquerda e à direita,
se for dois carateres, o primeiro caratere é utilizado como a
citação esquerda e a segunda como a citação
direita, e se é de quatro carateres, os dois primeiros são
usados como citação esquerda e os dois
últimos como a citação direita.
Isso também pode ser definido como o valor especial none, caso em que nenhuma citação marcada seja adicionada ao redor do texto C<>.
- sentence
- Se for definido para um valor verdadeiro, Locale::Po4a::Pod assumirá que cada sentença termina em dois espaços, e vai tentar preservar esse espaçamento. Se for definido como falso, todos os espaços consecutivos em parágrafos não literais são comprimidos num único espaço. Padrão é verdadeiro.
- width
- A coluna na qual se deseja envolver o texto no lado direito. O padrão é 76.
VER 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) =head1 DIREITOS DE AUTOR E LICENÇA
Direitos de Autor 2002 por SPI, inc.
Este programa é software livre, você pode redistribuí-lo e/ou modificá-lo sob os termos da GPL (consulte o ficheiro CÓPIA).
2014-05-02 | Ferramentas Po4a |