3. Les outils

Dans cette section, nous allons survoler les outils dont vous aurez besoin ou que vous voudrez utiliser pour créer votre propre documentation LDP. Nous allons les décrire ici, et mieux les explorer plus tard, en même temps qu'expliquer leur procédure d'installation. Si vous utilisez d'autres outils pour écrire des manuels du LDP, faites-le moi savoir, j'ajouterai un descriptif ici.

3.1. DSSSL

La version de Norman Walsh est nécessaire, la version du LDP est optionnelle.

3.1.1. DSSSL de Norman Walsh

http://nwalsh.com/docbook/dsssl/db152.zip

NdT : ce site de Norman Walsh sur DocBook est une mine d'informations. On y trouve maintenant une version de DSSSL plus récente que celle proposée par l'auteur.

La Sémantique et le Langage de Spécification de Style (DSSSL) indique à Jade comment générer un document imprimable ou visualisable en ligne à partir d'une version SGML. DSSSL est ce qui convertit une balise de titre en une balise <H1> en HTML, ou en une police Times Roman gras 14 points pour RTF par exemple. La documentation sur DSSSL se situe à l'adresse http://nwalsh.com/docbook/dsssl/db152d.zip. Notez que modifier le DSSSL ne modifie en rien DocBook lui-même. Cela ne change que la manière dont sera rendu le texte. Le LDP lui-même utilise un DSSSL modifié qui ajoute une table des matières.

3.1.2. LDP DSSSL

http://metalab.unc.edu/gferg/ldp/ldp.dsl

Le DSSSL du LDP requière la version de Norman Walsh (voir plus haut) mais est en fait une version du DSSSL légèrement modifiée pour fournir quelques fonctionnalités supplémentaires telles qu'une table des matières.

3.2. La DTD DocBook (version 3.1)

Nécessaire - http://www.oasis-open.org/docbook/sgml/3.1/docbk31.zip

La DTD DocBook définit les balises et les structures du document SGML DocBook. Modifier la DTD, par exemple ajouter des balises, donne une DTD qui n'est plus DocBook.

3.3. Jade

Jade et OpenJade sont deux programmes qui réalisent le travail de conversion et de validation du code en utilisant la DTD et DSSSL. Un de ces deux programmes est nécessaire et doit être installé après la DTD et DSSSL.

3.3.1. Jade

ftp://ftp.jclark.com/pub/jade/jade-1.2.1.tar.gz

Jade est le programme qui se charge du traitement du document SGML. Jade utilise DSSSL et la DTD DocBook pour effectuer la vérification du texte SGML et sa conversion vers le format choisi.

3.3.2. OpenJade

http://openjade.sourceforge.net/

Une évolution de Jade écrite par la communauté DSSSL. Certaines applications exigent Jade, mais elles sont/seront mises à jour pour accepter les deux logiciels.

3.4. Interfaces ("Front-ends") pour Jade

Ces outils sont optionnels et peuvent être installés après Jade, DSSSL et la DTD.

3.4.1. sgmltools-lite

http://sgmltools-lite.sourceforge.net/

C'est le successeur du projet sgmltools, qui a officiellement été arrêté il y a à peu près un an. Depuis, Cees de Groot a créé un projet légèrement différent qui consiste en une interface utilisateur qui enveloppe Jade. Il cache la plupart des lourdeurs de syntaxe de Jade. L'auteur du présent HOWTO a réussi à installer l'ancien paquetage sgmltools suivi de sgmltools-lite et a pu formater ce document assez facilement. Il y a une page de manuel expliquant la syntaxe de sgmltools.

3.4.2. Les outils DocBook de Cygnus

Peut-être spécifique à RedHat - http://www.redhat.com/

RedHat distribue trois paquetages, depuis la version 6.2, qui offrent un support pour DocBook et fournissent plusieurs outils. Ces derniers s'installent facilement, vous permettant ainsi de vous concentrer sur votre document plutôt que vous battre avec les procédures d'installation. Il faut au préalable avoir installé TeTeX, Jade et JadeTeX. Ces trois paquetages sont disponibles sur le CD.

3.5. Editeurs

Les outils suivants peuvent être utilisés pour créer, éditer et valider votre HOWTO.

3.5.1. LyX

http://www.lyx.org/

LyX vous permet d'écrire du SGML avec la facilité d'un traitement de texte standard. Ce n'est pas un programme WYSIWYG (NdT : Ce que vous voyez est ce que vous obtenez), mais plutôt WYSIWYM (NdT :Ce que vous voyez est ce que vous voulez dire), puisque ce que vous voyez à l'écran n'est pas forcément ce que vous obtiendrez une fois que le processeur SGML aura fait son travail. L'affichage que fournit LyX est proche, mais n'est pas exactement ce que Jade vous donnera en sortie. Néanmoins, cela est suffisant pour se rendre compte de la structure du document. Les sections et sous-sections sont numérotées et mises en caractères gras, et des polices différentes sont utilisées pour représenter les balises comme <code> ou <URL>. La plupart des balises vous sont cachées pendant que vous éditez votre texte, puisque LyX génère des documents en TeX, avant de les convertir en SGML.

Figure 1. Capture d'écran de LyX

3.5.2. Emacs (PSGML)

Optionnel - http://www.lysator.liu.se/~lenst/about_psgml/

Emacs dispose d'un mode d'édition SGML appelé psgml qui est un mode majeur utilisé pour les documents SGML et XML. Il permet une coloration syntaxique et un affichage agréable qui font ressortir les balises SGML. Il fournit un moyen d'insérer les balises sans avoir à les taper à la main, et est capable de valider la syntaxe de votre document lors de sa rédaction.

Pour les utilisateurs d'Emacs, c'est un excellent outil, et beaucoup pensent qu'il permet une plus grande polyvalence que tout autre éditeur de code SGML. Il fonctionne aussi bien avec DocBook et LinuxDoc que d'autres DTD.

3.5.3. VIM

http://www.vim.org

On ne peut pas parler d'Emacs sans parler de vi. L'éditeur VIM (Vi IMproved) dispose de toutes les fonctions du vi classique, mais aussi d'un mode SGML qui utilise la coloration syntaxique pour faire ressortir les balises.

3.5.4. WordPerfect 9 (Corel Office 2000)

http://www.corel.com/

WordPerfect 9 pour Windows supporte SGML et DocBook 3.0. WordPerfect 9 pour Linux n'a pas ces fonctions SGML.

C'est la moins chère des applications commerciales qui supportent SGML.

3.5.5. sgedit

http://www.tksgml.de/

Le programme sgedit vous permet d'éditer visuellement vos fichiers SGML. Vous n'avez pas besoin de connaître Emacs ou vi pour l'utiliser. De plus, il fonctionne sous diverses plate-formes, dont Windows et Linux. C'est une application commerciale, mais le prix n'a pas encore été fixé. Il y aura des licences gratuites pour une utilisation privée ou dans un cadre éducatif.

En plus d'une édition visuelle, sgedit peut vérifier la syntaxe de votre document lors du chargement ainsi qu'à la demande avec la commande Document->Validate.

3.6. Autres outils / Références

Les éléments de cette section sont des livres de référence ou d'autres utilitaires qui sont difficilement classables (pour l'instant).

3.6.1. DocBook: The Definitive Guide

http://www.docbook.org/

Ce livre est publié par O'Reilly depuis Octobre 1999. C'est une très bonne référence sur DocBook. Je n'ai pas trouvé qu'il soit vraiment pratique, de plus il est très orienté vers XML, mais les balises DocBook 3.1 sont toutes listées dans un format commode. Vous pourrez le trouver chez votre libraire favori. Une version en ligne est également disponible (aux formats HTML et SGML) à l'adresse précédente.

3.6.2. Aspell

Optionnel - http://aspell.sourceforge.net/

C'est un correcteur d'orthographe qui sait reconnaître les balises SGML et qui ne vérifie que le contenu du document. Les correcteurs standards comme ispell essaieraient de corriger les balises, provoquant une erreur à chacune de celles-ci.

Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 18:01:30