NOM¶
Locale::Po4a::Pod - Converteix dades POD des de/a fitxers PO
SINOPSI¶
use Locale::Po4a::Pod;
my $analitzador = Locale::Po4a::Pod->new (sentence => 0, width => 78);
# Llegim el POD de l'entrada estàndard i escrivim a la sortida estàndard.
$analitzador->parse_from_filehandle;
# Llegim el POD de fitxer.pod i escrivim a fitxer.txt.
$analitzador->parse_from_file ('fitxer.pod', 'fitxer.txt');
DESCRIPCIÓ¶
Locale::Po4a::Pod és un mòdul per ajudar en la traducció de
documents en el format POD (el llenguatge preferit per documentar Perl) a
altres llenguatges [humans].
ESTAT D'AQUEST MÒDUL¶
Tinc un altre problema amb
/usr/lib/perl5/Tk/MainWindow.pod (i algunes
altres pàgines, vegeu més avall) que contenen:
C<" #n">
Per mala sort, a la versió de po4a, això es parteix per l'espai per
justificar. Com a resultat, a la versió original, la pàgina de
manual conté
" #n"
i la meva conté
"" #n""
que és lògic, ja que C<foobar> es reescriu com a
"foobar".
Llistat complet de les pàgines de la meva màquina que tenen aquest
problema (de 564 pàgines; tingueu en compte que això depèn de
la columna escollida per justificar): /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
FUNCIONAMENT INTERN¶
Com a classe derivada de Pod::Parser, Locale::Po4a::Pod suporta els mateixos
mètodes i interfícies. Consulteu Pod::Parser per tots els detalls;
breument, es crea un nou analitzador amb
"Locale::Po4a::Pod->new()" i després es crida la funció
parse_from_filehandle() o la funció
parse_from_file().
new() pot rebre opcions, en la forma de parells clau/valor, que controlen
el comportament de l'analitzador. Tots els fills de Pod::Parser reconeixen
aquestes opcions:
- alt
- Si té valor cert, selecciona un format de sortida
alternativa, que entre d'altres coses, utilitza un estil
d'encapçalament diferent i marca les entrades =item amb un
punt al marge esquerre. Per defecte té el valor fals.
- code
- Si té valor cert, les parts no-POD del fitxer
d'entrada s'inclouran també a la sortida. És útil per veure
el codi documentat amb blocs POD, amb el POD tractat i el codi deixat
intacte.
- indent
- És el nombre d'espais per indentar el text regular, i
la indentació per defecte pels blocs =over. Per defecte val
4.
- loose
- Si té valor cert, s'afegeix una línia en blanc
després de les capçaleres =head1. Si té valor fals
(per defecte), no s'afegeixen línies en blanc després de
=head1, encara que se segueix afegint després de
=head2. Aquest és el comportament per defecte perquè
és el format esperat per les pàgines de manual; si esteu
formatejant documents de text arbitraris, obtindreu una sortida més
amena si li doneu valor cert.
- quotes
- Indica les marques que s'utilitzaran al voltant del text
C<>. Si el valor és un únic caràcter,
s'utilitzarà com a marca esquerra i dreta; si són dos
caràcters, el primer s'utilitzarà com a marca esquerra, i el
segon com a marca dreta; i si són quatre caràcters, els dos
primers s'utilitzaran com a marca esquerra, i els dos últims com a
marca dreta.
També es pot assignar el valor especial none. En aquest cas no
s'afegiran marques al voltant del text C<>.
- sentence
- Si té valor cert, Locale::Po4a::Pod assumirà que
cada frase acaba en dos espais, i intentarà conservar aquest espaiat.
Si té valor fals, es comprimiran a un tots els espais consecutius
dels paràgrafs no-verbatim. Per defecte val cert.
- width
- La columna a la que es justificarà el text. Per
defecte val 76.
CONSULTEU TAMBɶ
Pod::Parser,
Locale::Po4a::Man(3pm),
Locale::Po4a::TransTractor(3pm),
po4a(7)
AUTORS¶
Denis Barbier <barbier@linuxfr.org>
Martin Quinson (mquinson#debian.org)
DRET DE CÒPIA I LLICÈNCIA¶
Copyright 2002 per SPI, inc.
Aquest programa és programari lliure; podeu redistribuir-lo i/o
modificar-lo sota els termes de la GPL (consulteu el fitxer COPYING).