7.7. Localisation de la documentation

La documentation de Bugzilla utilise reStructured Text (reST), compilée avec l'outil, Sphinx.

La documentation de Sphinx donne une bonne introduction sur reST et l'extension spécifique à Sphinx. Lire la page indiquée ci-dessus est suffisant pour commencer la localisation. Ensuite, la section inline markup est utile pour comprendre les règles de formatage.

Comme pour les fichiers de modèles, les fichiers .rst doivent être localisés avec un éditeur gérant UTF8.

Les espaces, les lignes vides et l'indentation sont très importantes en reStructured Text, assurez-vous donc de suivre exactement la syntaxe de la version anglaise sans quoi votre version localisée ne ressemblera pas à la version anglaise.

Bien que nous vous recommandions de lire les documents indiqués plus haut, voici quelques règles :

• Dans les fichiers index.rst, ne jamais localiser le texte situé après la directive .. toctree:: : ce sont des noms de fichiers.
• Ne jamais localiser un texte encadré par deux points et un double point. Par exemple : .. warning:: This is a warning. Celui-ci sera automatiquement localisé au moment de la compilation si nécessaire. Vous pouvez localiser tout texte venant après ("This is a warning" dans cet exemple).
• Exception : ne pas localiser ce qui se trouve après la directive .. highlight:: console. Ici, le mot console sert pour le formatage.
• Ne pas localiser un terme encadré par deux double point ou par les signes inférieur et supérieur : :ref:`Démarrage rapide<quick-start>`. ``ref`` est un mot réservé et ``quick-start`` est un nom de fichier. Dans l'exemple de syntaxe suivant, il ne faut pas localiser ``using`` car il s'agit aussi d'un nom de fichier : :ref:`using`