Locale::Po4a::Pod - converte dados POD de/para ficheiros PO
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');
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].
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
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. A predefiniçã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
- A quantidade de espaços para texto normal recuado e
o recuo predefinido para =over blocos. Predefiniçã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 (a predefinição), nenhuma linha em
branco é impressa após =head1 embora um ainda
é impresso após =head2. Este é a
predefinição porque é a formatação
esperada para as páginas de manual, se está a formatar
documentos de texto arbitrários, a definir-os como verdadeiro pode
resultar numa saída mais agradável.
- quotes
- Define as aspas usadas para cercar C<> texto. Se o
valor for um único carácter, é usado como aspa
esquerda e direita; se for dois caracteres, o primeiro é usado como
aspa esquerda e o segundo como aspa direita; e se for quatro caracteres,
os dois primeiros são usados como aspa esquerda e os dois segundos
como aspa 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. A
predefinição é true.
- width
- A coluna na qual se deseja envolver o texto no lado
direito. A predefinição é 76.
Pod::Parser,
Locale::Po4a::Man(3pm),
Locale::Po4a::TransTractor(3pm),
po4a(7)
Denis Barbier <[email protected]>
Martin Quinson (mquinson#debian.org)
Copyright © 2002 SPI, Inc.
Este programa é software livre, pode redistribuí-lo e/ou
modificá-lo sob os termos da GPL (consulte o ficheiro
CÓPIA).