Documentation française de Nagios: Feuille de route

Posted by on 12 Oct 2008 in Nagios Documentation | 0 comments

J’ai décidé de reprendre la traduction de la documentation française de Nagios pour le compte de nagios-fr.org. Comme l’a montré le récent sondage, cet élément paraît primordial pour la communauté et c’est l’occasion de lancer un premier chantier pour nagios-fr.org. Les bonnes volontés sont les bienvenus et voici la feuille de route qui attend les volontaires.

Reprise de la documentation existante

  1. Nettoyage du code source HTML et validation de celui-ci au format XHTML strict.
  2. Corrections typographiques, orthographe, grammaire et sémantique.
  3. Publication d’une version finale au format docbook, html et pdf.

Le premier point est d’ores et déjà réalisé. J’ai fini la validation XHTML de l’ensemble de la documentation existante qui peut désormais être trouvée à ce format sur nagios-fr.org. Il faut maintenant relire cette documentation et me rapporter toute erreur typographiques, orthographe, grammaire ou sémantique. Ce travail est un travail préparatoire à la génération de l’ensemble de cette documentation au format docbook. Il doit permettre une meilleure structuration de la documentation, en préparation à sa mise à jour en version 3. Le format docbook permet ensuite d’obtenir une version pdf de qualité. Une première version pdf convertie avec htmldoc à partir des sources XHTML se trouve sur nagios-fr.org en attendant la version finale. Cette première phase devrait pouvoir être menée à bien pour la fin de l’année.
La version de htmldoc utilisée pour la conversion vers le pdf est la dernière version 1.9 qui n’est pas encore finalisée. Son support du jeu de caractères utf-8 est plus qu’imparfaite; ce qui explique les erreurs sur ceux-ci encore présentes dans le document rendu. Mais après tout, c’est quand même la première version de la documentation française de Nagios au format pdf ;-).

Mise à jour vers la version 3

En tenant compte de l’expérience accumulée avec le travail sur la version 2.x du document, cette phase permettra d’arriver à une version française de la documentation de Nagios 3 qui pourra être facilement manipuler sous plusieurs formats d’édition comme Open Office, PDF, HTML et autres.

Chaîne éditoriale envisagée

La traduction collaborative serait faite dans un wiki de type moinmoin parce que celui-ci sait exporter au format docbook. J’ai bien essayé sans trop de succès (très difficile de valider le moindre xml) docbook wiki qui paraissait pourtant le mieux adapter à la chose. Le wiki reste un moyen de publication intéressant ne serait-ce que parce qu’il gère nativement les versions et différences entre celles-ci. Il faudrait mettre en place un SVN pour avoir le même genre de services dans le cas où le document de base serait travailler directement en format docbook. Le problème de ce format est qu’il ne semble pas y avoir un éditeur gratuit digne de ce nom permettant de ne pas avoir à connaître les balises docbook. XXE paraît la seule alternative plausible pour le moment mais n’est pas vraiment facile d’accès malgré tout.
Le problème qu’il reste à traiter est la transformation de XHTML vers docbook qui est loin d’être parfaite quelque soit l’outil utilisée et nécessite pas mal de reprise à la main pour aboutir à un code XML tirant parti de la puissance de docbook. Il faut y voir mon intérêt actuel pour des langages de balisages léger type txt2tags ou RestructuredText et les outils de transformation type dblatex, pandoc ou xmlto. Je continue à investiguer et accepte toute idée concernant ce type de problématique.

L’équipe de traducteurs

Une petite équipe de traducteurs motivés est en train de se constituer. Nous sommes à priori déjà trois et il reste encore de la place pour les personnes motivées, alors n’hésitez pas…

Leave a Comment