Cours DocBook accelere

Écrire de la documentation en utilisant DocBook

Un cours accéléré

David Rugge

Mark Galassi

Éric Bischoff

Marc Blanc

Ce document est un premier didacticiel sur la façon d'écrire de la documentation en DocBook.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".


Table des matières
1. Introduction
1.1. À propos de ce document
1.2. Pourquoi DocBook ?
1.3. Votre vision du monde
1.4. Balisage fondé sur le contenu
2. Les premiers pas
2.1. Présentation des outils
2.2. L'ancienne méthode : les DocBook-Tools
2.3. La nouvelle méthode : XSLTProc et FOP
2.4. Mon premier fichier DocBook
2.5. Introduction aux feuilles de style
3. Notions de base
3.1. Anatomie d'une balise DocBook
3.2. Structure d'un fichier DocBook
4. La déclaration de type de document (DTD)
4.1. Utiliser des entités pour du texte partagé
4.2. Utiliser les entités pour inclure d'autres fichiers
4.3. Identification des fichiers avec les ID publics formels
4.4. Utiliser des sections marquées pour manipuler du contenu conditionnel
5. Méta-informations
6. Listes
6.1. La simplelist
6.2. La itemizedlist
6.3. La orderedlist
6.4. La variablelist
6.5. La segmentedlist
6.6. qandaset
6.7. Procédures
7. Les tableaux
8. Les graphiques
9. Les liens
10. Description de l'interface d'une application
10.1. Exemples
10.2. Éléments d'interface GUI
10.3. Éléments de ligne de commande
10.4. Description d'une API
11. Diverses balises utiles
11.1. Balises de désignation
11.2. Balises de mise en forme
11.3. Avertissements, conseils et notes
12. Où aller ensuite ?
12.1. Ressources sur DocBook
A. Licence
A.1. Free Documentation Licence
B. Mode PSGML de Emacs
Glossaire
Liste des tableaux
7-1. Kilométrage de la souris
Liste des exemples
2-1. Fichier DocBook minimal
2-2. Fichier DocBook minimal, avec certains attributs
3-1. Chapitres et sections
4-1. Entités utilisées pour partager du texte
4-2. Entités utilisées pour inclure d'autres fichiers
5-1. Metainformation de DocBook
6-1. Une simplelist
6-2. Une itemizedlist
6-3. Une orderedlist
6-4. Une variablelist
6-5. Une segmentedlist
6-6. Une qandaset
6-7. Une liste procedure
7-1. Un tableau
8-1. Un mediaobject dans le corps du texte
8-2. Une capture d'écran
9-1. Plusieurs sortes de liens
10-1. Un exemple
10-2. Un programlisting
10-3. Utilisation de CDATA
10-4. Du balisage
10-5. guimenu et shortcut
10-6. Une commande et sa sortie
10-7. Une commandsynopsis
10-8. Description d'une fonction dans la bibliothèque C API