[ précédent ] [ Table des matières ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ suivant ]

Manuel de Debiandoc-SGML
Chapitre 4 - Texte brut balisé et balisage du style de caractères


Le texte ordinaire (appelé «texte brut» dans ce document) peut contenir des éléments de formatage spécial et de référencement croisé. Le texte brut apparaît dans les titres de chapitres et de sections, dans le résumé du copyright, à l'intérieur des paragraphe et dans d'autres endroits équivalents.


4.1 Style de caractères

Il y a un certain nombre d'éléments pour marquer la signification particulière de certains morceaux de textes. Pour ceux-ci, la fin du texte spécial doit être marqué explicitement, en utilisant une balise de fin explicite </element>, la balise de fin abrégée fermant l'élément le plus proche </> ou la barre oblique / qui termine la forme la plus abrégée des balises. (voir Balises SGML et caractères spéciaux, Chapitre 1).

<em> - emphase
Indique que le texte contenu est plus important ou plus significatif que celui environnant.

Typiquement ceci sera représenté si possible par des italiques, ou par un texte en gras ou souligné, ou bien dans les formats de texte seulement, sans styles de caractère spéciaux, en encadrant le texte avec des astérisques comme *ceci*.

<var> - méta-variable
Indique que le texte contenu est une méta-variable. C'est-à-dire, que c'est le nom d'un objet ou d'une pièce syntaxique qui dans un usage normal serait remplacée par une valeur réelle.

Typiquement ceci sera représenté par des italiques, ou les formats de texte seulement en encadrant le texte avec des crochets angulaires comme <ceci>. Si plusieurs méta-variables apparaissent successivement, elles doivent chacune utiliser leur propre élément <var>.

<prgn> - nom d'un programme ou d'un fichier bien connu
Indique que le texte contenu est le nom d'un programme, d'un fichier bien connu (habituellement sans chemin), d'une fonction ou d'un objet équivalent ayant un nom pour l'ordinateur.

Dans les formats de sortie où il existe des styles de caractères spéciaux et des styles de polices variés, ceci est habituellement représenté en utilisant une police non-proportionnelle. Dans les formats de sortie texte seulement, ces noms ne sont pas spécialement marqués, puisqu'ils surviennent fréquemment et qu'introduire un encadrement perturberait le cours du texte.

<tt> - chemin, code ou fragment de sortie, chaîne de commande
Indique que le texte contenu est une chaîne quelconque provenant ou étant destiné à un ordinateur. Ceci doit être utilisé pour les chemins complets, les fragments de code devant être visualisés sous forme brute et sans justification (voir aussi Exemples, Section 5.2 pour une autre solution) et ainsi de suite. Il est fréquemment nécessaire d'introduire des méta-variables dans ces chaînes, qui dans ce cas doivent faire partie de l'élément <tt> plutôt que des éléments environnants.

Ceci sera habituellement représenté en utilisant une police de largeur fixe; dans les formats texte seulement un encadrement peut être utiliser autour de l'élément.

<qref id="refid"> - référence conditionnelle
Crée une «référence conditionnelle» vers la référence nommée id (voir Références croisées, Section 4.2). Ceci doit être utilisé lorsque une référence croisée est utile si elle ne perturbe pas le cours du texte, mais que non-essentielle, elle peut être abandonnée si elle doit le perturber.

Dans les formats permettant des références croisées non-perturbantes en faisant d'une zone de texte un hyperlien sans introduire du nouveau texte, cet élément fera du texte contenu un hyperlien vers la cible de la référence croisée. Dans les autres formats cet élément n'aura aucun effet.


4.2 Références croisées

Il y a plusieurs éléments permettant d'introduire des références croisées soit vers les autres parties d'un même document soit vers d'autres documents.

Les références croisées internes au document sont basées sur un schéma d'identifiants référentiels. Chaque chapitre, section, sous-section, etc. peut avoir un attribut id lui donnant son identifiant référentiel - par exemple <chapt id="spong"> spécifie que le chapitre commençant possède l'identifiant référentiel spong. Cet identifiant référentiel peut alors être pointé dans d'autres parties du document en utilisant les éléments spéciaux des références croisées.

L'identifiant référentiel sera aussi utilisé pour générer des noms de fichiers et des objets référentiels pour les formats tel que HTML qui produisent plusieurs fichiers de sortie; si aucun identifiant référentiel n'est spécifié alors les numéros de chapitres et de sections seront utilisés. C'est une bonne idée de donner au moins à tous vos chapitres un identifiant référentiel pour que les noms de fichiers ne changent pas si vous changez l'ordre des chapitres ou des sections dans votre document.

<ref id="idref"> - Référence interne au document
Ceci génère une référence croisée à l'intérieur du même document vers la section ou le chapitre correspondant à l'identifiant idref.

L'élément <ref> n'a pas de contenu; le numéro de section ou de chapitre, le titre et son numéro de page ou tout autre chose approprié pour le format de sortie sera inséré dans le texte à l'endroit où la balise apparaît.

Syntaxiquement la référence croisée est une phrase sans verbe, approprié dans des situations tel que (voir <ref id="...">) ou plus d'informations dans <ref id="...">..

<manref name="nom" section="section"> - page de manuel (manpage)
Génère une référence croisée vers la page de manuel nom de la section section. Cette balise n'a pas de contenu; le texte décrivant la page, typiquement nom(section), sera inséré à l'endroit où <manref> apparaît.
<email> - adresse de courrier électronique (email)
Indique que le texte contenu est une adresse de courrier électronique (email). Le contenu de la balise doit uniquement être le texte de l'adresse elle-même; les balises de style de caractères et les références croisées sont interdites. Habituellement la balise de fin </email> ne doit pas être omise, mais on peut l'oublier lorsque l'adresse apparaît à la fin d'un élément <author>. Le début de l'élément suivant impliquera la fin de l'adresse de courrier électronique.

Dans certains formats, ceci générera une véritable référence croisée qui pourra (par exemple) être utiliser pour envoyer un courrier électronique à l'adresse définie. Dans d'autres, cela marquera simplement le texte de manière spéciale, habituellement en l'encadrant de crochets angulaires < >.

<ftpsite> - nom de site FTP anonyme
<ftppath> - chemin dans le dernier site FTP cité
<ftpsite> indique que le contenu de l'élément est le nom DNS d'un site FTP anonyme et <ftppath> un chemin dans ce site FTP. Les deux éléments ne peuvent contenir aucune balise de style de caractères ou de références croisées.

Typiquement les deux éléments seront représentés par une police non-proportionnelle; si possible, le chemin du site (<ftppath>) sera transformé en un hyperlien fonctionnel vers le fichier ou le répertoire du dernier site FTP (<ftpsite>) cité.

<ftppath> doit toujours être précédé par <ftpsite> dans le même chapitre, mais une fois qu'un site FTP a été cité, plusieurs chemins peuvent apparaître.


4.3 Notes de bas de page

Les notes de bas de page peuvent apparaître dans la plupart des textes bruts et sont indiquées par <footnote>...</footnote>. Le texte de la note de bas de page sera retiré, placé ailleurs (l'endroit dépendant du format) et remplacé par une référence ou un hyperlien vers la note de bas de page.

Le contenu de la note de bas de page doit être un ou plusieurs paragraphes; le début du premier paragraphe doit être marqué explicitement. Les balises de texte brut tel que les styles de caractères n'ont pas d'effet sur le contenu de la note de bas de page définit à l'intérieur d'eux - la note de bas de page fait table rase.

Les notes de bas de page peuvent être imbriquées, mais c'est rarement une bonne idée.


[ précédent ] [ Table des matières ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ suivant ]

Manuel de Debiandoc-SGML

28 July 2004

Ian Jackson ijackson@gnu.ai.mit.edu
Traduction de Christophe Le Bars clebars@debian.org