NOME¶
Locale::Po4a::Pod - converte documenti POD da/verso file PO
SINTASSI¶
use Locale::Po4a::Pod;
my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
# Legge il file POD da STDIN e scrive su STDOUT.
$parser->parse_from_filehandle;
# Legge il file POD da file.pod e scrive su file.txt.
$parser->parse_from_file ('file.pod', 'file.txt');
DESCRIZIONE¶
Locale::Po4a::Pod è un modulo che aiuta la traduzione in altre lingue della
documentazione in formato POD (il linguaggio preferito per la documentazione
di Perl).
STATO DI QUESTO MODULO¶
Questo modulo è ritenuto perfettamente stabile ed è noto solo un
bug:Ho un altro problema con
/usr/lib/perl5/Tk/MainWindow.pod (e
qualche altra pagina, vedere più avanti) che contiene:
C<" #n">
La sfortuna ha voluto che, nella versione di po4a, questo è stato mandato a
capo dove c'è lo spazio. Come risultato, la versione originale contiene
" #n"
e la mia contiene
"" #n""
che è logico, dato che C<blabla> viene riscritto come
"blabla".
Elenco completo delle pagine con questo problema che si trovano sul mio computer
(da 564 pagine; notare che dipende dalla colonna scelta per il ritorno a capo
automatico): /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
FUNZIONAMENTO INTERNO¶
Come classe derivata da Pod::Parser, Locale::Po4a::Pod supporta gli stessi
metodi e la stessa interfaccia. Vedere anche Pod::Parser per maggiori
dettagli; in breve, si crea un nuovo parser con
"Locale::Po4a::Pod->new()", dopodiché si effettua una
chiamata a
parse_from_filehandle() o
parse_from_file().
new() può accettare opzioni, in forma di coppie chiave/valore, che
controllano il comportamento del parser. Le opzioni riconosciute da tutti i
discendenti di Pod::Parser sono:
- alt
- Se il suo valore è true, seleziona un formato di
output alternativo che, tra le altre cose, usa un diverso stile di
intestazione e segna le voci =item con dei due punti sul margine
sinistro. Il valore predefinito è false.
- code
- Se il suo valore è true, le parti non POD del file di
input saranno incluse nell'output. Può essere utile per visualizzare
del codice documentato con POD: i blocchi POD verranno impaginati, mentre
il codice verrà lasciato intatto.
- indent
- Il numero di spazi da usare per indentare il testo normale
e il rientro predefinito per i blocchi =over. Il valore predefinito
è 4.
- loose
- Se il suo valore è true, verrà lasciata una riga
vuota dopo un'intestazione =head1. Se invece vale false (il valore
predefinito), non ci sarà nessuna riga vuotà dopo =head1,
sebbene ne venga aggiunta una dopo =head2. Il valore predefinito
rispecchia l'aspetto standard delle pagine di manuale; se si sta
impaginando un documento di un altro tipo, impostare a true può
produrre un output più leggibile.
- quotes
- Sceglie i segni da usare come virgolette per il testo
racchiuso tra C<>. Se il valore è un singolo carattere,
verrà usato sia a sinistra che a destra; se comprende due caratteri,
il primo verrà usato come virgoletta sinistra, l'altro come
virgoletta destra; se invece comprende quattro caratteri, i primi due
staranno a sinistra e gli altri due a destra.
È anche possibile usare il valore speciale none per omettere
completamente le virgolette attorno a C<>.
- sentence
- Se il suo valore è true, Locale::Po4a::Pod suppone che
ogni frase finisca con due spazi e cercherà di conservare tale stile
di spaziatura. Se invece vale false, tutti gli spazi consecutivi (eccetto
che nei paragrafi da riportare invariati) verranno compressi in un singolo
spazio. Il valore predefinito è true.
- width
- La colonna a cui mandare a capo il testo sul margine
destro. Il valore predefinito è 76.
VEDERE ANCHE¶
Pod::Parser,
Locale::Po4a::Man(3pm),
Locale::Po4a::TransTractor(3pm),
po4a(7)
AUTORI¶
Denis Barbier <barbier@linuxfr.org>
Martin Quinson (mquinson#debian.org)
COPYRIGHT E LICENZA¶
Copyright © 2002 SPI, inc.
Questo programma è software libero; è lecito ridistribuirlo o
modificarlo secondo i termini della licenza GPL (vedere il file
COPYING).