Tutoriel de démarrage rapide

Supposons que vous mainteniez un programme nommé chapi ayant une page de manuel man/chapi.1 écrite en anglais (la langue passerelle dans la plupart des projets libres, mais po4a peut être utilisé depuis ou vers n'importe quelle langue). Il y a quelque temps, quelqu'un a fourni une traduction allemande nommée man/chapi.de.1 et a disparu. C'est un problème, car vous venez de recevoir un rapport de bogue signalant une information gravement trompeuse devant être corrigée dans toutes les langues. Mais, vous ne parlez pas allemand, et vous ne pouvez donc modifier que l'original, pas la traduction. Maintenant, un autre contributeur veut contribuer à une traduction en japonais, une langue que vous ne maitrisez pas non plus.

Il est temps de convertir votre documentation à po4a pour résoudre vos cauchemars de maintenance de la documentation. Vous voulez actualiser la documentation lorsque cela est nécessaire, faciliter le travail de vos équipes de traduction, et vous assurer qu'une documentation périmée et donc trompeuse n’est jamais publiée.

La conversion comprend deux étapes : la mise en place de l'infrastructure po4a, et la conversion de la traduction allemande existante pour sauver le travail précédent. Cette dernière partie est effectuée en utilisant po4a-gettextize, comme suit. Tel que détaillé dans la documentation de po4a-gettextize(1), ce processus est rarement entièrement automatique. En revanche, une fois réalisé, le fichier de.po contenant la traduction allemande peut être intégré dans votre flux de travail po4a.

po4a-gettextize --format man --master chapi.1 --localized chapi.de.1 --po de.po

Configurons maintenant po4a. Avec la disposition appropriée des fichiers, votre fichier de configuration pourrait être aussi simple que ceci :

[po_directory] man/po4a/
[type: man] man/chapi.1 $lang:man/translated/chapi.$lang.1

Elle spécifie que tous les fichiers PO (contenant le travail des équipes de traduction) se trouvent dans le répertoire man/po4a/, et que vous n'avez qu'un seul fichier d'origine, man/chapi.1. Si vous aviez plusieurs fichiers d'origine, vous auriez plusieurs lignes semblables à la seconde. Chacune de ces lignes spécifie également où écrire les fichiers de traduction correspondants. Ici, la traduction allemande de man/chapi.1 se trouve dans man/translated/chapi.de.1.

La dernière chose dont nous avons besoin pour terminer la configuration de po4a est un fichier POT contenant le contenu modèle qui doit être utilisé pour commencer une nouvelle traduction. Il suffit de créer un fichier vide avec l'extension .pot dans le répertoire po_directory spécifié (par exemple man/po4a/chapi.pot), et po4a le remplira avec le contenu attendu.

Voici un récapitulatif des fichiers de cette configuration :

  ├── man/
│   ├── chapi.1        ← La page de manuel originale, en anglais.
│   ├── po4a/
│   │   ├── de.po    ← Le fichier PO en allemand, issu de la gettextisation.
│   │   └── chapi.pot  ← Le modèle POT pour les traductions futures (vide au départ).
│   └── translated/  ← Répertoire où les fichiers de traduction seront créés.
└── po4a.cfg         ← Le fichier de configuration.

Une fois configuré, l'exécution de po4a analysera votre documentation, mettra à jour le fichier modèle POT, l'utilisera pour actualiser les fichiers de traduction PO, qui permettront à leur tour de générer les fichiers de traduction de la documentation mis à jour. Tout cela en une seule commande :

po4a po4a.cfg

C’est tout. po4a est maintenant entièrement configuré. Une fois que vous aurez corrigé votre erreur dans man/chapi.1, le paragraphe incriminé dans la traduction allemande sera remplacé par le texte corrigé en anglais. Mélanger les langues n’est pas optimal, mais c’est le seul moyen de supprimer les erreurs dans les traductions que vous ne comprenez pas et de vous assurer que les contenus publié ne sont jamais erronés. La mise à jour de la traduction allemande est également beaucoup plus facile dans le fichier PO correspondant, de sorte que le mélimélo linguistique peut ne pas durer longtemps. Enfin, lorsque l'équipe de traduction japonaise voudra proposer une nouvelle traduction, elle devra renommer fichier chapi.pot en ja.po, puis effectuer la traduction. Une fois le fichier en votre possession, déposez-le simplement dans man/po4a/po/. La page traduite apparaitra sous la forme man/translated/chapi.ja.1 (à condition que suffisamment de contenu soit traduit) lorsque vous exécuterez po4a à nouveau.

Options modifiant l’en-tête du POT

--porefs type

Indique le format des références. L’argument type peut-être never pour ne pas produire de référence, file pour n’indiquer que le fichier sans le numéro de ligne, counter pour remplacer le numéro de ligne par un décompte croissant, et full pour inclure des références complètes (par défaut, la valeur full est utilisée).

--wrap-po no|newlines|nombre (par défaut : 76)

Détermine la façon de formater le fichier po. Cela donne le choix entre des fichiers joliment reformatés mais pouvant mener à des conflits git, ou des fichiers plus facile à prendre en main automatiquement, mais plus difficile à lire pour les humains.

Historiquement, la suite gettext a formaté les fichiers po à la 77e colonne pour des raisons cosmétiques. Cette option indique le comportement de po4a. Si défini en tant qu’entier, po4a va restreindre la largeur du fichier après cette colonne et après les nouvelles lignes de contenu. Si défini à newlines, po4a ne séparera les msgit et msgstr qu’après les nouvelles lignes dans le contenu. Si défini à no, po4a ne restreindra pas du tout le fichier. Les commentaires de référence sont toujours limités par les outils gettext que nous utilisons en interne.

Veuillez noter que cette option n’a pas d’impact sur la façon dont les msgid et msgstr sont renvoyées, c'est-à-dire sur la façon dont les nouvelles lignes sont ajoutées au contenu de ces chaînes.

--master-language

Langue des fichiers source contenant les documents à traduire. Notez que tous les fichiers d'origine doivent partager la même langue.

--msgid-bugs-address adresse@email

Fixe l’adresse à laquelle les bogues des msgid doivent être envoyés. Par défaut, les fichiers POT créés n’ont pas de champ Report-Msgid-Bugs-To.

--copyright-holder chaîne

Fixe le détenteur du copyright dans l’en-tête du fichier POT. La valeur par défaut est « Free Software Foundation, Inc. ».

--package-name chaîne

Fixe le nom du paquet pour l’en-tête du fichier POT. La valeur par défaut est « PACKAGE ».

--package-version chaîne

Fixe la version du paquet pour l’en-tête du fichier POT. La valeur par défaut est « VERSION ».

Options de modification des fichiers PO

--msgmerge-opt options

Options additionnelles pour msgmerge(1).

Note : $lang sera remplacé par la langue en cours.

--no-previous

Cette option supprime --previous des options passées à msgmerge. Elle est nécessaire pour la prise en charge des versions de gettext antérieures à 0.16.

--previous

Cette option ajoute --previous aux options passées à msgmerge. Elle nécessite une version 0.16 ou ultérieure de gettext et est activée par défaut.

Trouver les fichiers PO et POT

La solution la plus simple est de donner explicitement le chemin des fichiers POT et PO, comme ceci :

[po4a_paths] man/po/project.pot de:man/po/de.po fr:man/po/fr.po

Cela spécifie d'abord le chemin d'accès au fichier POT, puis les chemins d'accès aux fichiers PO allemand et français.

La même information peut être écrite comme suit pour réduire le risque d'erreurs de copier/coller :

[po4a_langs] fr de
[po4a_paths] man/po/project.pot $lang:man/po/$lang.po

L'élément $lang est automatiquement développé à l'aide de la liste des langues fournie, ce qui réduit le risque d'erreur de copier/coller lorsqu'une nouvelle langue est ajoutée.

Vous pouvez en outre compacter les mêmes informations en fournissant uniquement le chemin d'accès au répertoire contenant votre projet de traduction, comme suit.

[po_directory] man/po/

Le répertoire fourni doit contenir un ensemble de fichiers PO, nommés XX.po, "XX" étant le code ISO 639-1 de la langue utilisée dans ce fichier. Le répertoire doit également contenir un seul fichier POT, avec l'extension de fichier ".pot". Pour la première exécution, ce fichier peut être vide, mais il doit exister (po4a ne peut pas deviner le nom à utiliser avant l'extension).

Notez bien que vous devez choisir entre "po_directory" et "po4a_paths". Le premier ("po_directory") est plus compact, réduit le risque d'erreur de copier/coller, mais vous oblige à utiliser la structure de projet et les noms de fichiers attendus. Le second ("po4a_paths"), est plus explicite, probablement plus lisible, et conseillé lorsque vous configurez votre premier projet avec po4a.

Fichier PO unique ou fractionné ?

Par défaut, po4a produit un seul fichier PO par langue cible, contenant tout le contenu de votre projet de traduction. À mesure que votre projet se développe, la taille de ces fichiers peut devenir problématique. Lors de l'utilisation de weblate, il est possible de spécifier des priorités pour chaque segment de traduction (c'est-à-dire, msgid) afin que les plus importants soient traduits en premier. Toutefois, certaines équipes de traduction préfèrent diviser le contenu en plusieurs fichiers.

Pour avoir un fichier PO par fichier d'origine, il vous suffit d'utiliser la chaine $master dans le nom de vos fichiers PO sur la ligne "[po4a_paths]", comme suit.

[po4a_paths] doc/$master/$master.pot $lang:doc/$master/$lang.po

Avec cette ligne, po4a produira des fichiers POT et PO séparés pour chaque document à traduire. Par exemple, si vous avez 3 documents et 5 langues, vous obtiendrez 3 fichiers POT et 15 fichiers PO. Ces fichiers sont nommés comme indiqué dans le modèle "po4a_paths", avec $master substitué au nom de base de chaque document à traduire. En cas de conflit de noms, vous pouvez spécifier le fichier POT à utiliser comme suit, avec le paramètre "pot=".

Cette fonction peut également être utilisée pour regrouper plusieurs fichiers traduits dans un même fichier POT. L'exemple suivant ne produit que deux fichiers POT : l10n/po/chapi.pot (contenant le matériel de chapi/gui.xml) et l10n/po/chapo.pot (contenant le matériel de chapo/gui.xml et chapo/cli.xml).

[po4a_langs] de fr ja
[po4a_paths] l10n/po/$master.pot $lang:l10n/po/$master.$lang.po
[type: xml] chapi/gui.xml $lang:chapi/gui.$lang.xml pot=chapi
[type: xml] chapo/gui.xml $lang:chapo/gui.$lang.xml pot=chapo
[type: xml] chapo/cli.xml $lang:chapo/cli.$lang.xml pot=chapo

En mode réparti, po4a construit un compendium temporaire pendant la mise à jour des PO afin de partager les traductions entre l’ensemble des fichiers PO. Si deux fichiers PO ont des traductions différentes pour la même chaine, po4a marquera ces deux chaines comme étant approximatives (fuzzy) et ajoutera les deux traductions dans tous les fichiers PO contenant cette chaine. Une fois corrigée par les équipes de traduction, la traduction sera automatiquement utilisée dans tous les fichiers PO.

Spécification des documents à traduire

Vous devez également lister les documents à traduire. Pour chaque fichier d'origine, vous devez spécifier l'analyseur de format à utiliser, l'emplacement du document traduit et éventuellement une configuration. Les noms de fichiers devraient être fournis entre guillemets ou en utilisant des séquences d'échappement s'ils contiennent des espaces. Voici un exemple :

[type: sgml] "doc/my stuff.sgml"  "fr:doc/fr/mon truc.sgml"  de:doc/de/mein\ kram.sgml
[type: man] script fr:doc/fr/script.1 de:doc/de/script.1
[type: docbook] doc/script.xml fr:doc/fr/script.xml \
            de:doc/de/script.xml

Mais là aussi, ces lignes complexes sont difficiles à lire et à modifier, par ex. lors de l'ajout d'une nouvelle langue. Il est beaucoup plus simple de réorganiser les choses en utilisant le modèle $lang comme ceci :

[type: sgml]    doc/mon_truc.sgml $lang:doc/$lang/mon_truc.sgml
[type: man]     script.1          $lang:po/$lang/script.1
[type: docbook] doc/script.xml    $lang:doc/$lang/script.xml

Renseigner les options

Il y a deux types d'options : les options po4a sont les valeurs par défaut des options de ligne de commande po4a tandis que les options de format sont utilisées pour changer le comportement des analyseurs de format. En tant qu'options po4a, vous pouvez par exemple spécifier dans votre fichier de configuration que la valeur par défaut du paramètre de ligne de commande --keep est 50% au lieu de 80%. Les <Options de format> sont documentées sur la page spécifique de chaque module d'analyse, par ex. Locale::Po4a::Xml(3pm). Vous pouvez par exemple passer nostrip à l'analyseur XML pour ne pas supprimer les espaces autour des chaînes extraites.

Vous pouvez transmettre ces options pour un fichier d'origine spécifique, ou même pour une traduction spécifique de ce fichier, en utilisant "opt:" et "opt_XX:" pour la langue "XX". Dans l'exemple suivant, l'option nostrip est passée à l'analyseur XML (pour toutes les langues), tandis que le seuil sera réduit à 0% pour la traduction française (qui est donc toujours conservée).

[type:xml] toto.xml $lang:toto.$lang.xml opt:"-o nostrip" opt_fr:"--keep 0"

Dans tous les cas, ces blocs de configuration doivent être situés à la fin de la ligne. La déclaration des fichiers doit venir en premier, puis l'addendum le cas échéant (voir plus loin), et ensuite seulement les options. Le regroupement des blocs de configuration n'est pas très important, car les éléments sont concaténés en interne sous forme de chaines. Les exemples suivants sont tous équivalents :

[type:xml] toto.xml $lang:toto.$lang.xml opt:"--keep 20" opt:"-o nostrip" opt_fr:"--keep 0"
[type:xml] toto.xml $lang:toto.$lang.xml opt:"--keep 20 -o nostrip" opt_fr:"--keep 0"
[type:xml] toto.xml $lang:toto.$lang.xml opt:--keep opt:20 opt:-o opt:nostrip opt_fr:--keep opt_fr:0

Notez que les options spécifiques à la langue ne sont pas utilisées lors de la création du fichier POT. Il est par exemple impossible de passer nostrip à l'analyseur uniquement lors de la construction de la traduction française, car le même fichier POT est utilisé pour mettre à jour toutes les langues. Ainsi, les seules options qui peuvent être spécifiques à la langue sont celles qui sont utilisées lors de la production de la traduction, comme l'option "--keep".

Configuration des alias

Pour transmettre les mêmes options à plusieurs fichiers, le mieux est de définir un alias de type comme suit. Dans l'exemple suivant, "--keep 0" est passé à chaque traduction italienne en utilisant ce type "test", qui est une extension du type "man".

[po4a_alias:test] man opt_it:"--keep 0"
[type: test] man/page.1 $lang:man/$lang/page.1

Vous pouvez également étendre un type existant en réutilisant le même nom pour l'alias comme suit. Cela n’est pas interprété en tant que définition récursive erronée.

[po4a_alias:man] man opt_it:"--keep 0"
[type: man] man/page.1 $lang:man/$lang/page.1

Options globales par défaut

Vous pouvez également utiliser les lignes d’"[options]" pour définir des options devant être utilisées pour tous les fichiers, indépendamment de leur type.

[options] --keep 20 --option nostrip

Comme pour les options en ligne de commande, vous pouvez abréger les paramètres passés dans le fichier de configuration :

[options] -k 20 -o nostrip

Priorités des options

Les options de toutes les sources sont concaténées, assurant que les valeurs par défaut puissent facilement être remplacées par des options plus spécifiques. L’ordre est le suivant :

• Les lignes "[options]" fournissent les valeurs par défaut pouvant être remplacées par n’importe quelle autre source.
• Puis les alias de types sont utilisés. Les paramètres spécifiques de langue remplacent ceux applicables à toutes les langues.
• Les paramètres qui sont spécifiques à un fichier master remplacent les valeurs par défaut et celles venant du type alias. Dans ce cas également, les paramètres spécifiques de langue remplacent les valeurs globales.
• Enfin, les paramètres fournis via la ligne de commande po4a remplacent tout paramètre du fichier de configuration.

Exemple

Voici un exemple montrant comment renseigner les espaces et apostrophes :

[po_directory] man/po/

[options] --master-charset UTF-8

[po4a_alias:man] man opt:"-o \"mdoc=NAME,SEE ALSO\""
[type:man] t-05-config/test02_man.1 $lang:tmp/test02_man.$lang.1 \
           opt:"-k 75" opt_it:"-L UTF-8" opt_fr:--verbose

Addendum : Ajouter des contenus dans la traduction

Si vous souhaitez ajouter une section supplémentaire à la traduction, par exemple pour mentionner les équipes de traduction, vous devez définir un addendum à la ligne définissant votre fichier d'origine. Référez-vous à la page po4a(7) pour en savoir plus sur la syntaxe des fichiers addendum.

[type: pod] script fr:doc/fr/script.1 \
            add_fr:doc/l10n/script.fr.add

Vous pouvez également utiliser des modèles de langue comme suit :

[type: pod] script $lang:doc/$lang/script.1 \
            add_$lang:doc/l10n/script.$lang.add

Si l'application d'un addendum échoue, la traduction est rejetée.

Modificateurs pour la déclaration d'un addendum

Les modificateurs d'addendum peuvent simplifier le fichier de configuration dans le cas où toutes les langues ne fournissent pas d'addendum, ou lorsque la liste des addendas change d'une langue à l'autre. Le modificateur est un seul caractère situé avant le nom du fichier.

?

Inclure l’addendum si le fichier existe, rien sinon.

@

addendum n’est pas un fichier addendum normal, mais un fichier contenant une liste d’addendas, un par ligne. Chaque addendum peut être précédé de modificateurs.

!

addendum n’est pas pris en compte, il n’est pas chargé et ne le sera pas lors de toute autre indication d’addendum.

Ce qui suit inclut un addendum dans n'importe quelle langue, mais seulement s'il existe. Aucune erreur n'est signalée si l'addendum n'existe pas.

[type: pod] script $lang:doc/$lang/script.1  add_$lang:?doc/l10n/script.$lang.add

Ce qui suit inclut un addendum pour chaque langue :

[type: pod] script $lang:doc/$lang/script.1  add_$lang:@doc/l10n/script.$lang.add

Filtrer les chaines traduites

Parfois, vous souhaitez masquer certaines chaines au processus de traduction. Pour cela, vous pouvez donner un paramètre "pot_in" à votre fichier d'origine pour spécifier le nom du fichier à utiliser à la place du vrai fichier d'origine lors de la construction du fichier POT. Voici un exemple :

[type:docbook] book.xml          \
        pot_in:book-filtered.xml \
        $lang:book.$lang.xml

Avec ce paramètre, les chaînes à traduire seront extraites du book-filtered.xml (qui doit être créé avant d'appeler po4a) tandis que les fichiers traduits seront construits à partir de book.xml. Par conséquent, toute chaîne qui fait partie de book.xml mais pas de book-filtered.xml ne sera pas incluse dans les fichiers PO, empêchant les équipes de traduction de fournir une traduction qui leur corresponde. Ainsi, ces chaînes ne seront pas modifiées lors de la production des documents traduits. Cela diminue naturellement le niveau de traduction, vous pouvez donc avoir besoin de l'option "--keep" pour vous assurer que le document est produit dans tous les cas.