NOM¶

Locale::Po4a::TransTractor - Traducteur et extracteur générique

DESCRIPTION¶

L'objectif du projet po4a [PO for anything -- PO pour tout] est de simplifier la traduction (et de façon plus intéressante, la maintenance des traductions) en utilisant les outils gettext dans des domaines pour lesquels ils n'étaient pas destinés, comme la documentation.

Cette classe est l'ancêtre de tous les analyseurs po4a utilisés pour lire un document, y chercher les chaînes traduisibles, les extraire dans un fichier PO, et les remplacer par leur traduction dans le document généré.

Plus formellement, elle prend les paramètres d'entrée suivants :

• un document à traduire ;
• un fichier PO contenant les traductions à utiliser.

En sortie, elle produit :

• un autre fichier PO, résultat de l'extraction des chaînes traduisibles du document en entrée ;
• un document traduit, partageant la même structure que celui en entrée, mais dont toutes les chaînes traduisibles ont été remplacées par les traductions trouvées dans le fichier PO fourni en entrée.

Voici une représentation graphique de tout cela :

  document entrée --\                             /---> document sortie
                     \                           /       (traduit)
                      +-> parse() function -----+
                     /                           \
  PO entrée --------/                             \---> PO sortie
                                                         (extrait)

FONCTIONS QUE VOTRE ANALYSEUR DOIT SURCHARGER¶

parse()

Il s'agit de la fonction principale où tout le travail a lieu : la lecture des documents en entrée, la génération des documents en sortie et l'extraction des chaînes traduisibles. Tout ceci est assez simple avec les fonctions fournies et présentées dans la section FONCTIONS INTERNES ci-dessous. Veuillez aussi vous reporter à la section SYNOPSIS, qui présente un exemple.

Cette fonction est appelée par la fonction process() ci-dessous, mais si vous choisissez d'utiliser la fonction new(), et d'ajouter le contenu manuellement, vous devrez appeler cette fonction vous-même.

docheader()

Cette fonction renvoie l'en-tête que nous devons ajouter au document produit, formaté comme il faut pour qu'il soit un commentaire pour le langage cible. Reportez-vous à la section Éduquer les développeurs au problème des traductions, dans po4a(7).

SYNOPSIS¶

L'exemple suivant analyse une liste de paragraphes commençant par « <p ».> Pour simplifier, nous supposons que le document est bien formaté, c'est-à-dire que la balise <p> est la seule présente et que cette balise se trouve au début de chaque paragraphe.

 sub parse {
   my $self = shift;
   PARAGRAPHE: while (1) {
       my ($paragraphe,$pararef)=("","");
       my $premier=1;
       ($ligne,$lref)=$self->shiftline();
       while (defined($ligne)) {
           if ($ligne =~ m/<p>/ && !$premier--; ) {
               # Ce n'est pas la première balise <p>.
               # Remet la ligne actuelle dans le document d'entrée,
               #  et met le paragraphe dans la sortie
               $self->unshiftline($line,$lref);
               # Maintenant que le document est formé, il faut le traduire :
               #   - Retirons les balises de tête
               $paragraphe =~ s/^<p>//s;
               #   - Poussons la balise de tête (à ne pas traduire) et le
               #     reste du paragraphe (à traduire) dans le document de
               #     sortie
               $self->pushline(  "<p>"
                               . $document->translate($paragraphe,$pararef)
                               );
               next PARAGRAPHE;
           } else {
               # Ajout à la fin du paragraphe
               $paragraphe .= $ligne;
               $pararef = $lref unless(length($pararef));
           }
           # Re-initialise la boucle
           ($ligne,$lref)=$self->shiftline();
       }
       # Aucune nouvelle ligne ? C'est la fin du fichier d'entrée.
       return;
   }
 }

Une fois que vous avez implémenté la fonction parse, vous pouvez utiliser cette nouvelle classe en utilisant l'interface publique présentée dans la section suivante.

INTERFACE PUBLIQUE pour les scripts utilisant votre analyseur¶

FONCTIONS INTERNES utilisées pour dériver un analyseur (parser)¶

  $self->translate("chaîne","référence","type",
                   'wrap' => 1);

DIRECTIONS FUTURES¶

Une des imperfections du TransTractor actuel est qu'il ne peut pas gérer de documents traduits contenant toutes les langues, comme les modèles debconf ou les fichiers .desktop.

Pour répondre à ce problème, les seules modifications d'interface nécessaires sont :

• utiliser une table de hachage pour po_in_name (une liste par langue) ;
• ajouter un paramètre à traduire pour indiquer la langue cible ;
• créer une fonction pushline_all, qui utiliserait pushline pour le contenu de toutes ses langues, en utilisant map :

      $self->pushline_all({ "Description[".$code_langue."]=".
                            $self->translate($ligne,$réf,$code_langue)
                          });
      

Nous verrons si c'est suffisant ;)

AUTEURS¶

 Denis Barbier <barbier@linuxfr.org>
 Martin Quinson (mquinson#debian.org)
 Jordi Vilalta <jvprat@gmail.com>

TRADUCTION¶

 Martin Quinson (mquinson#debian.org)