Utilisation simplifiée de Docbook

Marchewka Fabien

Urbanovski Stéphane

Mirabellug / Rectorat de Nancy-Metz

Révision CVS : $Id: index.html,v 1.3 2006/01/13 10:37:48 uid5000 Exp $

Historique des versions
Version 2.021 Oct 2004S.Urbanovski
Grosse mise à jour et réorganisation.
Version 1.227 Avr 2003S.Urbanovski
Mise à jour, améliorations, transformation en xml.
Version 1.119 Oct 2001S.Urbanovski
Corrections, mise en forme, et ajout du § sur dssl.
Version 1.018 Nov 2000F.Marchewka
Version originale de ce document.

A propos de ce document

L'object de ce document est de vous aidez à écrire de la documentation en utilisant un format standart et communément utilisé : Docbook.

Il n'est pas question ici de faire le tour complet des possiblités de Docbook ( qui comporte plusieurs centaines de balises ), mais de vous aider à installer les outils nécessaires, rédiger vos premiers documents, compiler les documents dans divers formats et les mettre en forme.

(Source Docbook .xml du document.)


Table des matières

Introduction
Présentation
Principe
SGML ou XML ?
Conseils
1. Installation
Méthodes de travail
Installation de xsltproc
Installation sous Linux
Installation sous Windows
Installation de Jade / Openjade
Installation sous Windows
Installation sous Linux
Les problèmes souvent rencontrés
2. La formation d'un document Docbook
Le document de base
Les informations relatives au document
Organisation hiérarchique du document
Le document book
Le document article
Quelques balises génériques
La balise de mise en valeur : emphasis
Les balises pour les liens hypertextes : ulink, link et xref
La balise des exemples : example
Les balises utiles pour l'informatique
La balise indiquant une commande : command
La balise de nom de fichier, d'extention ou de répertoire : filename
La balise de variable d'environement : envar
Les balises représentant une interaction avec un shell
La balise programlisting
Les énumérations
La balise itemizedlist
La balise procedure
3. Comment obtenir les différents formats de sortie
En utilisant Jade / Openjade
Sous Windows
Sous Linux
4. Améliorer la présentation des documents avec des feuilles de style
La feuille de style XSLT
La feuille de style DSSSL
La feuille de style CSS
Références

Liste des exemples

2.1. Un document Docbook très simple
2.2. Une description simple d'un document Docbook
2.3. Une description plus complète d'un document Docbook
2.4. Structure d'un document de type book
2.5. Exemple d'utilisation de ulink
2.6. Exemple d'utilisation de xref
2.7. Exemple d'utilisation de xref avec xreflabel
2.8. Exemple d'utilisation de link
2.9. Exemple d'utilisation de la balise example
2.10. Un exemple
2.11. Utilisation de screen, prompt, userinput et computeroutput
2.12. Exemple d'utilisation de la balise programlisting
2.13. Exemple d'utilisation de la balise programlisting avec CDATA
2.14. Exemple d'utilisation de itemizedlist
2.15. Exemple d'utilisation de la balise procedure
4.1. La feuille de style DSSSL du mirabellug
4.2. La feuille de style DSSSL du mirabellug
4.3. La feuille de style CSS du mirabellug