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

2.1. Le LDP

Le Projet de Documentation de Linux (LDP) a �t� cr�� pour fournir aux nouveaux utilisateurs un moyen d'obtenir rapidement des informations sur un sujet particulier. Il contient non seulement une liste 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 particuliers, �crits par ceux qui les ont utilis�s. Si vous cherchez des informations sur les impressions, vous trouverez le Printing-HOWTO. Si vous d�sirez savoir si votre carte Ethernet fonctionne sous Linux, 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 permettrait 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�r�e �tre SGML.

2.2. SGML

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 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. Au lieu de cela, 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 de tout le reste. HTML fait la m�me chose, puisqu'il est en fait une subdivision de SGML. SGML est en r�alit� constitu� de trois parties. La premi�re est la Structure, qui est appel�e la DTD, ou encore D�finition du Type du Document. La DTD d�finit les relations entre chacun des �l�ments d'un texte. La DTD DocBook, utilis�e pour cr�er le pr�sent document, en est un exemple. La DTD liste les r�gles que le contenu doit respecter. La seconde partie est DSSSL ou encore "Document Style Semantics and Specification Language" (NdT�: S�mantique de Pr�sentation de Documents et Langage de Sp�cifications). DSSSL indique au programme charg� du rendu final comment convertir le code SGML en quelque chose de lisible par Monsieur-tout-le-monde. Il demande par exemple, de convertir une balise <table> en une fonte grasse 14 points si le format de destination est RTF, ou en une balise <h1> si on veut du HTML. Enfin, la troisi�me partie est le Contenu, qui est trait� par l'interpr�teur SGML et qui est finalement visualis� par l'utilisateur. Le pr�sent 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.

2.3. Pourquoi SGML plut�t que HTML ou d'autres formats�?

SGML permet plus qu'une simple mise en forme. Vous pouvez cr�er automatiquement des index, des tables des mati�res ou des liens internes ou externes. Les paquetages Jade et OpenJade vous permettent aussi d'exporter (j'appellerai cela g�n�rer � partir de maintenant) vos documents SGML vers LaTeX, info, du texte, HTML ou RTF. Vous pouvez alors cr�er, � partir de ces formats de base, des fichiers d'autres types comme MS Word, PostScript, PDF, etc. Des programmes comme LyX 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 r�le des �l�ments dans le document plut�t qu'� leur apparence. Une diff�rence de taille, en tout cas qui vous permettra d'�crire plus vite, puisque vous n'avez plus � vous soucier de la justification des paragraphes, des types et tailles des polices, etc.

2.4. 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 <ldp-submit@lists.linuxdoc.org>. Cela lui permet de savoir qui travaille sur quel document.

Une fois cela effectu�, vous pouvez �crire votre documentation dans le format que vous voulez et soumettre un brouillon � <ldp-submit@lists.linuxdoc.org> pour qu'il soit relu par un volontaire du LDP. Quelques jours plus tard vous recevrez les corrections et commentaires du relecteur. Apr�s avoir appliqu� les modifications sugg�r�es, vous pouvez envoyer cette version � la liste ldp-submit une nouvelle fois pour la soumission finale au LDP.

A partir de l�, un autre volontaire du LDP traduira votre document en DocBook et vous renverra cette version finale. Maintenant, toutes les soumissions au LDP doivent �tre au format DocBook. Si vous avez des questions sur les balises, vous pouvez toujours demander aux volontaires qui vous ont aid�, ou directement � la liste DocBook du LDP.

2.5. 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" comme sujet � l'adresse <ldp-discuss-request@lists.linuxdoc.org>. Pour se d�sabonner, m�me adresse avec "unsubscribe" comme sujet du message.

Une autre liste est la liste <ldp-docbook@lists.linuxdoc.org>, qui est pr�vue pour les questions sur DocBook. Si vous rencontrez des probl�mes avec une balise particuli�re, vous pouvez y envoyer une question. Vous pouvez vous abonner � la liste DocBook en envoyant un message "subscribe" � <ldp-docbook-request@lists.linuxdoc.org>.