NOM
Locale::Po4a::Pod - convertit des données POD depuis ou vers des
fichiers PO
SYNOPSIS
use Locale::Po4a::Pod;
my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
# Lecture dans STDIN et écriture dans STDOUT.
$parser->parse_from_filehandle;
# Lecture d'un POD dans file.pod, et écriture dans file.txt.
$parser->parse_from_file ('file.pod', 'file.txt');
DESCRIPTION
Locale::Po4a::Pod est un module qui permet d'aider la traduction de
documentation au format POD (le langage de préférence pour la
documentation Perl) vers d'autres langues.
ETAT DE CE MODULE
Je pense que ce module est extrèmement stable et il n'y a qu'un seul
problème connu :
Je rencontre un autre problème avec /usr/lib/perl5/Tk/MainWindow.pod
(et certaines autres pages, voir ci-dessous), qui contient :
CE<lt>" #n"E<gt>
Manque de chance, dans la version crée par po4a, c'est découpé par les
retours à la ligne. Comme résultat dans la version d'origine, le manuel
contenait :
" #n"
et le mien contient :
"" #n""
Ce qui est logique puisque "blabla" est converti en blabla
Voici la liste complète des pages présentant ce problème sur ma machine
(pour un total de 564 pages ; notez également que ça dépend du signe de
ponctuation choisi) : /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
FONCTIONNEMENT INTERNE
En tant que classe dérivée de Pod::Parser, Locale::Po4a::Pod a les
mêmes méthodes et interfaces. Voyez Pod::Parser pour plus de détails ;
en bref, on crée un nouvel analyseur avec "Locale::Po4a::Pod->new()"
puis on appelle parse_from_filehandle() ou parse_from_file().
new() accepte des options sous la forme de paires clé/valeur, qui
contrôlent le comportement de l'analyseur. Les options communes à tous
les dérivés de Pod::Parser sont :
alt Lorsqu'elle prend une valeur vraie, elle permet de sélectionner un
autre format de sortie qui, entre autres choses, utilise un autre
style de titres et d'entrées "=item" avec un signe deux-points dans
la marge de gauche. La valeur par défaut est fausse.
code
Lorsqu'elle prend une valeur vraie, elle permet d'inclure dans la
sortie les parties non POD du fichier d'entrée. Ceci est utile pour
visualiser du code document avec des blocs POD en faisant un rendu
du POD et en conservant le code intact.
indent
Le nombre d'espaces à utiliser pour l'indentation du texte normal,
et l'indentation pour les blocs "=over". Valeur par défaut : 4.
loose
Lorsqu'elle prend une valeur vraie, une ligne blanche est imprimée
après les titres "=head1". Avec une valeur fausse (par défaut),
aucune ligne blanche n'est imprimée après un "=head1", même s'il y
en a une qui est imprimée après "=head2". La valeur par défaut
correspond au format attendu pour les pages de manuel ; si vous
êtes en train de formater des documents texte arbitraires, une
valeur true (vrai) pourra résulter en un affichage plus agréable.
quotes
Indique la marque de guillemets à utiliser autour du texte entre
C<>. Si cette valeur est un unique caractère, il est utilisé à la
fois comme guillemet gauche et droit ; s'il y a deux caractères, le
premier est utilisé comme guillemet gauche et le second comme
guillemet droit ; s'il y a quatre caractères, les deux premiers
sont utilisés comme guillemet gauche et les deux derniers comme
guillemets droits.
Elle peut prendre la valeur spéciale "none", auquel cas aucun
guillemet n'est ajouté autour du texte entre C<>.
sentence
Lorsqu'elle prend la valeur vrai, Locale::Po4a::Pod suppose que
chaque phrase se termine par deux espaces, et essayera de conserver
ces espaces. Lorsqu'elle prend la valeur faux, tous les espaces
consécutifs des paragraphes à ne pas considérer tel quel (non-
verbatim) sont rassemblés en un seul espace. Par défaut, la valeur
est vrai.
width
La colonne vers laquelle les retours à la ligne sont insérés. La
valeur par défaut est 76.
VOIR AUSSI
Pod::Parser(3), po4a(7), Locale::Po4a::TransTractor(3pm),
Locale::Po4a::Man(3pm)
AUTEURS
Denis Barbier <barbier@linuxfr.org>
Martin Quinson (mquinson#debian.org)
COPYRIGHT ET LICENCE
Copyright 2002 par SPI, inc.
Ce programme est un logiciel libre ; vous pouvez le copier et / ou le
modifier sous les termes de la GPL (voir le fichier COPYING).