summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/toc.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/toc.mdwn')
-rw-r--r--ikiwiki/directive/toc.mdwn29
1 files changed, 29 insertions, 0 deletions
diff --git a/ikiwiki/directive/toc.mdwn b/ikiwiki/directive/toc.mdwn
new file mode 100644
index 0000000..a52e856
--- /dev/null
+++ b/ikiwiki/directive/toc.mdwn
@@ -0,0 +1,29 @@
+La directive `toc` est fournie par le module d'extension [[!iki plugins/toc
+desc=toc]].
+
+Voici comment ajouter une table des matières sur une page :
+
+ \[[!toc ]]
+
+La table des matières sera automatiquement créée à partir des titres de la
+page. Par défaut seuls les plus grands titres présents sur la page sont
+affichés. Pour choisir un niveau de titre, il faut utiliser le paramètre
+`levels` :
+
+ \[[!toc levels=2]]
+
+La directive `toc` choisit le niveau du premier titre comme le premier
+niveau, même si des niveaux plus élévés sont rencontrés plus tard dans le
+fichier.
+
+Pour créer une table des matières qui ne liste que les titres d'un certain
+niveau, vous pouvez utiliser le paramètre `startlevel`. Par exemple, pour ne
+montrer que les titres h2 et plus petits :
+
+ \[[!toc startlevel=2]]
+
+La table des matières est une liste ordonnée. Si vous voulez une liste non
+numérotée, il faut changer le style de liste dans la feuille de style
+locale.
+
+[[!meta robots="noindex, follow"]]