HOWTO HOWTO
 Mark F. Komarinski ([email protected])
 Adaptation fran�aise par Nicolas Duboc ([email protected])
 $Id: HOWTO-HOWTO.sgml, v1.4, 17 Mars 2000 markk Exp $

 Explique les outils, les proc�dures, et donne des conseils aux auteurs
 de HOWTO.
 ______________________________________________________________________

 Table des mati�res
























































 1. Introduction

    1.1 Historique
    1.2 Nouvelles versions
    1.3 Commentaires
       1.3.1 Historique des versions
    1.4 Copyrights
    1.5 Contributions et remerciements

 2. Informations g�n�rales sur le LDP et SGML

    2.1 Le LDP
    2.2 SGML
       2.2.1 Pourquoi SGML au lieu de HTML ou d'autres formats ?
    2.3 Les outils
       2.3.1 sgmltools
       2.3.2 TeX
       2.3.3 LyX
       2.3.4 Emacs (PSGML)
       2.3.5 WordPerfect 2000
       2.3.6 DocBook : L'ultime guide

 3. D�marrer avec DocBook

    3.1 Pour les nouveaux auteurs
    3.2 Les listes de discussion
    3.3 T�l�charger et installer les outils
       3.3.1 sgmltools
    3.4 Ecrire du SGML � la main

 4. D�marrer avec LinuxDoc

    4.1 Pour les nouveaux auteurs
    4.2 Les listes de discussion
    4.3 T�l�charger et installer les outils
       4.3.1 sgmltools
    4.4 Ecrire du SGML � la main
       4.4.1 D�but du document
       4.4.2 Les informations de l'ent�te
       4.4.3 Les sections
       4.4.4 Les paragraphes
       4.4.5 Texte avanc�
       4.4.6 Les listes
       4.4.7 Texte verbatim
       4.4.8 Les URL
       4.4.9 Les r�f�rences
       4.4.10 Les caract�res sp�ciaux
    4.5 Ecrire du SGML avec d'autres outils
       4.5.1 LyX
       4.5.2 Emacs
       4.5.3 Les autres outils SGML
    4.6 Les bases de CVS
    4.7 Obtenir un compte CVS
    4.8 Autres informations sur CVS
       4.8.1 Acc�s CVS anonyme
       4.8.2 Fichiers CVS via le web
       4.8.3 Acc�s graphique � CVS
    4.9 CVS et la mise � jour des fichiers

 5. Distribuer votre documentation

    5.1 Avant la distribution
    5.2 Notions de copyright et de licence
    5.3 Soumission au LDP Une fois que votre document a �t� relu et que vous avez pris en compte les commentaires des relecteurs, vous pouvez soumettre votre texte au LDP. Envoyez un e-mail �

 6. Conseils de style
 7. FAQ � propos du LDP

    7.1 Je d�sire aider le LDP. Comment puis-je le faire ?
    7.2 Je voudrais publier un ensemble de documents du LDP dans un livre. Comment est prot�g� le contenu du LDP ?
    7.3 J'ai trouv� une erreur dans un document du LDP. Puis-je le corriger ?


 ______________________________________________________________________

 11..  IInnttrroodduuccttiioonn

 11..11..  HHiissttoorriiqquuee

 Ce document a �t� commenc� le 26 ao�t 1999 par Mark F. Komarinski
 ([email protected]) apr�s deux jours de frustration pour faire marcher
 les outils. Si ne serait ce qu'un auteur du LDP (NdT: "Linux
 Documentation Project", Projet de Documentation Linux) trouve de
 l'aide dans ce document, j'aurai atteint mon objectif.


 11..22..  NNoouuvveelllleess vveerrssiioonnss

 La version la plus r�cente de ce document peut �tre trouv�e sur ma
 page personnelle http://www.cgipc.com/~markk/ au format SGML. D'autres
 versions peuvent �tre trouv�es dans diff�rents formats sur le site du
 LDP http://www.linuxdoc.org/.


 11..33..  CCoommmmeennttaaiirreess

 Les commentaires � propos de ce HOWTO peuvent �tre envoy�s � l'auteur
 ([email protected]).



 11..33..11..  HHiissttoorriiqquuee ddeess vveerrssiioonnss

 v1.4 (17 Mars 2000)


 �  Ajout des commentaires de Gregory Leblanc (GLeblanc@cu-
    portland.edu) � propos des soumissions au LDP et sur psgml sous
    Emacs. Merci !


 11..44..  CCooppyyrriigghhttss

 (c) 1999-2000 Mark F. Komarinski

 Ce manuel peut �tre reproduit en totalit� ou en partie, sans frais,
 sous r�serve des restrictions suivantes :

 �  Cette note de copyright et de permission doit �tre pr�serv�e dans
    toutes copies partielles ou totales.

 �  Toutes traductions ou travaux d�riv�s doivent �tre approuv�s par
    l'auteur en le pr�venant avant leur distribution.

 �  Si vous distribuez une partie de ce travail, les instructions pour
    obtenir la version compl�te devront �galement �tre fournies.

 �  De courts extraits peuvent �tre reproduits, sans ces notes de
    permissions, dans  le cadre d'expos�s et de citations si les
    r�f�rences sont correctement cit�es.


 Des exceptions � ces r�gles peuvent �tre tol�r�es pour un but �ducatif
 : contactez l'auteur et demandez lui. Ces restrictions sont l� pour
 nous prot�ger en tant qu'auteurs, et non pour vous restreindre en tant
 que lecteurs ou enseignants. Tous les codes sources apparaissant dans
 ce document sont prot�g�s par la Licence Publique G�n�rale GNU,
 disponible par FTP anonyme depuis le site d'archive GNU.


 11..55..  CCoonnttrriibbuuttiioonnss eett rreemmeerrcciieemmeennttss

 Merci � tous ceux qui ont donn� leurs commentaires lorsque j'�crivais
 ceci. Cela inclut Deb Richardson et Daniel Barlow et les autres
 membres de la liste de diffusion ldp-discuss.


 J'ai tir� quelques sections du Howto Index (disponible sur tous les
 sites du LDP) et de la documentation de sgmltools. Vous trouverez les
 r�f�rences � sgmltools et le LDP ailleurs dans ce document.


 Les sections sur l'acc�s r�seau � CVS ont �t� partiellement �crites
 par Serek ([email protected]).
 Les sections sur DocBook ont �t� en partie �crites par Jorge Godoy
 ([email protected] <mailto:[email protected]>). Un grand
 merci � tous les deux pour leur aide.


 22..  IInnffoorrmmaattiioonnss gg��nn��rraalleess ssuurr llee LLDDPP eett SSGGMMLL

 22..11..  LLee LLDDPP

 Le Projet de Documentation de Linux (LDP) a �t� commenc� pour fournir
 aux nouveaux utilisateurs un moyen d'obtenir rapidement des
 informations sur un sujet particulier. Il ne contient pas seulement
 une s�rie de livres sur l'administration syst�me, le r�seau ou la
 programmation, mais �galement un grand nombre de petits travaux sur
 des sujets plus individuels, �crits par ceux qui les ont utilis�s. Si
 vous voulez savoir comment imprimer, vous trouverez le Printing HOWTO.
 Si vous voulez mettre en place un r�seau, r�cup�rez le Ethernet HOWTO;
 etc.


 Au d�part, la plupart de ces documents �taient au format texte ou
 HTML. Avec le temps, il fallait trouver un meilleur moyen de g�rer ces
 travaux. Celui-ci permettrai de les lire depuis une page web, depuis
 un fichier texte sur un CD-ROM, ou encore depuis votre organiseur de
 poche.  La solution s'est av�rer �tre SGML.


 22..22..  SSGGMMLL

 Le "Standard Generalized Markup Language" (SGML) est un langage qui
 est bas� sur le balisage du texte. De ce point de vue, il est
 similaire � HTML, mais toutes les similitudes s'arr�tent l�. La force
 de SGML est que contrairement � la philosophie WYSIWYG (What You See
 Is What You Get, NdT: Ce que vous voyez est ce que vous obtenez), vous
 ne d�finissez pas la couleur, la taille de la police, ou d'autres
 param�tres de formatage. A la place, vous d�finissez des �l�ments
 (paragraphes, sections, listes num�rot�es) et laissez l'interpr�te
 SGML et le programme final s'occuper du placement, des couleurs, des
 polices, et tout le reste. HTML fait la m�me chose, puisqu'il est en
 fait une subdivision de SGML.


 Il y a en fait deux parties qui constituent SGML. La premi�re est la
 Structure, qui est appel�e la DTD, ou encore D�finition du Type du
 Document. La DTD d�finie les relations entre les diff�rents �l�ments
 d'un texte. La DTD LinuxDoc, utilis�e pour cr�er ce document, en est
 un exemple. La DTD fournit un style et une apparence � tous les
 documents cr��s qui l'utilisent. La seconde est le Contenu, qui est
 trait� par l'interpr�teur SGML et qui est �ventuellement vu par
 l'utilisateur. Ce paragraphe est un contenu, comme pourrait l'�tre une
 image, une table, une liste num�rot�e ou autre chose. Le contenu est
 entour� de balises pour s�parer les diff�rents �l�ments.


 Dans quelques temps, le Projet de Documentation Linux passera de
 LinuxDoc � DocBook, d�j� utilis�e par d'autres auteurs, donnant ainsi
 au LDP un style plus consistent de documents SGML. Quand cela
 arrivera, nous vous tiendront inform�s par l'interm�diaire de ce HOWTO
 ou des listes de diffusion. La diff�rence la plus importante r�side
 dans le fait que DocBook utilise des balises pour les diff�rents types
 de contenus (comme les commandes, les noms de fichiers, de
 r�pertoires, etc.)  alors que LinuxDoc utilise des balises bas�es sur
 l'apparence que devrait prendre le texte (vous pouvez utiliser un type
 "insistant" ou machine � �crire).


 22..22..11..  PPoouurrqquuooii SSGGMMLL aauu lliieeuu ddee HHTTMMLL oouu dd''aauuttrreess ffoorrmmaattss ??

 SGML fournit d'autres outils que ceux de mise en forme. Vous pouvez
 cr�er des index, des tables des mati�res ou des liens internes ou
 externes automatiquement. Le paquetage sgmltools vous permet aussi
 d'exporter (j'app�lerai �a g�n�rer � partir de maintenant) vos
 documents SGML vers LaTeX, info, du texte, HTML ou RTF. Vous pouvez
 alors cr�er d'autres types de fichiers  (DOC, PostScript, etc.) �
 partir de ces formats de base. Des programmes comme LyX (mon �diteur
 WYSIWYM pr�f�r�) vous permettent d'�crire au format TeX, d'exporter au
 format SGML et de g�n�rer ce que vous voulez depuis SGML.


 En fin de compte, SGML s'int�resse plus au fonctionnement des �l�ments
 plut�t qu'� leur apparence. Une diff�rence de taille, en tout cas une
 qui vous permettra d'�crire plus vite, puisque vous n'avez plus � vous
 souciez de la justification des paragraphes, des types et tailles des
 polices, etc.


 22..33..  LLeess oouuttiillss

 Dans cette section, je vais survoler les outils dont vous aurez besoin
 ou voudrez utiliser pour cr�er votre propre documentation LDP. Je vais
 les d�crire ici, et mieux les explorer plus tard, en m�me temps que
 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.


 22..33..11..  ssggmmllttoooollss

 Requis


 Le paquetage sgmltools contient les outils SGML n�cessaires pour
 g�n�rer les formats dont on a d�j� parl�. Il inclut �galement la DTD
 LinuxDoc, indispensable aux documents LDP. Pour cr�er des documents
 SGML, c'est tout ce dont vous avez besoin. Si vous voulez convertir au
 format TeX, vous aurez aussi besoin de ce dernier. Le paquetage
 sgmltools est disponible soit dans votre distribution, soit via
 http://www.sgmltools.org/. Notez que vous aurez besoin de la version
 1.0.9 pour utiliser LinuxDoc. Toute autre version utilise DocBook.

 22..33..22..  TTeeXX

 Optionnel


 TeX est le langage de balisage de texte favori pour beaucoup, dont les
 personnes du monde math�matique. Je me rappelle d'examens de maths qui
 �taient en fait �cris avec TeX. C'est aussi un des premiers langages �
 balises qui est encore utilis� (les autres �tant les formats *roff
 utilis�s pour les pages de manuels). En fait, TeX partage une grande
 partie de ses concepts avec SGML. N�anmoins, TeX g�n�re ses fichiers
 au format DVI (ind�pendant du p�riph�rique de sortie) qui peut alors
 �tre converti en un autre format. Malheureusement, le format DVI ne
 peut pas �tre facilement converti en autre chose que des langages
 d'impression (PostScript, PCL), le rendant difficile � traduire en
 HTML. TeX est disponible dans toutes les distributions Linux en tant
 que LaTeX ou TeTex. Vous pourrez utiliser l'un des deux.


 22..33..33..  LLyyXX

 Optionnel


 Le programme LyX est un �diteur de texte graphique WYSIWYM (What You
 See Is What You Mean -- NdT : Ce que vous voyez est ce que vous
 pensez) et constitue un lien entre les applications graphiques et les
 r�gles de SGML quelque fois compliqu�es. En fait, LyX est utilis� pour
 �crire des documents TeX, et la plupart dans r�gles TeX sont pr�sentes
 dans LyX. Par exemple, puisque les sections sont num�rot�es
 automatiquement, vous ne pouvez pas ins�rer d'espace facilement. Ce
 serait contraire � la philosophie de TeX. De m�me, SGML ignore souvent
 ces espaces. Le programme LyX supporte la DTD LinuxDoc et fournit un
 document de base pour vous permettre d'�crire (ou d'�diter) votre
 documentation LDP comme vous en avez l'habitude, sans devoir utiliser
 vi et vous souvenir quelles sont les balises pour cr�er une liste �
 items. Vous trouverez LyX � l'adresse http://www.lyx.org/.


 Pour ceux qui utilisent KDE, il existe un portage de LyX bas� sur les
 librairies Qt. Vous trouverez plus d'informations � l'adresse
 http://www.devel.lyx.org/~ettrich/klyx.html
 <http://www.devel.lyx.org/~ettrich/klyx.html>.


 22..33..44..  EEmmaaccss ((PPSSGGMMLL))

 Optionnel


 Il existe un mode Emacs pour �crire des documents SGML ou XML. Vous
 trouverez plus d'informations �
 http://www.lysator.liu.se/projects/about_psgml.html


 22..33..55..  WWoorrddPPeerrffeecctt 22000000

 Optionnel


 La derni�re version de WordPerfect 2000 supportera les modes SGML. Je
 ne sais pas encore si cel� concerne aussi LinuxDoc, ou juste DocBook.
 Si vous �tes un beta-testeur de WP2000 et si vous pouvez me dire comme
 il marche, je serais heureux d'inclure vos notes.


 22..33..66..  DDooccBBooookk :: LL''uullttiimmee gguuiiddee

 Optionnel (mais recommand�)


 Ce livre est �dit� par O'Reilly depuis Octobre 1999 et c'est une bonne
 r�f�rence pour DocBook. Je n'ai pas trouv� qu'il soit tr�s pratique,
 et la plupart des "gloires"est pour XML, mais les balises DocBook 3.1
 sont toutes list�es dans un format concit. Vous pourrez le trouver
 chez votre vendeurs favori, ou le retrouver en int�gralit� sur le site
 http://www.docbook.org <http://www.docbook.org/>.


 33..  DD��mmaarrrreerr aavveecc DDooccBBooookk

 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
 <http://www.docbook.org/> pour plus d'informations.


 33..11..  PPoouurr lleess nnoouuvveeaauuxx aauutteeuurrss

 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-
 [email protected]. 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.


 33..22..  LLeess lliisstteess ddee ddiissccuussssiioonn

 Il y a quelques listes de discussion auxquelles vous pouvez vous
 abonner pour prendre part au fonctionnement du LDP. La premi�re est
 [email protected], 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-
 [email protected] <mailto:ldp-discuss-
 [email protected]>. Pour se d�sabonner, m�me adresse avec
 "unsubscribe" dans le champ sujet du message.


 33..33..  TT��ll��cchhaarrggeerr eett iinnssttaalllleerr lleess oouuttiillss

 33..33..11..  ssggmmllttoooollss

 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:[email protected]:/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/
 <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.


 33..44..  EEccrriirree dduu SSGGMMLL �� llaa mmaaiinn

 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
 <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.


 44..  DD��mmaarrrreerr aavveecc LLiinnuuxxDDoocc

 Cette section d�crit comme �tre au point pour �crire vos propres
 documents LDP. R�cup�rer et configurer les outils, prendre contact
 avec le LDP en g�n�ral, et partager vos connaissances avec tous les
 utilisateurs de Linux.


 44..11..  PPoouurr lleess nnoouuvveeaauuxx aauutteeuurrss

 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 ldp-
 [email protected]. 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.



 44..22..  LLeess lliisstteess ddee ddiissccuussssiioonn

 Il y a quelques listes de discussion auxquelles vous pouvez vous
 abonner pour prendre part au fonctionnement du LDP. La premi�re est
 [email protected], 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-
 [email protected] <mailto:ldp-discuss-
 [email protected]>. Pour se d�sabonner, m�me adresse avec
 "unsubscribe" dans le champ sujet du message.


 44..33..  TT��ll��cchhaarrggeerr eett iinnssttaalllleerr lleess oouuttiillss

 44..33..11..  ssggmmllttoooollss

 R�cup�rez le paquetage sgmltools depuis http://www.sgmltools.org/, ou
 directement depuis votre distribution. Les fichiers de sgmltools.org
 sont le code source de l'application, vous devrez donc les compiler
 pour votre machine. Utiliser un paquetage pr�-compil� pour votre
 distribution est plus facile, puisque vous n'aurez pas � le compiler
 et �viterez les probl�mes de compilation (sauf si vous �tes un
 programmeur).


 Les outils sgmltools sont inclus dans la distribution RedHat. Si ce
 n'est pas le cas, vous pouvez le t�l�charger depuis le site ftp de
 RedHat ou un des sites miroirs.


 Si vous utilisez une Debian, sgmltools est �galement inclus en
 standard. Dans le cas contraire, vous pourrez utiliser apt-get pour
 t�l�charger et installer le paquetage � votre place :



 # apt-get install sgml-tools




 Pour plus d'informations sur le paquetage Debian, regarder � l'adresse
 http://www.debian.org/Packages/stable/text/sgml-tools.html


 Pour la compilation des sources, la marche � suivre est :



 # tar -zxvf sgmltools-x.x.x.tar.gz
 # cd sgmltools-x.x.x
 # ./configure
 # make
 # make install




 Remplacez sgmltools-x.x.x par la version du paquetage que vous
 utilisez. A la date o� j'�cris ces lignes, la version qui supporte
 LinuxDoc est la 1.0.9, et celle qui supporte DocBook est 2.0.2. Ces
 deux versions sont disponibles sur le site web d�j� vu ci-dessus.


 Une fois les outils install�s, vous avez plusieurs commandes �
 disposition.
 sgmlcheck file.sgml - V�rifie la syntaxe du document

 sgml2html file.sgml - Convertit un fichier SGML en HTML. Le fichier
 file.html contiendra la table des mati�res, les fichiers file-x.html
 contiendront les sections num�rot�es x.

 sgml2rtf file.sgml - Convertit un fichier SGML en deux fichiers Rich
 Text Format (RTF). Le fichier file.rtf contiendra la table des
 mati�res et file-0.rtf contiendra toutes les sections.


 sgml2txt file.sgml - Convertit un fichier SGML en texte ASCII. La
 table des mati�res et les sections sont toutes dans le fichier
 file.txt.


 sgml2info file.sgml - Blah SGML blah INFO, utilis� par la commande
 info. Tout est contenu dans file.info.


 sgml2latex file.sgml - Blah SGML blah TeX.


 sgml2lyx file.sgml - SGML converti pour l'�diteur graphique LyX.
 Int�ressant si vous avez g�n�r� un fichier SGML et voulez le convertir
 pour l'utiliser avec LyX.


 44..44..  EEccrriirree dduu SSGGMMLL �� llaa mmaaiinn

 Tout comme le HTML, vous pourrez �crire du SGML � la main, une fois
 que vous conna�trez toutes les balises dont vous aurez besoin. Vous
 trouverez ici une description pour la plupart des balises, avec des
 exemples d'utilisations. Le code source SGML de ce document,
 disponible sur le site web vu dans la section ``Introduction'', est un
 bon exemple pour d�marrer l'apprentissage. J'essairai de donner les
 indications sur les interpr�tations des balises dans les diff�rents
 formats de conversion.


 44..44..11..  DD��bbuutt dduu ddooccuummeenntt

 Pour commencer un nouveau document, cr�ez un nouveau fichier avec
 votre �diteur ASCII favori et commencez comme �a :



 <!doctype linuxdoc system>




 Cela pr�cise le type de document (LinuxDoc dans notre cas) que
 l'interpr�te SGML utilisera pour la conversion vers les autres
 formats. Cette balise ne g�n�re aucun texte en elle m�me.


 Ensuite vous devez entourez le reste de votre travail entre <article>
 et </article>. Cela indique le d�but du contenu (ou de l'article,
 eh?). Si vous connaissez HTML, ces balises sont �quivalentes aux
 balises <html> et </html>





 44..44..22..  LLeess iinnffoorrmmaattiioonnss ddee ll''eenntt��ttee

 La premi�re partie du document devrait inclure des informations
 g�n�rales � propos du contenu. Elle est similaire aux premi�res pages
 d'un livre qui contiennent le titre de l'ouvrage, l'auteur, la date de
 publication, la table des mati�res, etc.


 Le titre est indiqu� entre les balises <title> et </title>. De m�me on
 utilise <date> et </date> pour la date.


 Les deux sections qui restent sont les balises <abstract> et
 </abstract> qui donnent un r�sum� du document, et la balise <toc> qui
 indique l'emplacement de la table des mati�res. Celle ci est
 automatiquement g�n�r�e par l'interpr�te SGML. Nous reviendrons sur
 les sections plus tard.


 Maintenant, � quoi tout cela ressemble-t-il ? En regardant le d�but du
 code source de ce document, vous trouverez : (NdT : voir la version
 originale)



 <!doctype linuxdoc system>

 <!-- LinuxDoc file was created by LyX 1.0 (C) 1995-1999 by <markk> Tue Dec 14 16:17:42 1999
  -->

  <article>
  <title>HOWTO HOWTO
  </title>
  <author>Mark F. Komarinski &lt;[email protected]&gt;
  </author>
  <date>v1.1, 14 d�cembre 1999
  </date>
  <abstract>List the tools, procedures, and hints to get HOWTO authors up to speed
  and writing.
  </abstract>
  <toc>




 Cette partie du document est utilis�e pour cr�er la page principale
 que vous voyez une fois convertie au format RTF ou HTML.


 44..44..33..  LLeess sseeccttiioonnss

 Pour g�n�rer la table des mati�res, il vous faut de quoi la
 construire. Les sections de SGML sont ce que les chapitres sont aux
 publications traditionnelles. Il peut y avoir plusieures sections, et
 chaque section peut avoir des sous-sections, qui peuvent elles aussi
 avoir des sous-sections etc.


 D�marrer la r�daction de vos documents par les sections est une bonne
 id�e puisque cela permet de dresser la liste des sujets que vous
 voulez traiter. Vous pouvez alors subdiviser ces sections principales
 en d'autres de plus en plus petites, jusqu'� ce que vous obteniez
 l'information pure que vous pourrez �crire en quelques paragraphes.
 J'ai moi m�me commenc� ce document en utilisant cette m�thode.


 Les sections fait partie des quelques balises qui n'ont pas besoin
 d'�tre ferm�es. Ainsi, il n'y a pas de balise </sect>. Vous n'avez pas
 besoin non plus de vous occuper de la num�rotation des sections.
 L'interpr�te SGML s'en chargera lors de la g�n�ration vers d'autres
 formats.


 Les sections sont amorc�es par la balise <sect>. Chaque nouvelle
 section commence par <sect>. La premi�re est num�rot�e 1.


 Les sous-sections (comme 1.1) se cr�ent par la balise <sect1>. Elles
 commencent aussi � 1.


 Les sous-sous-sections (1.1.1) se cr�ent par la balise <sect2> et
 commencent aussi � 1.


 Quand l'interpr�te SGML arrive � la balise <toc>, il parcourt le reste
 du document et construit la table des mati�res � partir des balises
 des sections qu'il rencontre. Les sections sont num�rot�es et list�es
 dans la table des mati�res et, bien s�r, utilis�es dans le reste du
 document. Les sous-sous-sections (1.1.1) n'apparaissent pas dans la
 table des mati�res, mais sont mises en valeur dans le texte si c'est
 possible.


 44..44..44..  LLeess ppaarraaggrraapphheess

 L'�criture de paragraphes est la m�me qu'en HTML. Utilisez une balise
 <p> pour indiquer une nouvelle ligne, et commencez � �crire. SGML
 ignore les espaces tout comme les tabulations, les espaces multiples
 et les sauts de lignes. Quand SGML rencontre une balise <p>, il
 commence un nouveau paragraphe. Un document SGML correct devrait
 contenir les balises </p> pour finir les paragraphes.


 44..44..55..  TTeexxttee aavvaanncc��

 Vous aurez besoin de diff�renci� des parties de texte par rapport �
 d'autres. Soit le mettre en valeur, soit pour donner un nom de
 commande. Le premier de ces deux cas se r�sout par les balises <em> et
 </em>. Quant au style machine � �crire, on utilise les balises <tt> et
 </tt>.


 44..44..66..  LLeess lliisstteess

 Il existe deux types de listes sous SGML. La premi�re est la liste
 num�rot�e, o� chaque item de la liste est num�rot� (comme les
 sections), en commen�ant � 1.



 1. Voici la premi�re entr�e de la liste num�rot�e.

 2. Voici la seconde.

 3. Et la troisi�me.


 Le code pour cette liste est le suivant :



 <enum>
  <item>Voici la premi�re entr�e de la liste num�rot�e.
  <item>Voici la seconde.
  <item>Et la troisi�me.
 </enum>




 La balise <enum> indique que les entr�es qui la suivent doivent �tre
 num�rot�es.


 L'autre type de liste est la liste � items simple, o� chaque entr�e �
 une �toile, un cercle, ou un point, ou tout autre symbole pour
 indiquer chaque item.



 �  Voici la premi�re entr�e de la liste � items.

 �  Voici la seconde.

 �  Et la troisi�me.


 Le code de la liste ressemble � �a en SGML :



 <itemize>
  <item>Voici la premi�re entr�e de la liste � items.
  <item>Voici la seconde.
  <item>Et la troisi�me.
 </itemize>




 Comme vous le voyez, la balise <item> est la m�me pour les listes
 num�rot�es et les listes � items.


 Une troisi�me forme de liste est la liste de d�finition. Elle comporte
 un terme � d�finir, et la phrase de d�finition.



    LLDDPP
       Le Projet de Documentation Linux

    SSGGMMLL
       Standard Generalized Markup Language


 Le code qui permet de cr�er cette liste est :


 <descript>
  <tag>LDP</tag>Le Projet de Documentation Linux
  <tag>SGML</tag>Standart Generalized Markup Language
 </descript>




 Ce n'est pas tout � fait la m�me syntaxe que pour les listes � items
 et num�rot�es, mais la liste est aussi entour�e par des balises
 (<descrip> et </descrip>) et chaque item qui est un mot � d�finir est
 entour� par <tag> et </tag>. Le reste de la ligne est alors consid�r�
 comme la d�finition de ce dernier.


 44..44..77..  TTeexxttee vveerrbbaattiimm

 De temps en temps, on a besoin d'afficher du texte comme on l'�crit.
 Pour cela, vous pouvez utiliser les balises <verb> et </verb> pour
 entourer du texte qui doit appara�tre tel quel. Les espaces, les
 retours � la ligne, et tout autre caract�re sp�cial sont pr�serv�s
 jusqu`� la balise </verb>.



 Ceci est du texte verbatim.

 Et voici un autre texte verbatim.




 44..44..88..  LLeess UURRLL

 SGML fournit de quoi utiliser des URL (Universal Resource Locators ,
 NdT: sortes de pointeurs vers des ressources ext�rieures) de tous
 types. Cela ne sera utilis� que par les versions HTML, mais d'autres
 formats pourrait �galement y avoir recours.  La meilleure utilisation
 en sera faite pas HTML, mais d'autres formats, tels que PDF, pourront
 aussi en tirer avantages.


 Les URL n'ont pas de balise de terminaison, mais toutes les
 informations sont contenues dans la balise <url> elle-m�me. Voici un
 URL qui pointe vers la page du LDP : http://www.linuxdoc.org/. Et
 voici le code pour le cr�er :



 <url url="http://www.linuxdoc.org/"
 name="http://www.linuxdoc.org/">




 La partie url="http://www.linuxdoc.org/" donne la destination du
 pointeur, et la partie name="http://www.linuxdoc.org/" indique au
 navigateur ce qu'il doit afficher en r�alit�. Dans ce cas, les deux
 parties sont identiques, mais on pourrait cr�er une balise url qui
 ressemblerai � �a :



 <url url="http://www.linuxdoc.org/"
 name="LDP">




 Ce qui affichera ceci dans le texte : LDP. Toutefois, un bon principe
 consiste � dupliquer l'URL dans la partie name. La raison est que si
 vous utilisez un format du type texte ou RTF, ces balises n'auront pas
 de significations. Le lecteur ne conna�tra pas l'URL � utiliser.

 44..44..99..  LLeess rr��ff��rreenncceess

 Alors que les URL sont adapt�s pour faire r�f�rence aux ressources
 externes � votre document, ce n'est pas le cas pour les r�f�rences au
 sein du texte lui-m�me. Pour cela, les balises <label> et <ref> sont
 pr�f�rables. La balise <label> indique un endroit dans le document
 auquel vous voudrez faire r�f�rence ailleurs dans le texte, comme un
 signet. La cr�ation du <label> est simple. Ins�rez la ligne suivante �
 l'endroit voulu :



 <label> id="introduction">




 Vous avez alors cr�� un point dans le texte auquel vous pourrez vous
 r�f�rer en tant que "introduction". En effet, cette balise est
 utilis�e dans le document SGML que vous lisez. Quand vous voulez
 pointer vers cet endroit (comme ``ici''), vous ins�rez le code SGML
 suivant :



 <ref id="introduction" name="ici">




 et SGML ins�rera le mot "ici" dans le texte qui sera un lien vers la
 section indiqu�e par le label "introduction".


 L'autre utilisation des r�f�rences est l'indexation. Puisque les
 documents du LDP sont souvent publi�s sur papier sous forme d'un grand
 nombre de documents, les r�f�rences servent � g�n�rer un index qui
 appara�tra � la fin du livre, bas� sur les mots et les sujets.


 44..44..1100..  LLeess ccaarraacctt��rreess sspp��cciiaauuxx

 Tout comme pour HTML, vous devrez interdire l'interpr�tation de
 certains caract�res non alphanum�riques pour �viter que SGML les voit
 comme du code. Voici une liste des codes utilis�s. Vous en trouverez
 d'avantage dans le Guide de l'utilisateur de sgmltools � l'adresse
 http://www.sgmltools.org/guide/guide.html



 �  Utilisez &amp; pour le et commercial

 �  Utilisez &lt; pour le caract�re inf�rieur � (<)

 �  Utilisez &gt; pour le caract�re sup�rieur � (>)

 �  Utilisez &etago; pour un inf�rieur � suivi d'une barre oblique (</)

 �  Utilisez &dollar; pour le signe dollar ($)

 �  Utilisez &num; pour un di�se (#)

 �  Utilisez &percnt; pour le pourcent (%)

 �  Utilisez &tilde; pour un tilde (~)

 �  Utilisez " et " pour les apostrophes, ou utilisez &dquot; pour "

 �  Utilisez &shy; pour un trait d'union (c'est � dire une indication
    o� le mot peut �tre coup� pour la justification)


 44..55..  EEccrriirree dduu SSGGMMLL aavveecc dd''aauuttrreess oouuttiillss

 44..55..11..  LLyyXX

 Je vais encore chanter les louanges pour LyX. Je favorise cette
 application car je l'appr�cie vraiment. Il donne la possibilit�
 d'�crire en SGML avec la facilit� d'un traitement de texte standard.
 Ce n'est pas un programme WYSIWYG, mais plut�t une application WYSIWYM
 (What You See Is What You Mean, NdT: Ce que vous voyez est ce que vous
 pensez), puisque ce que vous voyez n'est pas forcement ce que vous
 obtiendrez une fois que l'interpr�teur SGML aura fait son travail.


 Pour cr�er un document LinuxDoc avec LyX, t�l�chargez et installez
 l'application. Assurez-vous d'avoir d�j� install� TeX et sgmltools
 (voir ``T�l�charger et installer les outils'' pour plus d'informations
 � ce propos). Ensuite, lancez LyX et s�lectionnez "file->new from
 template...". Cliquez sur "Templates" et s�lectionnez
 linuxdoctemplate.lyx et vous obtiendrez un document de base, avec tous
 les en-t�tes d'information qu'un document du LDP se doit d'avoir.
 Modifiez les donn�es selon vos besoins (c'est � dire compl�ter les
 champs Titre, Auteur, Date, Abstract, etc.) en commencez la r�daction
 de votre document. Le menu dans le coin en haut � gauche vous permet
 de s�lectionner le type du texte (standard, liste �num�r�es ou �
 items, sections). Le point d'exclamation est utilis� pour mettre le
 texte en valeur, et vous pouvez soit cliquer dessus et commencer �
 taper le texte, soit s�lectionner du texte et cliquer dessus pour
 mettre en valeur du texte d�j� �crit. D'autres sp�cificit�s de SGML
 peuvent �tre trouv�es dans le menu Insertion. Vous pouvez ins�rer des
 URL, des r�f�rences, des entr�es d'index, et d'autres types de
 donn�es. Une fois votre document termin�, vous pouvez le sauvegarder
 au format LyX, et l'exporter au format LinuxDoc et obtenir ainsi un
 fichier avec l'extension .sgml. sgmlcheck peut alors v�rifier ce
 fichier, qui est pr�t � �tre converti vers d'autres formats.


 44..55..22..  EEmmaaccss

 Emacs dispose d'un mode sp�cial pour �crire en SGML appel� psgml. Ceux
 qui ont une exp�rience de ce mode sont invit�s � donner des
 informations � l'auteur par courrier �lectronique. psgml est un module
 majeure pour Emacs con�u pour �diter des documents SGML et XML. Il
 permet une coloration syntaxique et un joli affichage qui font
 ressortir les balises SGML, il fournit une m�thode d�nsertion des
 balises sans 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. Je pense qu'il permet une plus grande
 versatilit� que tout autre �diteur de code SGML. Il fonctionne aussi
 bien avec DocBook, LinuxDoc et d'autres DTD. La documentation psgml
 est disponible � http://www.lysator.liu.se/~lenst/about_psgml/
 <http://www.lysator.liu.se/~lenst/about_psgml/>.


 44..55..33..  LLeess aauuttrreess oouuttiillss SSGGMMLL

 S'il y a d'autres outils permettant d'utiliser la DTD LinuxDoc pour
 g�n�rer des documents du LDP, faites le moi savoir.



 44..66..  LLeess bbaasseess ddee CCVVSS

 Le LDP est en train de mettre un place un acc�s CVS pour les auteurs.
 Il y a, en effet, de bonnes raisons d'utiliser CVS :



 1. CVS g�re une sauvegarde des documents. Si vous passer un document �
    un autre auteur, il peut r�cup�rer le document depuis CVS et
    continuer � travailler dessus. Si vous avez besoin de revenir sur
    une ancienne version, vous pouvez aussi la r�cup�rer.


 2. C'est formidable si plusieurs auteurs travaillent sur le m�me
    document. Vous pouvez demander � CVS de vous indiquez qu'elles
    modifications ont �t�es faites pendant que vous travailliez sur le
    document, et directement int�grer ces changements.

 3. CVS garde un rapport des modifications du document. Ce rapport peut
    �tre plac� automatiquement dans le fichier si vous utilisez
    certaines balises qui seront analys�es avant l'interpr�teur SGML.

 4. Il peut servir, gr�ce � un programme, � mettre � jour le site web
    du LDP automatiquement, d�s qu'un document a �t� termin� et re�u.
    Ce n'est pas encore en place, mais �a ne va pas tarder.


 Si CVS est quelque chose de nouveau pour vous, voici quelques pages
 web qui pourront vous aider :



 1. http://www.sourcegear.com/CVS/Docs/blandy
    <http://www.sourcegear.com/CVS/Docs/blandy>

 2. https://wroclaw.art.pl/~ser/docs/cvs.html
    <https://wroclaw.art.pl/~ser/docs/cvs.html>


 44..77..  OObbtteenniirr uunn ccoommppttee CCVVSS

 D'abord, il vous faudra obtenir un compte dans le repository CVS du
 LDP (NdT: lieu de stockage et de d�p�t des documents pour CVS).  C'est
 souvent le r�pertoire racine qui est utilis� par CVS, o� chaque projet
 (HOWTO, Mini-HOWTO, ...) dispose d'un sous-r�pertoire.


 Vous devrez cr�er un mot de passe crypt� et un identifiant
 d'utilisateur pour votre compte. Ce mot de passe vous permet d'envoyer
 un mot de passe crypt� au groupe CVS sans qu'ils aient besoin de
 conna�tre votre mot de passe. Vous pouvez le faire par les commandes
 suivantes, depuis un shell bash (ou sh) :



 $ echo votre_mot_de_passe | perl -e "print crypt(<>, join




 (NdT: je conseille un

 ; echo



 depuis un shell et que la r�ponse ne semble pas s'afficher)


 Envoyez la sortie de cette commande avec l'identifiant d'utilisateur �
 [email protected] <mailto:[email protected]>.
 Votre CVSROOT unique sera cr�er et vous recevrez un e-mail avec la
 r�ponse.


 Quand vous obtiendrez la r�ponse, connectez vous sur votre CVSROOT et
 v�rifiez que tout est configur� correctement :



 $ export CVSROOT=:pserver:[email protected]:/cvsroot
 $ cvs -d $CVSROOT login




 (Remplacez CVSROOT par ce qui vous a �t� indiqu� dans la r�ponse.)


 On vous demandera votre mot de passe, et vous aurez acc�s au
 repository CVS en mode lecture-�criture. Une fois que vous aurez
 utilis� login et obtenu acc�s au syst�me, votre mot de passe est
 stock� dans .cvsroot et vous n'aurez plus besoin d'utiliser cvs login.
 Positionner CVSROOT correctement et c'est parti.


 Vous pouvez obtenir le repository linuxdoc en entier avec cette
 commande :


 $cvs get linuxdoc




 Ou vous pouvez obtenir le fichier source SGML de votre propre document
 par :


 $ cvs get linuxdoc/src/VOTRE-HOWTO.sgml
 $ cvs get linuxdoc/minisrc/VOTREDOC.sgml




 Une liste des changements est �galement disponible. C'est un e-mail
 envoy� � chaque changement dans le repository. Remarquez que cel� peut
 devenir une liste � tr�s grand d�bit. Vous pouvez vous y abonner en
 envoyant un e-mail vide � [email protected]. Vous
 pouvez annuler votre abonnement en envoyant un e-mail vide � commits-
 [email protected] .


 44..88..  AAuuttrreess iinnffoorrmmaattiioonnss ssuurr CCVVSS

 44..88..11..  AAcccc��ss CCVVSS aannoonnyymmee

 L'acc�s CVS anonyme (en lecture seule) est disponible par :




 $ cvs -d :pserver:[email protected]:/cvsroot login




 Utilisez "cvs" comme mot de passe. Vous pouvez alors acc�der aux
 modules linuxdoc comme d�crit ci-dessus. Notez que les changement
 apparaissent sur le site cvs anonyme environ une demi-heure apr�s le
 site principal.


 44..88..22..  FFiicchhiieerrss CCVVSS vviiaa llee wweebb

 Vous pouvez acc�der au repository CVS par le web � l'adresse
 http://cvsweb.linuxdoc.org/index.cgi/linuxdoc
 <http://cvsweb.linuxdoc.org/index.cgi/linuxdoc>.


 44..88..33..  AAcccc��ss ggrraapphhiiqquuee �� CCVVSS

 Il existe des interfaces graphiques pour CVS, et vous en trouverz une
 liste sur le site http://freshmeat.net/appindex/
 <http://freshmeat.net/appindex/>. Cherchez CVS.


 44..99..  CCVVSS eett llaa mmiissee �� jjoouurr ddeess ffiicchhiieerrss

 CVS reconnait une balise sp�ciale que vous pouvez utiliser pour
 ins�rer la date et la version automatiquement dans votre document.
 C'est la balise $Id$. En mettant cette balise dans la section <date>
 (par exemple), elle sera modifi�e � chaque changement du document,
 permettant une incr�mentation automatique de la version.


 Quand vous voulez copier votre fichier modifi� sur le serveur CVS,
 utilisez la commande cvs ci -m "commentaires" YOUR-HOWTO.sgml. Le
 param�tre -m "commentaires" n'est pas obligatoire, mais si vous ne le
 mettez pas, vous serez ammen� dans votre �diteur (certainement vi, ou
 l'�diteur indiqu� par la variable d'environnement EDITOR) et devrez
 taper un commentaire � propos des changements. Si vous d�cidez
 d'utiliser un �diteur plut�t que de sp�cifier le commentaire sur la
 ligne de commande, il se peut qu'il faille quelques (plus de 5)
 secondes pour finir ce qu'il y avait � faire et effectuer la mise �
 jour.


 Vous pouvez suivre toutes les discussions � propos de CVS sur la liste
 ldp-discuss. Pour l'instant, les soumissions LDP doivent toujours �tre
 envoy�es � ldp-submit.


 55..  DDiissttrriibbuueerr vvoottrree ddooccuummeennttaattiioonn

 55..11..  AAvvaanntt llaa ddiissttrriibbuuttiioonn

 Avant de distribuer votre prose � des millions de lecteurs potentiels,
 il y a quelques petites choses � faire.


 D'abord, v�rifiez le bon fran�ais de votre texte. La plupart des
 outils que vous utiliserez pour �crire en SGML (Emacs, LyX, et les
 autres �diteurs de texte) disposent de modules de v�rification de
 l'orthographe. Si ce n'est pas le cas, il y a toujours ISPELL,
 disponible dans toutes les distributions. Utilisez aussi sgmlchek pour
 v�rifier la coh�rence de vos balises SGML.

 Deuxi�mement, faites relire votre document par quelqu'un d'autre que
 vous pour obtenir des commentaires et d'�ventuelles corrections. La
 documentation publi�e par le LDP a besoin d'�tre la plus correcte
 possible, car des millions d'utilisateurs de Linux peuvent avoir
 besoin de la lire. Si vous faites partie d'une liste de discussion
 parlant du sujet trait�, demandez aux autres intervenants de vous
 aider.


 Troisi�mement, cr�ez un site web o� vous pourrez distribuer vos
 r�alisations. Ce n'est pas indispensable, mais tr�s utile pour
 retrouver la source originale du document.


 55..22..  NNoottiioonnss ddee ccooppyyrriigghhtt eett ddee lliicceennccee

 Pour qu'un document soit accept� par le LDP, il doit utilis� une
 licence qui en autorise une distribution et une publication libre. En
 tant qu'auteur, vous pourrez conserver le copyright et ajouter
 d'autres restrictions (par exemple, vous devez approuver toutes
 traductions ou travaux d�riv�s). Une version simple d'une licence est
 disponible � l'adresse http://www.linuxdoc.org/COPYRIGHT.html. Si vous
 choisissez d'utiliser ce copyright, placez le dans votre code source
 dans une section intitul�e "Copyright et licence" o� quelque chose
 dans ce genre. Incluez �galement une clause de propri�t� (puisque vous
 en serez le propri�taire). Si vous �tes un nouveau responsable d'un
 HOWTO qui existait d�j�, vous devez inclure les clauses de copyright
 de(s) l'ancien(s) auteur(s) et la p�riode o� ils ont maintenu le
 document, � moins qu'ils aient distribu� leur document dans le Domaine
 Publique quand ils en ont arr�t� la maintenance.


 55..33..  UUnnee ffooiiss qquuee vvoottrree ddooccuummeenntt aa ��tt�� rreelluu eett qquuee vvoouuss aavveezz pprriiss eenn
 ccoommppttee lleess ccoommmmeennttaaiirreess ddeess rreelleecctteeuurrss,, vvoouuss ppoouuvveezz ssoouummeettttrree vvoottrree
 tteexxttee aauu LLDDPP.. EEnnvvooyyeezz uunn ee--mmaaiill ��llddpp--ssuubbmmiitt@@lliissttss..lliinnuuxxddoocc..oorrgg..
 IInnddiiqquueezz llee nnoomm dduu HHOOWWTTOO ddaannss llee ssuujjeett dduu mmaaiill,, eett dd��ccrriivveezz lleess
 cchhaannggeemmeennttss qquuee vvoouuss aavveezz ffaaiitt ((rr����ccrriittuurree mmaajjeeuurree oouu ccoorrrreeccttiioonnss ddee
 ffaauutteess dd''oorrtthhooggrraapphhee ......)) ddaannss llee ccoorrppss dduu mmeessssaaggee,, eenn yy jjooiiggnnaanntt
 vvoottrree ddooccuummeenntt.. CCeell�� ppeerrmmeett aauuxx mmaaiinntteenneeuurrss ddee ffaaiirree lleeuurr ttrraavvaaiill pplluuss
 rraappiiddeemmeenntt,, eett ddee nnee ppaass aavvooiirr �� ttrroopp aatttteennddrree aavvaanntt qquuee vvoottrree HHOOWWTTOO
 nnee ssooiitt ddiissppoonniibbllee ssuurr llee ssiittee wweebb dduu LLDDPP..  SSii vvoouuss nn''aavveezz ppaass ddee
 rr��ppoonnssee ddaannss lleess 77 jjoouurrss ssuuiivvaanntt,, rreennvvooyyeezz uunn mmaaiill ppoouurr ssaavvooiirr ssii
 vvoottrree HHOOWWTTOO �� bbiieenn ��tt�� ttrraaiitt��..  SSoouummiissssiioonn aauu LLDDPP

 66..  CCoonnsseeiillss ddee ssttyyllee

 Ceci n'est pas un guide complet sur comment �crire une bonne
 documentation (pour l'instant), mais consid�rez le comme une liste
 rapide de conseils pour vous aider tout au long de la r�daction.



 �  Etre clair. Tout le monde doit comprendre de quoi vous parl�.

 �  Utiliser des exemples quand c'est possible. Cela aide � comprendre
    de quoi vous parl�.

 �  Etre organis�. Ne pas sauter � des sujets sans lien dans une m�me
    section.


 Vous pourrez obtenir beaucoup d'autres conseils sur le style du LDP �
 l'adresse http://www.linuxdoc.org/HOWTO/LDP-Style-Guide.html.



 77..  FFAAQQ �� pprrooppooss dduu LLDDPP

 77..11..  JJee dd��ssiirree aaiiddeerr llee LLDDPP.. CCoommmmeenntt ppuuiiss--jjee llee ffaaiirree ??

 La fa�on la plus simple, c'est de trouver un sujet et d'en faire un
 document. Regardez �galement la liste des HOWTO non maintenus et voyez
 s'il n'y en a pas un que vous pourriez continuer.


 77..22..  lliivvrree.. CCoommmmeenntt eesstt pprroott��gg�� llee ccoonntteennuu dduu LLDDPP ??  JJee vvoouuddrraaiiss ppuubb��
 lliieerr uunn eennsseemmbbllee ddee ddooccuummeennttss dduu LLDDPP ddaannss uunn

 R�f�rez vous � la page http://www.linuxdoc.org/COPYRIGHT.html.


 77..33..  ccoorrrriiggeerr ??  JJ''aaii ttrroouuvv�� uunnee eerrrreeuurr ddaannss uunn ddooccuummeenntt dduu LLDDPP..
 PPuuiiss--jjee llee

 Contactez l'auteur du document, o� le coordinateur et informez le du
 probl�me en lui donnant une �ventuelle correction.