25.1.2 \addcontentsline

Synopsis :

\addcontentsline{ext}{unit}{texte}

Ajoute un article dans le fichier auxiliaire dont l’extension de nom est ext.

L’exemple suivant a pour effet d’ajouter une ligne ‘Appendices’ à la table des matières :

\addcontentsline{toc}{section}{\protect\textbf{Appendices}}

elle apparaîtra au même niveau de renfoncement que les rubriques, sera en caractères gras, et recevra le numéro de page correspondant au point où la commande apparaît dans le fichier d’entrée.

La commande \addcontentsline écrit de l’information dans le fichier nom-racine.ext, où nom-racine est le nom du fichier racine (voir Splitting the input). Il écrit cette information comme le texte de la commande \contentsline{unit}{texte}{numéro}, où numéro est la valeur courante du compteur unit (voir \contentsline). Le cas le plus fréquent est la table des matières et dans ce cas numéro est la valeur du compteur unit dans la première page produite où la commande \addcontentsline correspondante fut utilisée.

Cette commande est invoquées par les commandes de rubricage \chapter, etc. (voir Sectioning), et aussi par \caption au sein d’un environnement flottant (voir Floats). Mais elle est aussi directement utilisées par des auteurs. Par exemple, un auteur écrivant un livre dont le style est d’avoir une préface non numérotée pourrait utiliser \chapter*. Mais cette commande ne produit pas d’article dans la table des matières, on peut alors l’entrer manuellement ainsi :

\chapter*{Preface}
\addcontentsline{toc}{chapter}{\protect\numberline{}Préface}

Dans le fichier nom-racine.toc LaTeX insère alors la ligne \contentsline {chapter}{\numberline {}Préface}{3} ; notez que le numéro de page ‘3’ est généré automatiquement par le système, et non saisi manuellement.

Tous les arguments de \addcontentsline sont obligatoires.

ext

Typiquement c’est l’une des trois chaînes suivantes : toc pour la table des matières (« table of contents » en langue anglaise), lof pour la liste des figures (« list of figures »), ou lot pour la liste des tableaux (« list of tables »). L’extension de nom de fichier du fichier dans lequel l’information doit être écrite.

unit

Une chaîne dépendant de la valeur de l’argument ext, typiquement l’une des suivantes :

toc

Pour la table des matières, c’est le nom d’une unité sectionnelle : part, chapter, section, subsection, subsubsection, etc.

lof

Pour la liste des figures : figure.

lot

Pour la liste des tableaux : table.

texte

Le texte de l’entrée. On doit précéder de \protect toute commande fragile (voir \protect) y figurant.

La commande \addcontentsline a une interaction avec \include (voir \include & \includeonly). Si vous les utilisez au même niveau comme dans \addcontentsline{...}{...}{...}\include{...}, alors les lignes dans la table des matières risquent de sortir dans un ordre erroné. La solution est de déplacer \addcontentsline dans le fichier qu’on inclut.

Si vous utiliser une unit que LaTeX ne reconnaît pas, comme la coquille dans l’exemple suivant

\addcontentsline{toc}{setcion}{\protect\textbf{Appendices}}

alors vous n’obtiendrez pas une erreur mais le formatage de la table des matières sera incohérent.