WordPress jQuery Table of Contents Plugin (TOC)

Das WordPress jQuery Plugin bietet die Möglichkeit ein Inhaltsverzeichnis zu generieren. Die definierten H-Überschriften werden automatisch mit Sprungmarken verlinkt. Es ist recht minimal und klein gehalten, so gibt es keinerlei Optionen oder allgemeine Einstellungsmöglichkeiten. Auch CSS ist nur auf das nötigste begrenzt. Lediglich der Shortcode bietet einige Möglichkeiten.

Das Plugin kann hier heruntergeladen werden: download

Natürlich kommt das Plugin auch auf dieser Seite zum Einsatz:

Inhaltsverzeichnis

    Verwendung

    Shortcode

    Mittels Shortcode wird das Inhaltsverzeichnis eingebunden:

    [toc]

    Diesem Shortcode können 4 Parameter übergeben werden, falls keine Parameter übergeben worden sind, werden folgende Standardwerte genutzt:

    [toc überschrift="Inhaltsverzeichnis" selector="body" headings="h1, h2, h3" class=""]
    • überschrift
      Ist die Überschrift des gesamten Inhaltsverzeichnis
    • selector
      Ist der jQuery selector in welchem das Plugin nach Überschriften sucht. Dies ist je nach Theme unterschiedlich, muss also dementsprechend eigenständig angepasst werden
    • headings
      Sind die Überschriften, die eingebunden werden
    • class
      zusätzliche eigene CSS Klasse die angefügt werden kann

    Filter

    Mittels folgendem Filter können die Standard-Werte angepasst werden. Child-Theme oder MU-Plugins dafür nutzen.

    Position

    Das Verzeichnis kann derzeit nur manuell per Shortcode in den Content eingefügt werden. Allerdings ist es möglich den Shortcode in einem Text-Widget in der Sidebar auszuführen.

    Smooth Scroll und Offset

    Es gibt keine Smooth Scroll oder Offset Funktion. Falls dies gewünscht ist kann ich das Plugin Easy Smooth Scroll Links empfehlen.

    Credits

    Basierent auf der jQuery Erweiterung von Nikhil Dabas.

    Voraussetzung: jQuery (haben aktuelle Themes und WP-Versionen ohnehin).

    Schreibe einen Kommentar