Constructeur¶

process(%)

Cette fonction peut faire tout ce dont vous avez besoin avec un document po4a en une seule invocation. Ses paramètres doivent être fournis sous forme de table de hachage. Voici les différentes actions possibles :

new(%)

Créer un nouveau document po4a. Options acceptées (dans le hachage passé en tant que paramètre) :

Manipuler les documents¶

read($$$)

Add another input document data at the end of the existing array "@{$self->{TT}{doc_in}}".

This function takes two mandatory arguments and an optional one.
* The filename to read on disk;
* The name to use as filename when building the reference in the PO file;
* The charset to use to read that file (UTF-8 by default)

Ce tableau "@{$self->{TT}{doc_in}}" contient les données des documents d'entrée comme un ensemble de chaînes de caractères dont les significations alternent.
* La chaîne $textline contenant chaque ligne des données du texte d'entrée.
* La chaîne "$filename:$linenum" contenant son emplacement et appelée
"reference" ("linenum" commence par 1).

Notez que cette fonction n’analyse pas le fichier donné. Il faut utiliser parse() pour cela une fois que vous avez ajouté au document tous les fichiers que vous souhaitez analyser.

write($)

Écrire le document traduit dans le fichier dont le nom est passé en paramètre.

Les données de ce document traduit sont fournies par :
* "$self->docheader()" contenant le texte d'en-tête du plugin, et
* "@{$self->{TT}{doc_out}}" contenant chaque ligne du texte principal traduit dans le tableau.

Manipuler les fichiers PO¶

readpo($)

Ajouter le contenu du fichier dont le nom est passé en paramètre au PO d’entrée. Notez que l’ancien contenu du PO d’entrée n’est pas effacé.

writepo($)

Écrire le PO extrait dans le fichier dont le nom est passé en paramètre.

stats()

Renvoie des statistiques à propos de la traduction. Notez que ce ne sont pas les statistiques affichées par msgfmt --statistic. Dans ce cas, il s’agit des statistiques concernant l’utilisation récente du fichier PO, tandis que msgfmt renseigne sur le statut du fichier PO. Il s’agit d’une encapsulation autour de la fonction Locale::Po4a::Po::stats_get en utilisant le fichier PO en entrée. Voici un exemple d’utilisation :

    [utilisation normal d’un document po4a...]
    ($pourcent,$traduit,$total) = $document->stats();
    print "Des traductions ont été trouvées pour $pourcent\%  ($traduit sur $total) des chaînes.\n";
    

Manipuler les addenda¶

addendum($)

Référez-vous à po4a(7) pour en savoir plus sur ce que sont les addendas et comment les équipes de traduction doivent les écrire. Pour appliquer un addendum au document traduit, il suffit de fournir le nom du fichier à cette fonction, et c’est fini  ;-)

Cette fonction renvoie un entier non nul en cas d’erreur.

Récupération de l’entrée, génération de la sortie¶

Quatre fonctions sont prévues pour obtenir l'entrée et retourner la sortie. Elles sont très similaires aux fonctions shift/unshift et push/pop de Perl.

 * shift de Perl renvoie le premier élément du tableau et le supprime du tableau.
 * unshift de Perl ajoute un élément au tableau comme premier élément du tableau.
 * pop de Perl renvoie le dernier élément du tableau et le supprime du tableau.
 * push de Perl ajoute un élément au tableau comme dernier élément du tableau.

La première paire concerne l’entrée, et la seconde la sortie. Moyen mnémotechnique : en entrée, on veut récupérer la première ligne, ce que shift permet ; en sortie on veut ajouter le résultat à la fin, ce que fait push.

shiftline()

Cette fonction renvoie la première ligne à analyser et sa référence correspondante (présentée sous forme de tableau) à partir du tableau "<@{$self-"{TT}{doc_in}}>> et supprime ces 2 premiers éléments du tableau. Ici, la référence est fournie par une chaîne "<$filename:$linenum">.

unshiftline($$)

Remets la dernière ligne récupérée avec shiftline() au début du tableau "{$self->{TT}{doc_in}}".

pushline($)

Ajoute une nouvelle ligne à la fin de "{$self->{TT}{doc_out}}".

popline()

Récupère (pop) la dernière ligne poussée à la fin de "{$self->{TT}{doc_out}}".

Marquage des chaînes à traduire¶

Une fonction est fournie pour gérer le texte qui doit être traduit.

translate($$$)

Paramètres obligatoires :

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

Fonctions diverses¶

verbose()

Indique si le mode bavard a été activé lors de la création du Transtractor.

debug()

Indique si l’option de débogage a été fournie lors de la création du Transtractor.

get_in_charset()

Cette fonction renvoie le jeu de caractères qui était fourni en tant que jeu de caractères d'origine

get_out_charset()

Cette fonction renverra le jeu de caractères qui doit être utilisé dans le document de sortie (souvent utile pour substituer le jeu de caractères qui a été détecté dans le document d’entrée).

Il utilisera le jeu de caractères spécifié sur la ligne de commande. S’il n’a pas été spécifié, il utilisera le jeu de caractère du fichier PO d’entrée, et si ce fichier PO utilise la valeur par défaut « CHARSET », et aucun encodage n’est réalisé.