Page suivante Page précédente Table des matières

3. Démarrer avec DocBook

Cette section couvre les nouvelles méthodes pour écrire de la documentation pour le LDP, en utilisant la DTD DocBook 3.1. Nous verrons comment récupérer, installer et utiliser les outils, ainsi qu'une introduction aux balises DocBook. Etant donné qu'il y a près de 300 balises DocBook, nous ne les verront pas toutes ici. Les lecteurs vraiment intéressés pourront se tourner vers http//www.docbook.org pour plus d'informations.

3.1 Pour les nouveaux auteurs

Si vous êtes un nouvel auteur au sein du LDP, et que vous voulez prendre en main un HOWTO (ou un Mini-HOWTO) non maintenu ou en écrire un vous même, contactez le coordinateur du LDP à l'adresse linux-howto@metalab.unc.edu. Cela lui permet de savoir qui travaille sur quel document. Tous les HOWTO envoyés devront être au format SGML (basés sur la DTD LinuxDoc ou DocBook). Les mini-HOWTO pourront être aux formats SGML ou HTML, mais seuls les documents SGML seront inclus dans les versions imprimées des HOWTO. Si vous écrivez un Mini-HOWTO, en SGML, il sera plus facile de le convertir dans les autres formats, permettant à plus de monde de profiter de votre travail.

3.2 Les listes de discussion

Il y a quelques listes de discussion auxquelles vous pouvez vous abonner pour prendre part au fonctionnement du LDP. La première est ldp-discuss@lists.linuxdoc.org, qui est le principal lieu de discussion du LDP. Pour s'abonner, il suffit d'envoyer un message avec "subscribe" dans le champ du sujet à l'adresse mailto:ldp-discuss-request@lists.linuxdoc.org. Pour se désabonner, même adresse avec "unsubscribe" dans le champ sujet du message.

3.3 Télécharger et installer les outils

sgmltools

Contrairement aux versions précédentes, vous aurez besoin de la version 2.x de sgmltools pour utiliser DocBook. Puisque tous les programmes de base ont changé, vous devrez aussi oublier les programmes du type sgml2xxx (désolé). Puisque toutes les principales distributions arrivent avec sgmltools 1.x, vous devrez supprimer le paquetage sgmltools 1.x et installer une version 2.0 ou une version CVS.

Pour obtenir le source de la dernière version CVS, vous pouvez utiliser les commandes suivantes :

CVSROOT=:pserver:cvs@cvs.sgmltools.org:/home/cvs
export CVSROOT
cvs login
cvs -z6 get sgmltools

Le mot de passe CVS est 'cvs'.

Une fois téléchargé, vous avez juste à faire ./compile, make, et make install pour installer sgmltools.

Pour les systèmes RedHat (utilisant RPM) vous pouvez utiliser la commande rpmfind pour obtenir le dernier paquetage sgmltools. Le programme rpmfind est disponible sur http://www.rpmfind.net/. Assurez-vous que vous avez recupéré sgmltools et non sgml-tools, car ce dernier est sgml-tools 1.0.9.

Pour les systèmes Debian, apt-get récupèrera le bon paquetage pour vous :

# apt-get install sgmltools

Comme pour les systèmes RedHat, il faut récupérer sgmltools et non sgml-tools.

3.4 Ecrire du SGML à la main

Puisque ceci est largement traité dans d'autres ouvrages, les personnes intéressées pourront se réferrer à http://metalab.unc.edu/godoy/using-docbook/using-docbook.html pour plus d'informations sur savoir comment produire du SGML à la main avec votre éditeur de texte favori.


Page suivante Page précédente Table des matières