Locale::Po4a::Pod.3pm

Autres langues

Langue: fr

Version: 2008-11-05 (ubuntu - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

NOM

Locale::Po4a::Pod - convertit des donnA~Xes POD depuis/vers des fichiers PO

SYNOPSIS

     use Locale::Po4a::Pod;
     my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
 
     # Lecture dans STDIN et A~Xcriture dans STDOUT.
     $parser->parse_from_filehandle;
 
     # Lecture d'un POD dans file.pod, et A~Xcriture 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 prA~XfA~Xrence pour la documentation Perl) vers d'autres langues.

A~XTAT DE CE MODULE

Je pense que ce module est extrA~Xmement stable, et il n'y a qu'un seul problA~Xme connu :

Je rencontre un autre problA~Xme 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 crA~XA~Xe par po4a, c'est dA~XcoupA~X par les retours A~  la ligne. Comme rA~Xsultat, dans la version d'origine, le manuel contenait :

  " #n"
 
 

et le mien contient :

  "" #n""
 
 

Ce qui est logique puisque "blabla" est converti en AX blabla AX

Voici la liste complA~Xte des pages prA~Xsentant ce problA~Xme sur ma machine (pour un total de 564 pages ; notez A~Xgalement que A~Xa dA~Xpend 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 dA~XrivA~Xe de Pod::Parser, Locale::Po4a::Pod comprend les mA~Xmes mA~Xthodes et interfaces. Consultez Pod::Parser pour plus de dA~Xtails ; en bref, on crA~Xe 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 clA~X/valeur, qui contrA~Xlent le comportement de l'analyseur. Les options communes A~  tous les dA~XrivA~Xs de Pod::Parser sont :

alt
Lorsqu'elle prend une valeur vraie, elle permet de sA~Xlectionner un autre format de sortie qui, entre autres choses, utilise un autre style de titres et d'entrA~Xes "=item" avec un signe deux-points dans la marge de gauche. La valeur par dA~Xfaut est fausse.
code
Lorsqu'elle prend une valeur vraie, elle permet d'inclure dans la sortie les parties non POD du fichier d'entrA~Xe. Ceci est utile pour visualiser du code documentA~X avec des blocs POD en faisant un rendu du POD et en conservant le code intact.
indent
Le nombre d'espaces A~  utiliser pour l'indentation du texte normal, et l'indentation pour les blocs "=over". La valeur par dA~Xfaut est 4.
loose
Lorsqu'elle prend une valeur vraie, une ligne blanche est imprimA~Xe aprA~Xs les titres "=head1". Avec une valeur fausse (par dA~Xfaut), aucune ligne blanche n'est imprimA~Xe aprA~Xs un "=head1", mA~Xme s'il y en a une qui est imprimA~Xe aprA~Xs "=head2". La valeur par dA~Xfaut correspond au format attendu pour les pages de manuel ; si vous A~Xtes en train de formater des documents texte arbitraires, une valeur AX true AX (vrai) pourra rA~Xsulter en un affichage plus agrA~Xable.
quotes
Indique la marque de guillemets A~  utiliser autour du texte entre C<>. Si cette valeur est un unique caractA~Xre, il est utilisA~X A~  la fois comme guillemet gauche et droit ; s'il y a deux caractA~Xres, le premier est utilisA~X comme guillemet gauche et le second comme guillemet droit ; s'il y a quatre caractA~Xres, les deux premiers sont utilisA~Xs comme guillemet gauche et les deux derniers comme guillemets droits.

Elle peut prendre la valeur spA~Xciale "none", auquel cas aucun guillemet n'est ajoutA~X 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 consA~Xcutifs des paragraphes A~  ne pas considA~Xrer tel quel (AX non-verbatim AX) sont rassemblA~Xs en un seul espace. Par dA~Xfaut la valeur est vrai.
width
La colonne vers laquelle les retours A~  la ligne sont insA~XrA~Xs. La valeur par dA~Xfaut est 76.

VOIR AUSSI

Pod::Parser, po4a(7), Locale::Po4a::TransTractor(3pm), Locale::Po4a::Man(3pm),

AUTEURS

  Denis Barbier <barbier@linuxfr.org>
  Martin Quinson (mquinson#debian.org)
 
 

TRADUCTION

  Martin Quinson (mquinson#debian.org)
 
 
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).