Utilisation des scripts

Un article de Frenchmozilla.

Vous trouverez dans notre boîte à outils divers scripts dont nous vous expliquons ici le fonctionnement.

Structure

frenchmozilla-outils
  |-modifications-automatiques
  |   |-accents
  |   |   |-accents-html
  |   |   |-accents-javascript
  |   |   |-accents-xml
  |   |-aide
  |   |   |-glossaire
  |   |   |-index
  |   |   |-search-db
  |   |-versions
  |       |-versions-dtd
  |       |-versions-javascript
  |       |-versions-rdf
  |-nouveautes
  |-verification
      |-verification-aide
      |-verification-dtd
      |-verification-properties

Les catégories « modifications-automatiques », « nouveautés » et « vérification » expliquent ce que font les outils qui s'y trouvent. Chaque répertoire contient habituellement un outil. Certains ont une aide intégrée, mais la plupart n'en ont pas (même pas disant quelle est la syntaxe pour l'utiliser).

Fonctionnement

Accents

Les trois outils de traitement des accents fonctionnent sur le même principe : remplacement des différents encodages d'accents par celui spécifique au type du fichier traité. Les différents encodages qu'on peut trouver sont l'ISO-8859-1 (ou -15), le UTF-8, l'encodage Java et l'encodage <acronym title="HyperText Markup Language">HTML</acronym>.

La manière de les utiliser est simplement de les appeler à partir du répertoire racine du module à traiter (ou de n'importe quel répertoire plus profond, auquel cas seule cette partie sera traitée). Il n'y a pas d'arguments à fournir.

Aide

Glossaire

Deux outils servent à travailler sur le glossaire. Le premier, help-glossary.c, crée le fichier help-glossary.rdf à partir du fichier glossary.html. Le second, glossaire-trie, vérifie que les données de help-glossary.rdf et de help-glossary.html sont bien triées dans l'ordre alphabétique. Ces deux outils sont à invoquer dans le répertoire de l'aide et ne prennent pas d'arguments.

La vérification du tri ne marche pas à 100% quand il y a des accents. Il faut vérifier manuellement que c'est raisonnable.

Index

Cet outil recrée le fichier help-index1.rdf à partir de l'ensemble des fichiers <acronym title="HyperText Markup Language">HTML</acronym> de l'aide en ligne, plus précisément des ancres se terminant par IDX. Pour bien fonctionner, il a besoin d'une liste de catégories traduites (liste-categories.txt). Si de nouvelles catégories apparaissent, elles se trouveront dans le fichier nouvelles_categories.txt, en attendant leur traduction et leur transfert vers liste-categories.txt.

À invoquer dans le répertoire de l'aide.

Search-db

Cet outil recrée le fichier search-db.rdf à partir de l'ensemble des fichiers <acronym title="HyperText Markup Language">HTML</acronym> de l'aide en ligne, plus précisément des ancres se terminant par SDX.

À invoquer dans le répertoire de l'aide.

Versions

Les trois outils de changement de versions fonctionnent sur le même principe : remplacement de la version courante par la version fournie.

Chacun se spécialise dans un type de fichiers précis.

À invoquer à partir du répertoire racine du module à traiter, soit avec le nouveau numéro de version en argument, soit en répondant à la question posée s'il est omis.

Nouveautés

Quatre outils permettent de suivre le développement des versions anglaises.

Nouveaunightly et nouvelleversion

nouveaunightly et nouvelleversion permettent de récupérer une nouvelle version anglaise (en sélectionnant l'application et la plate-forme), et de préparer le terrain pour regarder les différences par rapport à d'autres versions. Les applications supportées pour l'instant sont la suite et Firefox, avec un début de support pour Thunderbird (mais celle-ci cause certains problèmes pour l'instant par manque de cohérence par rapport aux autres).

La plate-forme MacOSX n'est présentement pas supportée puisque les images .dmg ne semblent pas être utilisables sous autre chose que OSX.

Avant d'utiliser l'un ou l'autre, il faut créer l'arborescence suivante :

 racine-versions-anglaises
 |-mozilla-Firefox
 |-mozilla-suite
 |-mozilla-thunderbird

L'utilisation est la même pour ces deux scripts. À partir du répertoire racine :

$ nouveaunightly version [application [plate-forme]]

avec application l'un de Firefox, thunderbird ou suite, et plate-forme l'un de linux, os2 ou windows. Toutes les combinaisons ne sont pas valides. Les valeurs par défaut sont suite et linux.

Diffuneversion

diffuneversion permet de vérifier s'il y a des différences entre les fichiers de différentes plate-formes, pour une même version. Il y a déjà eu des problèmes de ce genre dans le passé pour la suite, maintenant c'est plutôt Thunderbird qui tombe dans le panneau.

L'utilisation se fait également à partir du répertoire racine :

$ diffuneversion version [application]

avec application l'un de Firefox ou suite. L'application par défaut est la suite. Les deux plate-formes actuellement utilisées sont toujours Linux et MS-Windows. Le résultat sera dans quelques fichiers .diff dans le répertoire de la version.

Diffdeuxversions

diffdeuxversions permet de vérifier ce qui a changé entre deux versions différentes, ce qui permet de déterminer ce qui doit être modifié dans la traduction française.

L'utilisation se fait également à partir du répertoire racine :

$ diffdeuxversions anc-version nouv-version [application [plate-forme]]

avec application l'un de Firefox ou suite, et plate-forme l'un de linux, os2 ou windows. Toutes les combinaisons ne sont pas valides. Les valeurs par défaut sont suite et linux. Le résultat sera dans quelques fichiers .diff dans le répertoire de la nouvelle version. C'est à partir de ces fichiers que sont créé les fichiers mozilla-anglais.diff lors de la parution d'une nouvelle version.

Vérification

Partie importante, sans laquelle l'expérience des usagers a beaucoup plus de chances d'être dégradée.

Verification-aide

Trois outils servent à vérifier ce qui a été fait dans l'index, la base de donnée de recherche et la table des matières. Si un lien n'existe pas, il sera mentionné.

Remarque : Tous les liens mentionnés ne sont pas nécessairement à enlever, les outils ne faisant pas la différence entre un lien en commentaire et un lien normal.

Ils sont invoqués à partir du répertoire de l'aide.

Verification-dtd et verification-properties

Deux outils sont à votre disposition pour vérifier que le contenu des fichiers anglais et français sont en phase. Chacun est séparé entre un script shell et un programme C. Le programme C est appelé par le script sur chacun des fichiers. En sortie, les différences notées par le programme C dans la structure des fichiers (nom des lignes, etc.).

L'utilisation se fait à partir d'un répertoire parent des versions anglaise et française à vérifier :

$ verification-dtd rep-français rep-anglais

Remarque : les lignes en commentaires causent parfois quelques petits problèmes. L'ordre des lignes dans chaque fichier est important. La première erreur dans un fichier arrête l'analyse de ce fichier.

Voilà, ce sont les outils que bous utilisons et la façon dont on s'en sert. Ils ont, jusqu'à maintenant, surtout utilisés pour la suite, mais ils devraient être assez facilement adaptables (si ce n'est pas déjà fait) pour Mozilla Firefox et Mozilla Thundebird.