Outils de traduction - 2e partie

De April MediaWiki
Cette page sert de référence aux quelques personnes qui s'occupent de mettre à jour les traductions françaises sur www.gnu.org, mais n'est absolument pas indispensable pour contribuer aux traductions.


Retour au menu de trad-gnu


Introduction[modifier]

Le site gnu.org contient des centaines de pages dont certaines sont traduites en 25 langues. Beaucoup d'entre elles sont fréquemment remaniées, les traductions doivent donc être mises à jour. Pour faciliter cette opération, les développeurs de gnu.org ont écrit un ensemble de scripts connu sous le nom de GNUnited Nations (GNUN), qui fait appel à plusieurs autres programmes. La maintenance des fichiers se fait à l'aide de systèmes de contrôle de version : CVS pour le site lui-même (dépôt www) et Git pour les traductions en français (dépôt www-fr).

Le circuit de mise à jour des traductions est résumé par le schéma suivant, adapté du manuel de GNUN :

      +-------------+              +---------------+
      |    Dépôt    |              |     Dépôt     |
      |  officiel   |              |    officiel   |
      |  www (CVS)  |              |  www-fr (Git) |
      +-------------+              +---------------+
           |   ^                         |   ^
        M1 |   | C2                   M3 |   | M5
           V   |                         V   |
      +-------------+              +---------------+
      | Répertoires |      M2      |     Dépôts    |   M4
      |   locaux    |---->---->----|     locaux    |<------.
      |  www (CVS)  |              |  www-fr (Git) |       |
      +-------------+              +---------------+       |
             ^                           |   |             |
             |     C1                    |   |             |
             '---<----<---Coordinateur---'   '---Membres---'

       M1 = cvs update ) cvs-sync*        C1 = make publish
       M2 = make sync  )                  C2 = cvs commit
       M3 = git pull
       M4 = git commit         * Script indépendant de GNUN
       M5 = git push             (voir plus loin)

Le travail se fait dans des copies locales de www et www-fr. Il comporte cinq étapes :

  1. synchroniser les copies locales de www et www-fr avec les dépôts officiels correspondants [voir schéma : M1 et M3] ;
  2. synchroniser www-fr avec www localement et déterminer quels fichiers PO ont besoin d'une mise à jour [M2] ;
  3. mettre à jour ces fichiers ;
  4. les valider ;
  5. les enregistrer dans le dépôt www-fr local [M4] et les envoyer dans le dépôt www-fr officiel [M5] (cette dernière étape demande d'avoir un compte sur Savannah - voir la Charte de trad-gnu).

Par la suite, les fichiers mis à jour seront envoyés dans le dépôt www de Savannah par le coordinateur du groupe [C1 et C2], et moins d'une heure plus tard GNUN régénèrera les pages traduites.


Le circuit des nouvelles traductions et des révisions est le même, à part que la synchronisation des dépôts n'est pas nécessaire puisque l'initiative appartient à l'équipe de traduction.


Sources d'information et de formation

  • Le manuel de GNUN décrit le principe de la génération des pages traduites et détaille chaque fonction de GNUN. Ce que GNUN permet de faire, entre autres :
    • valider les fichiers PO ;
    • transformer les fichiers PO en pages HTML (avec le style par défaut), ce qui facilite grandement la relecture ;
    • voir quelles traductions ont besoin d'une mise à jour.
  • Git est ce qui risque le plus de dérouter les débutants, mais avec l'aide attentionnée et la supervision de notre coordinateur il suffit d'une semaine ou deux pour s'y mettre, foi de Mme Michu. L'essentiel de ce qu'il y a à savoir se trouve dans les trois premiers chapitres du Git Book. S'il y a un problème, quelques mots-clés dans un moteur de recherche ou un appel au secours sur la liste font merveille. Pas de panique, les erreurs sont la plupart du temps rattrapables.

Et devinez quoi... Git a des interfaces graphiques :

  • Git GUI (multiplateforme) permet de faire une bonne partie des opérations. Il est couplé avec gitk.
  • gitk visualise l'historique des branches, montre les différences entre fichiers et permet de faire des recherches dans l'arborescence.


Il arrive qu'une même opération puisse être faite de différentes manières. Les méthodes qui utilisent des scripts sont les plus efficaces pour un travail de routine, même si leur mise en place semble un peu compliquée (branche Git supplémentaire, configuration).


Mise en place des outils[modifier]

Clonage du dépôt Git www-fr et création d'une branche[modifier]

Prérequis : git, avoir un compte sur Savannah et appartenir au groupe www-fr.

Le dépôt www-fr comprend 2 branches principales (+ éventuellement des branches perso) :

  • master contient les fichiers .fr.po  sur lesquels on travaille. Elle ne peut pas être supprimée.
  • scripts contient quelques outils :
    • transvalid-po convertit les POs en page HTML, et vérifie que leur format est correct et que le HTML est conforme aux standards du W3C. L'ensemble de ces opérations est désigné par un néologisme, « transvalidation ». Le HTML original est requis, ainsi qu'un autre fichier de la branche scripts, html5.dtd, qui provient du paquet GNUN.
    • transvalid-batch fait la même chose sur une liste de POs, typiquement l'ensemble d'un commit. Une arborescence contenant les HTML originaux est requise.
    • previewpo.pl (écrit par Donatas Klimašauskas) crée un HTML générique à partir d'un PO. Pas besoin de l'original.
    • micro-www-checkout crée un répertoire www réduit, ne contenant que les fichiers nécessaires à la régénération de pages traduites en français par transvalid-po ou transvalid-batch.
    • cvs-sync synchronise le répertoire www avec le dépôt CVS et le répertoire www-fr avec www, puis établit un rapport sur l'état des POs qui peut éventuellement être envoyé sur la liste de diffusion.
    • po2pad et pad2po facilitent le passage du format PO au pad de traduction et inversement (po2pad utilise un autre fichier de la branche scripts, pad-header-gnu).

Ne pas hésiter à modifier ces scripts, à les critiquer ou à en créer de nouveaux. Ils sont là pour ça. ;-)

1. Clonage de www-fr

Créer le répertoire de travail (GNU/ par exemple) qui contiendra aussi www, et s'y placer :

mkdir -p ~/GNU && cd ~/GNU

Ensuite, on a le choix de cloner le dépôt complet ou seulement certaines branches.

  • Méthode la plus simple : clonage du dépôt complet
git clone ID-SUR-SAVANNAH@git.sv.gnu.org:/srv/git/www-fr.git

Cela évite de traîner l'historique de www-fr avec les scripts, et inversement. Mais surtout, cela permet d'utiliser les scripts avec les fichiers PO sans avoir à les copier ailleurs. Il est en effet impossible d'accéder en même temps à deux branches d'un même dépôt local qui n'ont aucun fichier en commun. Les scripts peuvent être n'importe où ; en revanche, le répertoire www-fr doit avoir la même racine que www.

Pour la branche master (celle qui contient les fichiers PO) :

mkdir -p www-fr && cd www-fr
git init
git remote add -f -t master -m master origin \
    ID-SUR-SAVANNAH@git.sv.gnu.org:/srv/git/www-fr.git
git merge origin

Pour la branche scripts, c'est un peu plus compliqué car celle qu'on crée localement s'appelle master par défaut mais ne correspond pas à la branche master du dépôt distant. Si l'on veut pouvoir pousser les modifications locales, il faut la renommer ; autrement, on a une erreur assez énigmatique : « error: src refspec scripts does not match any. »

mkdir -p www-fr-scripts && cd www-fr-scripts
git init
git remote add -f -t scripts -m scripts origin \
    ID-SUR-SAVANNAH@git.sv.gnu.org:/srv/git/www-fr.git
git merge origin
git branch -m master scripts

2. Configuration

Écrire dans ~/.gitconfig l'identité de celui/celle qui fait les commits. Sans l'option --global, l'information est écrite dans le fichier .git/config (l'adresse de courriel n'a pas besoin d'être valide, il faut seulement qu'elle contienne « @ ») :

~/GNU/www-fr
git config --global user.name "Gribouille Tartempion"
git config --global user.email gtartempion@serveur.mail

La commande ci-dessous va faciliter le travail à plusieurs :

git config branch.autosetuprebase remote

Remarque : on peut demander à Git d'ignorer certains fichiers en créant un fichier ~/.gitignore_global, ou en utilisant le fichier .git/info/exclude de chacun des dépôts locaux. L'exclusion des fichiers .html est nécessaire si l'on se sert de transvalid-po, qui sauvegarde les pages web traduites dans le répertoire ou se trouve le PO. Par exemple, le fichier exclude de www-fr pourrait contenir :

*~
*.html
*.txt
*.diff

3. Création d'une branche perso (optionnelle)

Créer une branche synchronisée avec la branche master, et l'envoyer sur le serveur (remplacer « gt » par le nom de la branche) :

cd ~/GNU/www-fr
git branch --set-upstream gt origin/master
git config branch.autosetuprebase remote
git push origin gt

Synchroniser la branche gt avec origin/master. Les modifs qui sont sur gt mais pas sur master s'ajouteront en tête de branche grâce à l'option « autosetuprebase » :

git checkout gt
git pull

Installation d'une arborescence www locale[modifier]

Le type d'arborescence à créer dépend de ce que l'on veut en faire.

  • Installation minimum pour utiliser transvalid-batch : micro-www-checkout

Ce script télécharge les fichiers strictement nécessaires à transvalid-batch. C'est la méthode recommandée avec un SSD (disque à mémoire flash). Il est en effet très mauvais pour ce type de disque de modifier fréquemment des centaines de fichiers, ce qui arrive si l'on synchronise une arborescence www complète avec le dépôt CVS.

Les fichiers nécessaires à la mise à jour des nouvelles traductions doivent être ajoutés séparément. Le script cvs-sync s'en charge à l'étape de synchronisation (voir plus loin).

Prérequis : cvs, rsync.

cd ~/GNU/www-fr-scripts
./micro-www-checkout -l fr
  • Installation complète

Pour avoir une image complète du site web (près de 500 Mo), il faut passer par la méthode traditionnelle :

Prérequis : cvs.

 
mkdir -p ~/GNU && cd ~/GNU
cvs -z3 -d:pserver:anonymous@cvs.savannah.gnu.org:/webcvs/www co www

Installation de GNUN (optionnelle)[modifier]

Prérequis :

  1. une arborescence www complète (voir plus haut) ;
  2. make, gawk ;
  3. texinfo, gettext, po4a (pour la conversion HTML <--> PO) ;
  4. pour la validation des pages HTML : libxml2, libxml2-utils et la DTD XHTML 1.0 du W3C (paquet Debian w3c-sgml-lib).

Télécharger le paquet gnun-latest (ou gnun-0.12) par exemple dans $HOME, et l'extraire. On obtient le dossier gnun-0.12 :

wget ftp://ftp.gnu.org/gnu/gnun/gnun-latest.tar.gz
tar xzvf gnun-latest.tar.gz

Se placer dans le dossier gnun-0.12 et préparer l'installation :

cd ~/gnun-0.12
./configure
make

Il faut éditer le fichier gnun.conf pour remplacer les adresses de courriel, afin que les tests ne soient pas envoyés aux webmasters GNU. ;-)

sed -i 's/bug-gnun@gnu.org/adresse@bidon.fr/' gnun.conf

Maintenant, on peut installer GNUnited Nations dans ~/GNU/www/server/gnun :

sudo make install

Enfin, il faut copier config.mk et GNUmakefile dans le répertoire www/server/gnun :

cp GNUmakefile ~/GNU/www/server/gnun/
cp config.mk ~/GNU/www/server/gnun/

Les cinq étapes d'une mise à jour[modifier]

Synchronisation des dépôts locaux avec le dépôt www de Savannah[modifier]

  • À l'aide du script cvs-sync

Prérequis : cvs, git.

Ce script fait l'inventaire des PO à mettre à jour dans la foulée de la synchronisation et établit un rapport sur l'état des POs (nombre de chaînes à traduire ou « fuzzy »), qui peut éventuellement être envoyé sur la liste trad-gnu@april.org .

Si cvs-sync est dans le répertoire www-fr-scripts :

cd ~/GNU/www-fr-scripts
./cvs-sync
  • Manuellement

Prérequis : cvs, git, GNUN, GNUmakefile des équipes de traduction à la racine de www-fr.

1. Synchroniser l'arborescence www locale avec le dépôt CVS de www :

cd ~/GNU/www
cvs update

Remarque 1. La connexion au dépôt CVS de Savannah est quelquefois lente et irrégulière. On peut alors utiliser une solution de repli plus rapide : aller voir le rapport de GNUN sur l'état des traductions et synchroniser uniquement les fichiers à mettre à jour :

cd ~/GNU/www
cvs update SECTION/po/DOCUMENT.fr.po SECTION/po/DOCUMENT.pot SECTION/DOCUMENT.html

Remarque 2. La synchronisation ne se fait bien (c'est-à-dire sans « conflit pendant la fusion ») que si les fichiers n'ont pas été modifiés localement. Si pour une raison quelconque ils l'ont été (à l'étape de validation par exemple), on peut supprimer les changements globalement :

cd ~/GNU/www
cvs diff | patch -R -p0

Ou bien, si la connexion est mauvaise, on peut restreindre l'opération à un dossier particulier :

cd ~/GNU/www/DOSSIER
cvs diff | patch -R -p0

2. Synchroniser localement www-fr avec www en utilisant GNUN (ne pas oublier de se placer sur la branche adéquate) :

cd ~/GNU/www-fr
git checkout master
make sync

Inventaire des PO à mettre à jour[modifier]

  • À l'aide du script cvs-sync

Prérequis : cvs, git.

L'inventaire se fait dans la foulée de la synchronisation (voir plus haut).

  • À l'aide de GNUN (ne pas oublier de se placer sur la branche adéquate)

Prérequis : cvs, git, GNUN, GNUmakefile à la racine de www-fr.

cd ~/GNU/www-fr
git checkout master
make report

Mise à jour des PO[modifier]

Il est préférable de mettre les fichiers à jour dans www-fr (voir plus loin pourquoi).

On peut utiliser un éditeur de PO ou un éditeur de texte ordinaire (voir Outils de traduction 1e partie).

Pour faciliter la relecture, on peut convertir le fichier PO en HTML générique avec previewpo.pl. Une page web plus conforme à l'original peut être régénérée avec transvalid-po (voir plus loin).

Transvalidation (génération des pages HTML et validation)[modifier]

  • À l'aide de transvalid-po ou transvalid-batch

Le script transvalid-po permet de régénérer une page traduite à partir du PO et de la page originale ; de plus, il vérifie que les POs sont formatés correctement et que la page traduite n'a pas d'erreur de validation XHTML. transvalid-batch fait la même chose sur une série de POs, par exemple l'ensemble des fichiers d'un commit. Une fois validés, les POs peuvent être commités dans le dépôt Git local. Les pages traduites sont enregistrées dans www-fr, mais on fait en sorte que Git les ignore (voir plus haut). L'arborescence www n'est pas modifiée.

Prérequis :

  1. po4a (qui dépend de gettext, perl, etc.), awk,
  2. xmllint (paquet Debian libxml2-utils),
  3. DTD XHTML 1.0 du W3C (paquet Debian w3c-dtd-xhtml),
  4. html5.dtd de gnun (dans le même répertoire que transvalid-po).

Si transvalid-po est dans le répertoire www-fr-scripts :

cd ~/GNU/www-fr-scripts
./transvalid-po
  • À l'aide d'une installation locale de GNUN

1. On met le fichier à valider DOCUMENT.fr.po dans le dossier ~/GNU/www/SECTION/po/. C'est faisable avec « make publish », mais alors tous les PO de www-fr seront reformatés et copiés dans www, même ceux qui ne sont pas encore prêts à être validés.

2. On se place dans le répertoire ~/GNU/www/server/gnun, et on demande à générer la page :

cd ~/GNU/www/server/gnun
make VALIDATE=yes ../../SECTION/DOCUMENT.fr.html

Et voilà, make dit s'il y a une erreur. On peut modifier ../../SECTION/po/DOCUMENT.fr.po et régénérer la page HTML, qu'on récupère dans ~/GNU/www/SECTION/.

Remarque. Il arrive fréquemment que le fichier POT soit régénéré au cours de la validation (voir le manuel de GNUN). Cela modifie également le fichier PO (ainsi que des fichiers intermédiaires) et perturbe les synchronisations ultérieures. Il est possible de supprimer les changements comme expliqué plus haut, mais il faut évidemment que le PO mis à jour soit sauvegardé ailleurs. Il est donc recommandé de faire les mises à jour dans www-fr et de ne valider qu'une copie. De même, la page DOCUMENT.fr.html régénérée doit être sauvegardée si l'on veut s'en servir pour la relecture.

Envoi dans le dépôt www-fr[modifier]

1. Ajouter des modifications ou de nouveaux fichiers à la branche master (indexation) :

cd ~/GNU/www-fr
git checkout master
git add fichier1 fichier2 ...

2. Enregistrer (commiter) les modifications dans le dépôt local (branche master) :

git commit -m "Message de commit" fichier1 fichier2 [...]

Les commits peuvent être regroupés logiquement, par exemple modifications d'un même type sur plusieurs fichiers.

3. Envoyer (pousser) les modifications sur le serveur :

git push

4. Éventuellement faire la liste des fichiers modifiés :

git diff --name-only master master^

5. Prévenir trad-gnu@april.org en joignant la liste des fichiers s'il y en a beaucoup.