Le format Docbook

Le format DocBook est un format de texte balisé (comme le HTML), se concentrant sur la sémantique, contrairement au HTML qui se concentre sur la présentation.

Le format DocBook lui-même

• Le Comprendre Docbook - un guide pratique de synthèse expliquant le format DocBook et les outils qui l'accompagnent.

• Le Écrire de la documentation en utilisant DocBook (cours accéléré) de David Rugge, Mark Galassi, Éric Bischoff, traduit en français par Marc Blanc.

• Le Livre de référence du format Docbook version 4.5 (en anglais) par Norman Walsh et Leonard Muellner. Ce livre offre notamment un dictionnaire complet des balises Docbook. C'est un document de référence indispensable.

• Le manuel Docbook (un peu ancien) de Philippe Martin.

• La carte de référence DocBook de Philippe Martin. Cette carte est pour l'instant limitée à une partie du format DocBook, mais elle devrait être étendue à l'avenir.

• Le Guide DocBook du projet KDE (en anglais) qui liste quelques règles de bonne pratique pour l'écriture des balises DocBook.

Guides généralistes

• Le Guide des auteurs du Projet de documentation Linux (en anglais).

• Le Wiki DocBook (en anglais).

• Le Guide DocBook pour les débutants est un document destiné aux nouveaux venus dans le monde merveilleux de DocBook (en anglais).

Production à partir de feuilles de style DSSSL (pour le SGML ou XML)

• Les feuilles de style DSSSL.

• Le Guide pratique de conversion en utilisant OpenJade.

Production à partir de feuilles de style XSL (pour le XML)

• Produire simplement une version HTML en utilisant Xsltproc - cette section du Petit guide du traducteur explique comment produire la version HTML d'un document XML DocBook en utilisant une distribution Linux/GNU Debian.

• Procédure de production avec Xalan d'une version HTML - cette procédure explique comment produire la version HTML du Petit guide du traducteur en utilisant Xalan-Java. La même procédure pourra être facilement reprise pour d'autres documents.

• Les Feuilles de style XSL.

• La feuille de style XSL personnalisée du Projet de documentation Linux (LDP). Cette feuille de style s'utilise en complément de la feuille de style XSL pour DocBook.

• La feuille de style CSS du projet Traduc.org. Il suffit de copier cette feuille de style dans le même répertoire que le document HTML¹ pour obtenir un meilleur rendu.

Convertir un document HTML au format DocBook

• html2db est un petit outil utilisant la bibliothèque tidylib pour analyser le fichier HTML source et produire un document XML ou SGML au format DocBook. Cet outil n'est plus mis à jour.

• html2db.xsl est une feuille de style XSL permettant de convertir un document en XHTML au format XML DocBook. Il est possible d'ajouter des annotations au code source pour personnaliser la production de la version DocBook.

• Html2DocBook est une autre feuille de style XSL permettant de convertir un document HTML en document au format DocBook.

Quel éditeur utiliser pour rédiger du DocBook

Éditeurs XML et DocBook

• LyX est un éditeur graphique pour LaTeX. Il permet aussi de rédiger des document au format DocBook, en choisissant un format approprié dans la boîte de dialogue « Format de document ».

• KXML Editor est un éditeur XML pour KDE.

• L'éditeur HTML Bluefish connaît aussi les balises DocBook.

• Emacs est un éditeur très puissant, mais difficile d'accès, disposant d'extensions XML.

• XEmacs est une version alternative d'Emacs.

• JEdit est un éditeur libre écrit en Java. Il dispose d'un module d'extension pour l'édition XML.

• XML Editor, de XMLmind, est un éditeur XML dont l'édition standard est disponible gratuitement. C'est un programme Java, qui donc peut fonctionner sans problème sous Linux, Mac OS X ou Windows.

Éditeurs disposant d'une coloration syntaxique

• Nano est un éditeur de texte en mode console très simple. Pour utiliser la coloration syntaxique avec un fichier XML, il vous suffit par exemple d'ajouter les lignes suivantes à votre fichier .nanorc :

  syntax "XML" "\.xml$" "\.html$" "\.sgml$"
  color yellow start="<" end=">"
  color red "&[^;       ]*;"
  color green start="<!--" end="-->"
  color ,green " "

• Vim est un éditeur difficile d'accès, mais puissant.

Vérifier l'orthographe d'un document XML DocBook avec aspell

Utilisez simplement la commande suivante :

aspell -H check mon_document.xml

cf. le Petit guide du traducteur.