Zum Inhalt

Inhaltsverzeichnis

Voraussetzung

Modul Table of Contents muss unter Theme → Module aktiv sein.

Diese Seite ist noch im Aufbau

Angaben und Abbildungen sind gegen das Theme geprüft. Die ausführliche Beschreibung folgt.

Wozu

Das TOC‑Add‑on erstellt automatisch ein Inhaltsverzeichnis aus Überschriften im Content.

Einstellungen

Unter Theme → Einstellungen → Hilfsmittel → Inhaltsverzeichnis:

Der Abschnitt Inhaltsverzeichnis im Reiter Hilfsmittel

  • Enable table of contents: TOC aktivieren/deaktivieren
  • Levels starting from H2: Tiefe ab H2 (1 = nur H2, 2 = H2+H3 …)
  • Exclude class: Überschriften mit dieser Klasse werden ignoriert
  • List wrapper: ol, ul oder div
  • Wrapper class / Item class / Link class: CSS‑Klassen für Ausgabe
  • Title / Title tag: Überschrift des TOC
  • Nav class: Wrapper‑Klasse für das TOC‑<nav>

Nutzung im Theme

In Templates kannst du das TOC so verwenden:

$toc = twtheme_toc(get_the_content());
echo $toc['toc'];
echo $toc['content']; // Content mit IDs an den Überschriften

Anwendung im Frontend

Das Inhaltsverzeichnis wird im Template über twtheme_toc() gerendert und erzeugt Ankerlinks im Content.

Entwicklertipps

Funktion Zweck
twtheme_toc($content, $args = []) Inhaltsverzeichnis und ausgezeichneten Inhalt erzeugen
twtheme_toc_option_defaults() die Standardwerte aus den Theme-Optionen
twtheme_toc_default_block_attributes() die Standardattribute des Blocks
twtheme_toc_args_from_block_attributes($attributes) Blockattribute in $args für twtheme_toc() übersetzen

Der letzte Weg ist der zuverlässigste, wenn ein Template dasselbe Ergebnis wie der Block liefern soll: Er normalisiert Ebenen, Listentyp und Titel genauso.

Twtheme Hooks & Filter

Hook/Filter Typ Parameter Zweck
twtheme_option_fields Filter ($form_data) TOC‑Optionen in den Theme-Optionen einhängen.