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