Les descriptions

Ce type de liste permet d'associer un mot à sa définition ou description un peu comme dans un dictionnaire.

1 - Définir une description

Comme la majorité des listes que nous allons étudier, la première chose à faire est de définir l'élément, puis de lui ajouter des options pour obtenir le résultat voulu. La définition d'une description ce fait avec la commande \definedescription. Pour notre exemple nous allons définir une liste de description que nous appelons dico (tu peux choisir n'importe quel nom).

Voici un petit exemple qui montre comment utiliser notre description dico et le résultat obtenu après compilation.

Attention, n'oublie pas le \par à la fin de chaque définition sous peine d'erreur de compilation.

Le résultat de la compilation :

Si dans ta définition tu utilises des paragraphes, il vaut mieux utiliser les commandes suivantes :

Maintenant nous allons améliorer l'aspect visuel de notre description à l'aide d'options

2 - headstyle

Cette option permet de modifier l'aspect de notre entête. Elle peut prendre les valeurs suivantes :

• normal entête normal ;
• bold entête en gras ;
• slanted entête en italique ;
• boldslanted entête en gras et italique ;
• type entête en caractère machine à écrire ;
• cap entête en capitale ;
• small entête en petits caractères ;
• une commande entête modifié par une commande, comme par exemple pour le mettre en couleur.

Tu as deux façons d'indiquer une option, soit à la suite de \definedescription par exemple pour mettre l'entête en capitale :

soit en utilisant la commande \setupdescriptions[nom-description][option1=x,option2=y,. . .]

Attention, n'oublie pas le s à la fin de \setupdescriptions.

Dans les deux cas, tu peux mettre plusieurs options, il faut juste les séparer par une virgule. Si tu as défini plusieurs listes de description auxquelles tu veux appliquer les mêmes options tu procèdes comme suit :

Tu peux en ajouter autant que tu veux il suffit de les séparer par des virgules. Tu peux également avoir un tronc commun et des variantes pour chaque description par exemple toutes en capitale, mais les dico en rouge et les glossaire en vert :

Cet exemple te montre l'utilité des deux méthodes.

Revenons à nos options pour headstyle. Voici le résultat de la commande suivante :

Maintenant si tu veux mettre l'entête en rouge, il faut utiliser une commande comme ceci :

Tu peux mettre plusieurs commandes comme par exemple en rouge et en petites capitales :

3 - style

Identique à headstyle, mais affecte le texte de la définition. Possède exactement les mêmes options.

4 - color

Permet de modifier la couleur du texte de la définition, n'affecte pas l'entête.

Pour avoir le texte en rouge :

5 - width

Contrôle la largeur de l'entête. Par défaut cette largeur est d'environ 3 cm ou 7 em.

Ça coince un peu. width est la pour t'aider. Il peut prendre 3 valeurs :

fit la largeur de l'entête s'adapte au mot.

broad identique à fit mais l'espace entre le mot et le texte de la définition est définit par distance.

Enfin tu peux attribuer une dimension, toutes les unité reconnues par ConT_eXt sont acceptées.

6 - distance

Gère l'espace entre le mot et la définition il ne peut prendre en valeur qu'une dimension :

7 - text

Permet d'ajouter un texte avant l'entête :

8 - align

Gère la position de l'ensemble de la description (mot plus définition) sur la page prend 3 valeurs left, middle et right:

9 - margin

Règle la distance entre la marge et la description. Par défaut il n'y a pas de retrait :

Les valeurs possible sont standard, yes, no et une dimension. Avec standard et yes on a un retrait :

Avec no pas de retrait et avec dimension on peut préciser la taille du retrait :

10 - alternative

Attention l'ancienne option location ne marche plus avec les versions récentes de MKIV, elle est remplacée par alternative

Permet de préciser la position de l'entête par rapport à la définition. Par défaut sa valeur est left. Avec rigth on obtient :

Les autres valeurs possibles sont : top, serried, inmargin, inleft, inright et hanging''.

top place l'entête au-dessus de la définition :

serried supprime le retrait du texte de la définition :

inmargin met l'entête dans la marge :

Attention il faut prévoir des marges suffisamment grande pour contenir l'entête ou re-dimensionner ce dernier :

inleft et inright même effet que inmargin mais uniquement et respectivement dans les marges de gauches et de droites.

hanging provoque un retrait de la définition :

11 - hang

Provoque un retrait des premières lignes de la définition. Peut prendre 3 valeurs, fit, broad et un nombre.

fit n'autorise que le retrait de la première ligne.

broad permet le retrait des deux premières lignes :

Si tu indiques un nombre, le retrait affecte le nombre de ligne équivalent.

Comme tu peux le voir sur l'exemple précédent ne nombre de ligne affectées ne peut dépasser une fin de paragraphe.

L'exemple suivant sans paragraphe donne le bon résultat :

12 - before, inbetween et after

Ces trois options permettent d'ajouter des commandes dont l'action interviendra respectivement avant entre et après une description.

inbetween ne marche que si location=top

Par exemple si tu veux obtenir une présentation sophistiqué, comme ajouter un trait entre le mot et la définition.

Si tu veux augmenter l'espace entre les définitions :

Attention n'oublie pas les { } dans before et after sous peine d'erreur de compilation.

13 - closesymbol

Permet de mettre à la fin de la définition un élément de texte comme par exemple un symbol :

Tu peux ajouter une image, par exemple le logo debian, pour ce faire voici comment procéder, il faut d'abord créer une commande qui affiche notre dessin :