====== Table des matières (TOC) ======

[[fr:DokuWiki]] génère automatiquement une table des matière de la page en cours, celle-ci étant généralement placée en haut à droite d'une page. 
Elle offre un aperçu rapide de la structure du document en listant ses entêtes ou titres (h1, h2, h3 etc.). 
Chaque élément de la table des matières est un lien permettant de sauter rapidement à la section désirée. 

La table des matières s'affiche si un [[#configuration|minimum qualifié]] de titres sont présents sur la page. 


===== Astuces =====

==== Désactiver la table des matières ====

La table des matières peut être désactivée sur chaque page en utilisant la [[fr:wiki:syntax#macros|macro de contrôle]] **''%%~~NOTOC~~%%''**. 

Pour désactiver la table des matières sur l'ensemble du wiki,  ajuster le paramètre de configuration  [[fr:config:maxtoclevel]] ou [[fr:config:tocminheads]] à ''0''

====  Ne pas afficher le premier entête dans la table des matières ====

On peut empêcher le premier entête en haut de page, souvent le titre de page, d'apparaître dans la TOC en ajustant le paramètre de configuration [[fr:config:toptoclevel]] à ''2''.

===== Configuration =====

Les paramètres de configuration contrôlent quel niveau de titre doit apparaître dans la table des matières ([[fr:config:toptoclevel]], [[fr:config:maxtoclevel]])
et combien de titres sont requis pour une table des matières ([[fr:config:tocminheads]]).

  * Le paramètre de configuration [[fr:config:toptoclevel| "toptoclevel"]] -- détermine le niveau d'en-tête maximal à inclure dans la table des matières.
  * Le paramètre de configuration [[fr:config:maxtoclevel|"maxtoclevel"]] -- fixe le nombre maximum de niveaux d’en-tête à inclure dans la table des matières.
  * Le paramètre de configuration [[fr:config:tocminheads|"tocminheads"]] -- fixe le nombre minimum de titres dans la page à partir duquel la table des matières est construite.


Par exemple, dans un wiki avec les paramètres suivants :
  * toptoclevel = 2, ie. ''====='' (dans une page html, correspond à <h2>)
  * maxtoclevel = 4, ie. ''==='' (dans une page html, correspond à <h4>)
  * tocminheads = 3
une page nécessitera d'avoir au moins trois titres d'un niveau de 2-4 pour faire apparaître une table des matières.


===== Développement =====

  * Voir [[fr:devel:templates|Développement de thèmes DokuWiki]]

Depuis la version **''2008-05-05''**,  la [[fr:devel:templates#fonctions| fonction tpl_toc]] peut être utilisée pour positionner la table des matières n'importe où dans le thème utilisé.