Ce document est écrit en utilisant la DTD Linuxdoc-SGML. Il contient plus ou moins tout ce que vous avez besoin de savoir pour écrire des documents SGML avec cette DTD. Voir example.sgml pour un exemple d'un document SGML que vous pouvez utiliser comme un modèle pour vos propres documents.

J'ai choisi SGML pour ce système parce que SGML est spécifiquement fait pour la traduction vers d'autres formats. SGML, qui signifie Standard Generalized Markup Language, vous permet de spécifier la structure d'un document---qui est, quelles sortes de choses constituent le document. Vous spécifiez la structure d'un document avec une DTD (Document Type Definition). Linuxdoc-SGML est une DTD qui spécifie la structure pour les HOWTO Linux et d'autres types de documents. QWERTZ est une autre DTD; le standard SGML fournit des DTD pour des livres, des articles et d'autres types génériques de documents.

La DTD spécifie les noms des ``éléments'' à l'intérieur du document. Un élément est juste un morceau de structure--- comme une section, une sous-section, un paragraphe, ou même quelque chose de plus petit comme du texte en italique. Contrairement à LaTeX, cependant, ces éléments ne sont en aucune façon intrinsèques à SGML lui-même. Il se trouve que La DTD Linuxdoc-SGML définit des éléments qui ressemblent beaucoup à leurs pendants en LaTeX---vous avez des sections, sous-sections, ``environnements'' verbatim, et ainsi de suite. Cependant, en utilisant SGML, vous pouvez définir n'importe quelle sorte de structure pour le document que vous voulez. A certains égards, SGML est comme TeX, tandis que la DTD Linuxdoc-SGML est comme LaTeX.

Ne soyez pas troublé par cette analogie, SGML n'est pas un système de formatage de texte. Il n'y a pas de ``formateur SGML''. Le source SGML est seulement convertit vers d'autres formats. De plus, SGML lui-même est utilisé seulement pour spécifier la structure du document. Il n'y a pas de facilités de formatage de texte ou de ``macros'' intrinsèques à SGML. Toutes ces choses sont définies dans la DTD. Vous ne pouvez utiliser SGML sans une DTD---une DTD définit ce que SGML fait.

Voici comment le traitement d'un document avec SGML et une DTD Linuxdoc-SGML marche. D'abord, il vous faut une DTD. J'utilise la DTD QWERTZ qui à été produite, à l'origine, par un groupe de personne qui avaient besoin d'une DTD qui ressemblait à LATEX. J'ai modifié la DTD QWERTZ pour produire la DTD Linuxdoc-SGML adaptée à nos besoins. La DTD installe simplement la structure du document. Une petite portion de celui-ci ressemble a ceci: <!element article - - (titlepag, header?, toc?, lof?, lot?, p*, sect*, (appendix, sect+)?, biblio?) +(footnote)>

Cette partie installe la structure générale d'un "article", qui est comme un ``ocumentstyle'' dans LATEX. L'article est constitué d'un titre (titlepag), d'un en-tête optionnel (header), une table des matières optionnelle (toc), des listes de figures (lof) et de tables (lot) optionnelles, un nombre quelconque de paragraphes (p), un nombre quelconque de sections (sect), des appendices optionnels (appendix), une bibliographie optionnelle (biblio), et des notes de bas de page (footnote).

Comme vous pouvez le voir, la DTD ne dit pas comment le document doit être formaté ni à quoi il doit ressembler. Elle définit juste les parties qui constituent le document. Autre part dans la DTD les structures de titlepag, header, sect, et d'autres éléments sont définies.

Vous n'avez pas besoin de savoir quoi que ce soit à propos de la syntaxe de la DTD pour écrire des documents. Je suis juste en train de vous la présenter afin que vous sachiez à quoi cela ressemble et ce que cela fait. Vous avez besoin de vous familiariser avec la structure du document que la DTD définit. Sinon, vous pourriez violer la structure en essayant d'écrire un document, et être très perplexe devant les messages d'erreur qui en resulteraient. Nous décrirons la structure de documents Linuxdoc-SGML en detail plus tard.

L'étape suivante est d'écrire un document en utilisant la structure définie par la DTD. A nouveau, la DTD Linuxdoc-SGML fait beaucoup ressembler les documents à LATEX---c'est tres simple a suivre. Dans le jargon SGML un simple document écrit en utilisant une DTD particulière est connu comme une ``instance'' de cette DTD.

Afin de traduire le source SGML dans un autre format (comme LaTeX ou groff) pour le traitement, le source SGML (le document que vous avez écrit) est analysé avec la DTD par (vous avez deviné) l'analyseur SGML. J'utilise l'analyseur sgmls de James Clark, jjc@jclark.com, qui est aussi l'auteur de groff. Nous sommes entre de bonnes mains. L'analyseur (sgmls) parcourt simplement votre document et vérifie qu'il suit la structure mise en avant par la DTD. Il sort aussi une forme plus explicite de votre document, avec toutes les ``macros'' substituées, ce qui est compris par sgmlsasp, l'étape suivante du processus.

sgmlsasp est responsable de la convertion de la sortie de sgmls en un autre format (comme LaTeX). Il le fait en utilisant des fichiers de remplacement, qui décrivent comment convertir des éléments du document SGML original dans le source correspondant du format ``cible'' (comme LaTeX ou groff).

Par exemple, une partie des fichiers de remplacement pour LaTeX ressemblent à: <itemize> + "\\begin{itemize} + </itemize> + "\\end{itemize} + Ce qui dit que chaque fois que vous commencez un élément itemize dans le source SGML, il devrait être remplacé par: \begin{itemize} dans le source LaTeX. (Comme je l'ai dit, les éléments dans la DTD Linuxdoc-SGML ressemblent beaucoup à leurs contreparties LaTeX).

Donc, pour convertir du SGML dans un autre format, tout ce que vous avez à faire est d'écrire un nouveau fichier de remplacement pour ce format qui donne les analogies apropriees aux éléments SGML dans le nouveau format. En pratique, ce n'est pas aussi simple---par exemple, si vous essayez de convertir en un format qui n'est pas du tout structuré comme votre DTD, vous allez avoir des problèmes. Dans tous les cas, c'est beaucoup plus simple à faire qu'écrire des analyseurs individuels et des traducteurs pour beaucoup de types de format de sortie; SGML offre un système généralisé pour convertir un source dans beaucoup de formats.

Une fois que sgmlsasp a terminé son travail, vous avez un source LaTeX qui correspond à votre document SGML original, que vous pouvez formater en utilisant LaTeX comme vous le feriez normalement. Plus tard dans ce document je vous donnerai des exemples et je vous montrerai les commandes utilisées pour faire la traduction et le formatage. Vous pouvez faire tout ceci sur une ligne de commande.

Mais d'abord, je dois décrire comment installer et configurer le logiciel.

Les étapes nécessaires pour installer et configurer Linuxdoc-SGML sont les suivantes: récupérez le fichier linuxdoc-sgml-1.5.tar.gz, décompressez-le et désarchivez-le quelque part. Cela créera le répertoire linuxdoc-sgml-1.5 où se trouveront tous les fichiers SGML. allez dans le répertoire linuxdoc-sgml-1.4, et lisez le fichier INSTALL. Vous y trouverez les instructions détaillées d'installation.

Si tout se passe bien, vous êtes alors prêt à utiliser le système.

Nous supposons que vous disposez d'un document SGML foo.sgml que vous voulez formatter. Voici une vue d'ensemble du formatage du document pour différentes sorties. Pour une liste complète des options, consultez les pages de manuel.

L'ensemble de caractères ISO 8859-1 (latin1) peut être utilisé pour des caractères internationaux (par exemple les accents français) en sortie pur texte, LaTeX, HTML, LyX et RTF (le support ISO 8859-1 texinfo peut être possible dans le futur). Pour utiliser cette caractéristique utilisez l'option -l avec les scripts SGML, par exemple: % sgml2txt -l foo.sgml

Vous pouvez aussi utiliser les caractères ISO 8859-1 dans le fichier source SGML, ils seront automatiquement traduits vers les codes d'échappements corrects pour le format de sortie correspondant.

A la lecture du source du document exemple, vous noterez qu'il existe un certain nombre de commandes qui sont inclus entre les caractères < et >. Une commande (ou tag) spécifie le début ou la fin d'un élément. Un élément étant quelque chose comme une section, un paragraphe, un texte en italique, un item dans une liste, etc. Utiliser un tag est comme utiliser une commande LaTeX telle que \item ou \section{...}.

Par exemple, pour produire du texte en gras, j'ai tapé Par exemple, pour produire du <bf>texte en gras</bf>, ... dans le source, <bf> commence la région de texte en gras, et </bf> la termine. Alternativement, vous pouvez utiliser la forme abrégée Par exemple, pour produire du <bf/texte en gras/>, ... laquelle enferme le texte en gras à l'intérieur de slashes. (Bien sur, vous aurez besoin d'utiliser la forme longue si le texte contient des slashes, tel que dans le cas des noms de fichiers Unix).

There are other things to watch out with respect to special characters (that's why you'll notice all of these bizarre-looking ampersand expressions if you look at the source; I'll talk about those shortly).

Dans certains cas le tag final pour un élément particulier est optionnel. Par exemple, pour débuter une section on utilise le tag <sect>, le tag final est optionnel et implicite au moment où vous débuter une nouvelle section de même profondeur. En général vous n'avez pas besoin de vous préoccupez de ces détails; suivez juste le modèle utilisé dans le tutorial (example.sgml).

Evidemment les caractères < et > sont eux-mêmes des caractères spéciaux dans le source SGML. Il y en a d'autres auxquels il faut faire attention. Par exemple, supposons que vous vouliez taper une expression avec les crochets angulaires (< et >) qui l'entourent, tel que: <foo>. Pour obtenir le caractère <, vous devez utiliser l'élément &lt;, qui est une ``macro'' qui développe le caractère <. Par conséquent, dans le source, j'ai tapé qui l'entourent, tel que: <foo>. Généralement, quelque chose commençant avec un ``et commercial`` (&) est une macro spéciale. Par exemple, il y a &percnt; pour produire %, &verbar; pour produire |, etc. Pour tous les ``caractères spéciaux`` il existe des entités pour les représenter.

Usuellement, vous n'avez pas besoin d'utiliser ces macros pour avoir un caractère spécial, cependant, en quelques cas c'est nécessaire. Les macros les plus communéments utilisées sont: Utilisez &amp; pour le ``et commercial`` (&), Utilisez &lt; pour <, Utilisez &gt; pour >, Utilisez &etago; pour </, Utilisez &dollar; pour le signe dollar ($), Utilisez &num; pour un dièse (#), Utilisez &percnt; pour un pourcent (%), Utilisez &tilde; pour un tilde (˜), Utilisez `` and '' pour les quotes, ou utilisez &dquot pour ".

Pour une liste complète des caractères spéciaux, regardez un des fichiers de remplacements. Usuellement LaTeX se plaint le plus au sujet des caractères spéciaux, donc jeter un coup d'oeil au fichier $LINUXDOCLIB/rep/latex/general serait une bonne idée pour commencer. $LINUXDOCLIB est défini au début des scripts de conversion SGML.

Il existent également des entités pour obtenir les accents de la langue française (voir par exemple le fichier /usr/local/lib/linuxdoc-sgml/rep/latin1/general.

Pendant que nous sommes sur le sujet des caractères spéciaux, je fais mention des ``environnements'' verbatim utilisés pour inclure du texte littéral en sortie (c'est à dire avec les espaces et indentations préservées, etc), L'élément verb est utilisé pour cela. Par exemple: <verb> Du texte litteral inclus comme exemple de sortie. </verb> L'environnement verb ne vous permet pas d'utiliser n'importe quoi à l'intérieur de l'environnement. Spécifiquement, vous devez suivre les indications suivantes dans les environnements verb: Utilisez &ero; pour obtenir un ``et commercial`` (&) Utilisez &etago; pour obtenir </, Don't use \end{verbatim} within a verb environment, as this is what LaTeX uses to end the verbatim environment. (In the future, it should be possible to hide the underlying text formatter entirely, but the parser doesn't support this feature yet.) L'environnement code est pareil que l'environnement verb, excepté que des lignes horizontales sont ajoutées pour entourer le texte, comme ceci: <code> Ceci est un exemple d'environnement code </code> ce qui donnera: Ceci est un exemple d'environnement code

Vous devriez utiliser l'environnement tscreen autour de chaque environnement verb, comme ceci: <tscreen><verb> Voici un exemple de texte. </verb></tscreen> tscreen est un environnement qui simplement indente le texte et met la fonte par défaut à tt (typewriter, style machine à écrire). Cela rend l'aspect des exemples plus agréables, à la fois dans la version LaTeX et dans la version pur texte. Vous pouvez utiliser tscreen sans verb, cependant, si vous utilisez des caractères spéciaux dans votre exemple vous aurez besoin d'utiliser les deux. tscreen ne fait rien aux caractères spéciaux. Voir example.sgml pour des exemples.

L'environnement quote est comme tscreen, excepté que il ne met pas la fonte par défaut à tt. Ainsi, vous pouvez utiliser quote pour les citations, tel que: <quote> Voici un exemple de texte devant etre indente, comme dans une citation. </quote> ce qui générera: Voici un exemple de texte devant etre indente, comme dans une citation.

Avant d'aller trop loin dans les détails, je vais décrire la structure générale d'un document défini par la DTD Linuxdoc-SGML. Voir example.sgml pour un bon exemple de la façon dont un document est établit.

Essentiellement, les mêmes fontes supportées par LaTeX sont supportées par linuxdoc-sgml. Note, however, that the conversion to plain text (through groff) does away with the font information. Les fontes n'apparaitront pas dans le texte ASCII. Donc, vous devriez utiliser les fontes autant que possible, pour le bénéfice de la conversion vers LaTeX. But don't depend on the fonts to get a point across in the plain text version.

En particulier, le tag tt décrit ci-dessus peut être utilisé pour obtenir une fonte ``typewriter'' de largeur constante qui devrait être utilisé pour toutes les adresses email, les noms de machines, les noms de fichiers, etc. Exemple: Voici un <tt>texte typewriter</tt> pour etre inclus dans le document De façon équivalente: Voici un <tt>texte typewriter</tt> pour etre inclus dans le document Rappelez-vous que vous pouvez seulement utiliser cette forme abrégée si le texte entouré ne contient pas de slashes.

D'autres fontes peuvent être obtenues avec bf pour boldface et em pour italique. Plusieurs autres fontes sont également supportées (sf pour sans serif, sl pour slanted, et it pour italics), mais je suggère de ne pas les utiliser, à cause de la conversion de ces documents vers d'autres formats tel que HTML qui peuvent ne pas les supporter. Boldface, typewriter et italics devraient être celles que vous utilisez.

Il existe plusieurs sortes de listes supportées. Ce sont: itemize pour les listes marquées telle que celle-ci enum pour les listes numérotées descript pour les listes ``descriptives'' Chaque item dans une liste itemize ou une liste enum doit être marqué avec un tag item. Les items dans une liste descriptive sont marqués avec tag. Par exemple: <itemize> <item>Voici un item.</item> <item>En voila un second.</item> </itemize> Cela donne ceci: Voici un item. En voila un second. Ou, pour une liste enum, <enum> <item>Voici le premier item.</item> <item>Voici le second item.</item> </enum> Et on obtient: Voici le premier item. Voici le second item. Vous saisissez l'idée. Les listes peuvent bien sur être emboitées; voir le document exemple pour les détails.

Une liste descrip est légèrement différente, et légèrement laide, mais vous voudriez peut-être l'utiliser pour quelques situations: <descrip> <tag/Gnus./ Lecteur de News sous Emacs. <tag/Elm./ Lecteur de Mail. </descrip> ce qui donnera: Gnus. Lecteur de News sous Emacs. Elm. Lecteur de Mail.

Le QWERTZ User's Guide est disponible sur . QWERTZ (et par conséquent, Linuxdoc-SGML) supporte de nombreuses caractéristiques telles que les formules mathématiques, les tables, les figures, etc. Je ne recommende pas l'utilisation de la plupart de ces caractéristiques dans les HOWTO Linux parce qu'elles ne rendront pas bien en pur texte. Si vous désirez écrire de la documentation générale en SGML, je suggère l'utilisation de la DTD QWERTZ originale plutôt que la DTD Linuxdoc-SGML, que j'ai modifiée pour une utilisation particulère par les HOWTO Linux et d'autres documentations. les outils QWERTZ originaux de Tom Gordon peuvent être trouvés sur . Vous trouverz plus d'informations sur SGML sur les pages WWW suivantes: l'analyseur sgmlsde James Clark, et son successeur nsgmlset d'autres outils peuvent être trouvés sur and at . vous pouvez rejoindre la liste de discussion Linuxdoc-SGML en envoyant un mail à avec subscribe linuxdoc-sgml dans le corps du message. L'adresse de la liste est . Plus d'information sur LyXpeut être trouvé à . LyX est un traitement de texte de haut-niveau frontal à LaTeX. Une interface quasi-WYSIWIG, de nombreux styles LaTeX et des layouts générés automatiquement. Améliore l'apprentissage de LaTeX et rend plus facile et plus intuitif la création de layouts compliqués.