Linux Certif

Toute la documentation sur la certification Linux LPI

Locale::Po4a::Pod.3pm

NOM

Locale::Po4a::Pod - convertit des donnees 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 ecriture dans STDOUT.
     $parser->parse_from_filehandle;
 
     # Lecture d'un POD dans file.pod, et ecriture 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 preference pour la documentation Perl) vers d'autres langues.

ETAT DE CE MODULE

Je pense que ce module est extremement stable, et il n'y a qu'un seul probleme connu :

Je rencontre un autre probleme 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 creee par po4a, c'est decoupe par les retours a la ligne. Comme resultat, dans la version d'origine, le manuel contenait :

  " #n"
 
 

et le mien contient :

  "" #n""
 
 

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

Voici la liste complete des pages presentant ce probleme sur ma machine (pour un total de 564 pages ; notez egalement que ca depend 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 derivee de Pod::Parser, Locale::Po4a::Pod comprend les memes methodes et interfaces. Consultez Pod::Parser pour plus de details ; en bref, on cree 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 cle/valeur, qui controlent le comportement de l'analyseur. Les options communes a tous les derives de Pod::Parser sont :

alt

Lorsqu'elle prend une valeur vraie, elle permet de selectionner un autre format de sortie qui, entre autres choses, utilise un autre style de titres et d'entrees "=item" avec un signe deux-points dans la marge de gauche. La valeur par defaut est fausse.

code

Lorsqu'elle prend une valeur vraie, elle permet d'inclure dans la sortie les parties non POD du fichier d'entree. Ceci est utile pour visualiser du code documente 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 defaut est 4.

loose

Lorsqu'elle prend une valeur vraie, une ligne blanche est imprimee apres les titres "=head1". Avec une valeur fausse (par defaut), aucune ligne blanche n'est imprimee apres un "=head1", meme s'il y en a une qui est imprimee apres "=head2". La valeur par defaut correspond au format attendu pour les pages de manuel ; si vous etes en train de formater des documents texte arbitraires, une valeur X true X (vrai) pourra resulter en un affichage plus agreable.

quotes

Indique la marque de guillemets a utiliser autour du texte entre C<>. Si cette valeur est un unique caractere, il est utilise a la fois comme guillemet gauche et droit ; s'il y a deux caracteres, le premier est utilise comme guillemet gauche et le second comme guillemet droit ; s'il y a quatre caracteres, les deux premiers sont utilises comme guillemet gauche et les deux derniers comme guillemets droits.

Elle peut prendre la valeur speciale "none", auquel cas aucun guillemet n'est ajoute 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 consecutifs des paragraphes a ne pas considerer tel quel (X non-verbatim X) sont rassembles en un seul espace. Par defaut la valeur est vrai.

width

La colonne vers laquelle les retours a la ligne sont inseres. La valeur par defaut 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 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).