Table des matières: <toc>

Les attributs autorisés dans les éléments <toc1>, <toc2>, <toc3> et <toc4> sont les mêmes que pour un lien hypertexte (docref, href, file, top-href, rel-href, cible...).

Si aucun de ces attributs n'est présent, un titre de niveau adéquat (1, 2, 3 ou 4) sera créé dans la table des matières, et ce titre sera non cliquable.

<toc>
   <toc1 docref="intro-format-xml-ulb">introduction</toc1>
   <toc1>Structure en page des documents:</toc1>
   <toc2 docref="doc-plusieurs-pages">les documents de plusieurs pages</toc2>
   <toc2 docref="identificateur">identificateur des pages générées</toc2>
</toc>

Dans cet exemple, le deuxième <toc1> sera un titre non cliquable. Cela donne:

Affichage en une, deux, trois, quatre ou cinq colonnes

L'attribut cols permet de choisir le nombre de colonnes désirées dans la table des matières: 1, 2, 3, 4 ou 5 (La valeur par défaut est 1).

<toc cols="2">
 <toc1 docref="intro-format-xml-ulb">introduction</toc1>
 <toc1 docref="structure">structure</toc1>
 <toc1 docref="doc-plusieurs-pages">pages</toc1>
 <toc1 docref="identificateur">identificateur</toc1>
 <toc1 docref="hypertexte">liens hypertexte</toc1>
</toc>

Ce qui donne :

Style d'une table des matières

Une table des matières est considérée comme un bloc. Tous les attributs (style, bords et ses variantes, ajuster-hauteur...) définis pour les blocs peuvent être utilisés, ainsi que l'élément <titre>.

En voici quelques exemples:

Espaces au sein d'un table des matières

Dans certains cas, pour mettre en évidence certaines parties de la table des matières, il est souhaitable d'augmenter les espaces entre les lignes. Cela peut se faire à l'aide d'un élément <br/> placés aux endroits voulus.

Lignes de séparation au sein d'un table des matières

On peut également insérer des lignes de séparation afin de rendre la table des matières plus lisible. Ces lignes peuvent être ajoutées automatiquement (entre les éléments de plus haut niveau), ou être ajoutées manuellement aux endroits désirés.

Ajout automatique d'une ligne de séparation

Pour ajouter automatiquement une ligne de séparation entre les éléments de plus haut niveau, il suffit d'ajouter un attribut séparateur="..." à l'élément <toc>.

Ajout manuel d'une ligne de séparation

On peut également insérer des lignes de séparation grâce à des éléments <hr/> ou <hr séparateur="..."/> placés aux endroits voulus.

Création automatique d'une table des matières sur base des titres de la page

Il est possible d'insérer automatiquement tous les titres de la page et d'un certain niveau, en insérant dans l'élément <toc> un élément vide <page-titre1/> (pour insérer les titres de niveau 1), <page-titre2/> (pour insérer les titres de niveaux 1 et 2), <page-titre3/> (pour insérer les titres de niveaux 1, 2 et 3) ou <page-titre4/> (pour insérer les titres de niveaux 1, 2, 3 et 4).

Vous pouvez également décider que certains titres ne doivent pas y apparaître, ou doivent y apparaître modifiés.

<toc bords="arrondis" style="class1">
   <page-titre2/>
</toc>

Dans cet exemple, on collecte tous les <titre1> et <titre2> de cette page (le premier titre de celle-ci, de niveau 1, n'y apparaît pas car on a décidé de le supprimer de la table des matières). Cela donne:

Création automatique d'une table des matières sur base des titres d'un document

Il est possible d'insérer automatiquement tous les titres du document (trouvés dans l'ensemble des pages de ce document) et d'un certain niveau, en insérant dans l'élément <toc> un élément vide <document-titre1/> (pour insérer les titres de niveau 1), <document-titre2/> (pour insérer les titres de niveaux 1 et 2), <document-titre3/> (pour insérer les titres de niveaux 1, 2 et 3) ou <document-titre4/> (pour insérer les titres de niveaux 1, 2, 3 et 4).

Vous pouvez également décider que certains titres ne doivent pas y apparaître, ou doivent y apparaître modifiés.

<toc bords="arrondis" style="class1">
   <document-titre1/>
</toc>

Dans cet exemple, on collecte tous les <titre1> de ce document (c'est-à-dire de toutes les pages de l'aide en ligne). Cela donne:

Suppression ou modification de certains titres dans les tables de matières automatiques

Les tables de matières automatiques dans une page ou dans un document vont rechercher systématiquement tous les titres de la page ou du document, et ce du ou des niveaux choisis.

Il peut s'avérer utile de ne pas insérer certains titres dans ces tables automatiques (la titre de la page, par exemple, n'est pas nécessairement utile dans la table des matières), ou de les insérer avec un texte différent (lorsque le titre est trop long, par exemple).

Supprimer certains titres

Pour supprimer certains titres dans une table des matières automatique, il suffit de placer sur l'élément <titre1>, <titre2>, <titre3> ou <titre4> un attribut:

• toc="non": supprime le titre dans les tables des matières automatiques des pages ET des documents;

• toc-page="non": supprime le titre dans les tables des matières automatiques des pages uniquement;

• toc-document="non": supprime le titre dans les tables des matières automatiques des documents uniquement;

Modifier certains titres

Pour changer certains titres dans une table des matières automatique, il suffit de placer sur l'élément <titre1>, <titre2>, <titre3> ou <titre4> un attribut:

• toc-titre="xxxx": change le titre en xxxx dans les tables des matières automatiques des pages ET des documents;

• toc-page-titre="xxxx": change le titre en xxxx dans les tables des matières automatiques des pages uniquement;

• toc-document-titre="xxxx": change le titre en xxxx dans les tables des matières automatiques des documents uniquement;

Section optionnelle dans une table des matières

Une partie de la table des matière peut être affichée de manière optionnelle, grâce à un élément <section> placé dans l'élément <toc>.

Pour plus d'information, consultez la documentation consacrée aux sections optionnelles.