Seiten-Inhaltsverzeichnis

Erstellt am 13.02.2024 Lesedauer 1 - 2 Min.

Alternativ zum manuellen Inhaltsverzeichnis durch eine Querverweis-Liste kann ein Überschriften-Verzeichnis der Seite mit der Funktions toc erzeugt werden.

Die Funktion erzeugt aus allen Überschriften des erzeugten Dokuments ein Inhaltsverzeichnis. Es enspricht immer dem Status der exportierten Datei, inkl. dabei eingefügter Teile oder Elementen aus dem Layout oder importierter Markdown-Dateien.

Definition

$$$ toc 1x6 : Verzeichnisname $$$

1x6 (optional)

Ohne Zuordnung wird „1-6“ unterstellt.

Die Zahlen in der Zuordnung (die hier formal genau so aussehen muss!) definierten die Start- und Stopp-Hierarchie für das Verzeichnis.

Das „x“ kann ein beliebiges, gültiges Zeichen sein, das ggf. mehrere Verzeichnisse auf einer Seite unterscheidbar macht.

Verzeichnisname (optional): Wird, wenn vorhanden, als „Titel“ des Verzeichnisses verwendet

Verarbeitung

Das Verzeichnis wird mit <DIV class="toc"> umschlossen.
Ein Inhaltsverzeichnis muss der einzige Eintrag in einem Absatz sein.
Der »Verzeichnisname« kann beliebig gewählt werden und wird mit <p class="toctitle"> umschlossen.
Jeder Verzeichniseintrag erhält eine ID basierend auf der Überschrift, der „toc-“ vorangestellt ist.

Bei mehreren Verzeichnissen mit gleichen Verweisen kommen diese IDs mehrfach vor!

Für die Gestaltung der so erzeugten Verzeichnisse müssen die Klassen .toc, .toctitle und .toc ul (ggf. mehrstufig) in der Stilvorlage definiert sein.

Die Klassennamen sind „genau so“ vorgegeben.