Ce petit guide a pour but de vous apprendre comment faire pour insérer un sommaire dans une page du site web.
Il suffit d'insérer un petit code à l'endroit où vous voulez que le sommaire apparaisse. Vous pouvez aussi faire apparaitre plusieurs sommaires.
Ce code est le suivant :
<!--tableofcontents--> ou <!-- tableofcontents --> (il n'est pas très regardant sur les espaces).
On peut également lui indiquer des options :
<!--tableofcontents [options] -->
Les options sont les suivantes :
- title (texte), donne un titre, par défaut "Sommaire".
- list ("ol" ou "ul"), défini le type de liste (liste numérotée "ol" ou liste à puce "ul"), par défaut "ol".
- minlevel (chiffre entre 1 et 6), indique quel titre il considère le plus haut (<h[1-6]>), par défaut "2".
- maxlevel (chiffre entre 1 et 6), indique quel titre il considère le plus bas (<h[1-6]>), par défaut "4".
- attachments ("no" ou "yes), affiche ou non les fichiers attachées, par défaut "no".
Il faut séparer le nom de l'option et la valeur de l'option par ":" et les différentes options par ";".
Voici un exemple :
<!--tableofcontents list: ol; title: Table of Contents; minlevel: 2; maxlevel: 4; attachments: no;-->
De manière génréale, vous n'avez qu'a utiliser le code suivant (puisque les options par défaut ont été faites pour le site de l'April et correspondent parfaitement) :
<!--tableofcontents-->
Vous pouvez modifier les options, mais évitez tout de même surtout pour "minlevel", "maxlevel", "list" sauf si vous savez ce que vous faite.
Notes :
- L'option "title" est traduite (passé par la fonction t() de Drupal). La véritable valeur par défaut de cette option est donc "Table of Contents", mais sur chaque contenu en français on voit "Sommaire".
- L'option "attachments", ne tiens pas compte de si le fichier a été indiqué "à lister" ou non (c'est plus un bogue qu'autre chose).
- Le ";" à la fin des options n'est pas obligatoire, il n'y a pas non plus d'ordre pour les options.
- La valeur de l'option "maxlevel" doit être plus grand que celle de "minlevel".