FAQ Documentation/traduction

J'ai ajouté quelques paquets de documentation, mais ces pages n'apparaissent pas dans le manuel compilé !

La plupart du temps, vous avez oublié d'exécuter la commande ./configure. Ceci permet de détecter et d'inclure les nouvelles pages.

Une autre raison peut être que vous n'avez pas ajouté les liens dans la page source. Dans le dossier en/package/ se trouvent les fichiers xml de catégorie qui contiennent les liens vers les fichiers de la documentation du paquet. Ajouter les liens vers vos nouvelles pages ici.

La compilation du manuel l'affiche dans le terminal, mais ne génère pas de fichiers !

Le script configure n'a pas pû trouver les feuilles de style Docbook DSSSL. Installez-les avant de générer le manuel.

Existe-t-il un outil permettant aux traducteurs de repérer les fichiers modifiés ?

Travailler sur la traduction n'implique pas uniquement de traduire des fichiers et de les commiter. La plus grande partie du travail consiste à tenir à jour les fichiers déjà traduits pour conserver une synchronisation avec les fichiers anglais. Pour suivre les modifications dans l'arborescence anglaise, vous devriez vous inscrire à la liste de diffusion de la documentation PEAR. Ainsi, vous serez informé des messages de commit CVS. Si vous ne mettez pas à jour les fichiers, la traduction sera sans utilité.

Mettre à jour un fichier n'est pas évident. Particulièrement si vous ne savez pas par qui et quand ce fichier a été traduit. Il existe un système permettant de traquer les différentes révision et dates de modifications des fichiers dans peardoc.

Les commentaires de révision

Plutôt que de stocker toutes les informations dans un fichier central, les commentaires de révisions sont stockés dans le fichier en question. Ces commentaires de révisions comportent des informations sur le traducteur, sur le numéro de révision et sur le statut. Prenons par exemple le fichier bookinfo.xml :

<!-- EN-Revision: 1.16 Maintainer: jean Status: ready -->

Le numéro de révision est 1.16 (EN-Revision: 1.16), et le nom cvs du traducteur est jean. Nous pouvons également ajouter des informations sur le statut si besoin est (par exemple "partial" pour les traductions incomplètes). Ce système de commentaires est extrêmement pratique maintenant qu'il y a plus de 2400 fichiers dans l'arborescence anglaise.

Actuellement les trois champs (English revision, Maintainer, Status) sont nécessaires. Maintainer est le nom cvs de la personne ayant commité, ou alors un surnom sans espace. Le statut peut être n'importe quoi, sans espace. Notez que cet en-tête n'est pas mis à jour par cvs (contrairement à $Revision, qui est actualisé automatiquement). C'est uniquement actualisé quand vous éditez le contenu vous même.

Vous pourriez vous dire que c'est une bonne chose mais qu'utiliser ces commentaires vous ferra perdre la vue globale que vous aviez sur vos fichiers. Et bien non, vous ne perdez pas cela et même gagnez beaucoup plus. Si vous souhaitez construire une liste complète de vos fichiers vous pouvez vous rendre dans le répertoire /peardoc/ et exécuter :

./scripts/revcheck_pear.php xx > revcheck.html

Ici xx est le code imaginaire de la langue. Après l'exécution de ce script vous aurez un fichier revcheck.html dans le même répertoire. Vous pouvez trouver des comparaisons et des liens vers les différences de chaque fichier dans cette langue.

Il existe des extensions optionnelles dans ce script. C'est la raison pour laquelle le fichier translation.xml est introduit. Voici pour l'exemple un fichier translation.xml relativement simple correspondant à notre langue imaginaire xx :


<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE translation SYSTEM "../dtds/translation.dtd">

<translation>

 <intro>
  Il s'agit de quelques textes d'introduction 
  pour les traducteurs de la langue xx.
  On y apprend qui est le responsable de la traduction 
  et où trouver plus d'informations.
  Ce paragraphe est affiché en haut de 
  la page revcheck.html générée.
 </intro>

 <translators>
  <person name="Joe Doe"     email="joe@hotmail.com"
   nick="joedoe" cvs="yes" editor="yes"/>
  <person name="Jean dupont"  email="jdupont@yahoo.com"
   nick="jean"   cvs="yes"/>
  <person name="Joe Forever" email="joe@forever.net"
   nick="joefo"  cvs="no"/>
 </translators>

 <work-in-progress>
  <file name="appendices/aliases.xml" person="joedoe"
   type="working"/>
  <file name="functions/dbx.xml"      person="joefo"
   type="working"/>
 </work-in-progress>

</translation>

Dans ce fichier, vous pouvez ajouter des utilisateurs sans qu'il soit nécessaire qu'ils aient un compte cvs. Vous pouvez aussi leur assigner des documents finaux ou en cours. Le plus gros avantage dans l'utilisation de cet addon est que toutes ces informations sont utilisées pour générer dynamiquement des listes de traducteurs et de fichiers dans revcheck.html. Tous les traducteurs sont liée aux fichiers auxquels ils sont assignés. Cela permet d'avoir un résumé des fichiers assignés à des traducteurs ainsi que leurs états.

Il y a deux paramètres optionnels que vous pouvez ajouter à <file>, : la date et la revision. date est la date de début du travail et revision est la version utilisée pour la traduction quand vous avez commencé à traduire. Il n'y a actuellement pas de format défini pour le paramètre date.

Enfin, une autre possibilité de ce système est de citer toutes les personnes ayant travaillées sur le fichier. Il s'agit du commentaire credit. Une citation se fait dans le fichier history.xml et pourrait ressembler à :

<!-- CREDITS: joedoe -->

Ceci dans le cas où Joe Doe aurait traduit initialement le fichier suivi de Jean. Le commentaire credits peut utiliser la virgule comme séparateur. Ce commentaire affecte uniquement l'affichage de la table des traducteurs dans le fichier revcheck.html.

Developer FAQ (Previous) Constitution (Next)
Last updated: Sun, 29 Aug 2010 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.