i18n - 3. Procédure de mise à jour des documents

Comme la documentation anglaise est la documentation maître, elle doit être mise à jour en premier. Une telle mise à jour peut être effectuée par un membre de l'équipe i18n (par exemple par les rédacteurs anglais) ou directement par les développeurs.

Pour que tout se passe bien, vous devez suivre les procédures suivantes.

3.1 Demande de traduction

Quand un nouveau document est mis en ligne ou que des changements ont lieu dans la documentation anglaise, les traducteurs sont prévenus par un message envoyé sur la liste de diffusion fink-18n. Le message doit contenir les informations suivantes :

Une note dans l'objet du message indiquant qu'il s'agit d'une demande de traduction, par exemple : "[translation]", ou "[translation-delayed]" pour les documents anglais qui ne sont pas mis en ligne immédiatement.
De plus, le nom du fichier concerné doit être inclus dans le corps du message.
Un diff doit être inclus pour indiquer les modifications faites, par exemple :
```
diff -Nru3 -rlast_revision rhead 
```

Note : comme la simple exécution du commit d'un fichier XML génère un message sur la liste de diffusion fink-commits qui remplit tous les critères mentionnés ci-dessus, le plus simple est de faire suivre le message en changeant son objet. Néanmoins, cela ne fonctionne pas bien, si le nombre de changements est important.

3.2 Nouveau document

On fait un commit sur la version anglaise du document et on l'active, il est ensuite traduit comme expliqué ci-dessous.

Note : si le nouveau document est inclus dans un nouveau répertoire, n'oubliez pas d'ajouter ce nouveau répertoire au Makefile situé dans le répertoire xml. Faute de le faire, le processus de compilation ne s'effectuera pas correctement.

3.3 Nouvelles traductions

Le chef d'équipe de la langue concernée (ou une autre personne ayant un accès CVS) fait un commit et active les documents dès qu'ils sont prêts.

On entend par nouvelle traduction :

la première traduction d'un document existant,
toute traduction partielle d'un document existant,
la traduction d'un nouveau document anglais.

3.4 Mise à jour rapide de la documentation existante

On fait un commit et l'on active immédiatement la documentation maître anglaise, - quelque soit la personne qui change le fichier XML, elle doit aussi faire le commit des fichiers PHP et HTML et activer les changements. Ensuite les équipes de traduction mettent à jour leurs versions, font un commit de tous les fichiers (XML et PHP), puis activent les changements.

Ne changez jamais un fichier php généré dynamiquement ; changez le fichier xml correspondant.

Vérifiez que la ligne cvsid en début de fichier n'est pas coupée en deux.

Notes :

Les modifications du guide d'internationalisation (ce document) sont toujours faites suivant ce schéma, car les changements affectent l'ensemble des équipes de traduction.
Les modifications des documents statiques (fichiers PHP non générés via XML) sont toujours faites suivant ce schéma, car il est difficile de retarder leur activation.

3.5 Mise à jour retardée de la documentation existante (fichiers générés via XML uniquement)

Dans ce case, on fait le commit de la version anglaise du fichier XML, mais pas des fichiers PHP et HTML, c'est-à-dire que l'on s'arrête à l'étape 5 de la section Fichiers dynamiques en 2.9. Tous les traducteurs traduisent dans leurs langues respectives et font le commit du seul fichier XML (c'est-à-dire le même fichier que pour l'anglais) dans un laps de temps prévu d'avance. La génération, le commit et l'activation de tous les fichiers PHP et HTML sont faits en même temps par un des chefs du projet i18n quand le délai est écoulé.

3.6 Pour les développeurs et les documentalistes anglais

La règle actuelle est que tous les documents doivent être mis à jour suivant le schéma mise à jour rapide, sauf si vous avez une bonne raison de faire autrement.

Suite: 4. Autres ressources