Inhaltsverzeichnis ShortCode für Wordpress

Nicht nur für den User ist ein Inhaltsverzeichnis bei langen Texten interessant sondern auch Google nutzt Inhaltsverzeichnisse oft um weitere Kurzlinks unter den SERP Eintrag anzuzeigen. Daher wurde kurzerhand der „Inhaltsverzeichnis-ShortCode“ ins Plugin aufgenommen damit du einfach und schnell ein Inhaltsverzeichnis für deine Seite erstellen kannst. Die Anker bzw. Sprungmarken werden dabei durch das id-Attribut eines HTML Elements gesetzt. Da der Standard Editor von WordPress das Einfügen eines id-Attributes bei H1,H2,H3,etc. nicht unterstützte gibt es zusätzlich einen Anker-ShortCode mit welchen du an beliebiger Stelle deines Textes einen unsichtbaren Anker für dein Inhaltsverzeichnis setzen kannst. Ausgegeben wird das Inhaltsverzeichnis über UL/LI HTML Elementen.

Inhaltsverzeichnis

Code Beispiel(Beispiel anhand dieses Inhaltsverzeichnisses)
Aufbau des Shortcodes(Parameter und Möglichkeiten des Inhaltsverzeichnis)
Aufbau der ShortCodes für ein Inhaltsverzeichnis Items(Parameter und Möglichkeiten der Einträge)
Aufbau des Anker-ShortCodes(Beschreibung der Parameter)
Beispiel des ShortCodes mit individuellen Farben(Eintrag einer weiteren Ebene)
Eintrag Ebene 5(Eintrag einer weiteren Ebene)
Eintrag Ebene 6(8)
weitere ShortCodes im Plugin(dieses Plugin hat viel zu bieten)

Dieses Inhaltsverzeichnis wurde mit dem Inhaltsverzeichnis-ShortCode und dem Anker-ShortCode erzeugt

Code Beispiel für das obige Inhaltsverzeichnis

[inhaltsverzeichnis title="Inhaltsverzeichnis" ]
[ivitem name="Code Beispiel" url="#code_beispiel" ](Beispiel anhand dieses Inhaltsverzeichnisses)[/ivitem]
[ivitem name="Aufbau des Shortcodes" url="#aufbau_iv" ](Parameter und Möglichkeiten des Inhaltsverzeichnis)[/ivitem]
[ivitem em name="Aufbau der ShortCodes für ein Inhaltsverzeichnis Items" url="#aufbau_iv_item" level=1](Parameter und Möglichkeiten der Einträge)[/ivitem]
[ivitem name="Eintrag Ebene 3" url="#weitereshortcodes" level=2](Eintrag einer weiteren Ebene)[/ivitem]
[ivitem name="Eintrag Ebene 4" url="#weitereshortcodes" level=3][/ivitem]
[ivitem name="Eintrag Ebene 5" url="#weitereshortcodes" level=4][/ivitem]
[ivitem name="Eintrag Ebene 6" url="#weitereshortcodes" level=5][/ivitem]
[ivitem name="weitere ShortCodes im Plugin" url="#weitereshortcodes" ](dieses Plugin hat viel zu bieten)[/ivitem]
[/inhaltsverzeichnis]

Parameter und Optionen des ShortCode Inhaltsverzeichnis

[inhaltsverzeichnis title="" design="" title-h="" background=""][/inhaltsverzeichnis]

„title“: mögliche Werte [beliebig]
Dies ist ein Pflichtfeld und steht für den Namen der Liste
„design“: mögliche Werte [standard]
Aussehen der Liste. Aktuell ist nur ein Standard Design implementiert welches aber von dir mittels Parametern angepasst werden kann.
„title-h“: mögliche Werte [h2,h1,h3,h4]
Hiermit kannst du angeben welcher Überschrift du verwenden möchtest. Standard ist H2, da ja der Seitentitel H1 haben sollte.
„design“: mögliche Werte [standard]
Aussehen der Liste. Aktuell ist nur ein Standard Design implementiert welches aber von dir mittels Parametern angepasst werden kann.
„background“: mögliche Werte [ein beliebiger Farbwerte im #000000 Format]
Mit diesem Parameter kannst du einen eigenen Hintergrund für dein Inhaltsverzeichnis angeben um es an das Design deines Themes anzupassen.
Der Standardwert ist aktuell: background-color:#eeeeee;

Parameter und Optionen des ShortCodes für Einträge des Inhaltsverzeichnis

[ivitem name="" url="" level=5]Zusatztext[/ivitem]

„name“: mögliche Werte [beliebig]
Dies ist ein Pflichtfeld und steht für den Text des Menüpunktes eines Eintrages im Inhaltsverzeichnis
„url“: mögliche Werte [beliebig]
Sprungmarke oder Link auf welchen der Menüpunkte eines Eintrages im Inhaltsverzeichnis zeigt. Zum Anlegen eines Ankers bzw. einer Sprungmarke kannst du, falls dein Theme dies nicht unterstützt den Anker-Shortcode Benutzen.
„level“: mögliche Werte [0,1,2,3,4,5]
Mit Level kann man die Einrückung der Inhaltsverzeichnis Punkte festlegen. Der Standardwert 0 bedeutet keine Einrückung. Die weiteren 5 Level/Ebenen bedeuten Einrückungen im 0.5em Schritten (0.5em bis 2.5em)
„Zusatztext“: mögliche Werte [beliebig]
Hier kann eine kleine Beschreibung beim Menüpunkt angezeigt werden.
z.B. wenn der Menüpunkt lautet … die besten eBooks … kann man in Klammer die Anzahl dazuschreiben, wie man es aus Menüs kennt.

Parameter des Anker-ShortCodes

[anker id=""]

„id“: mögliche Werte [beliebig]
Hier kann man einen beliebigen Namen für den Anker bzw. die Sprungmarke angeben. Dies kann dann in einem URL angegeben werden um an diese Sprungmarke auf der Seite zu gelangen. Achtung! Diese ID muss eindeutig sein und darf nur einmal auf der Seite vorkommen!
Beispiel : id=“meine_sprungmarke“ … diese kann dann als URL #meine_sprungmarke verwendet werden,

Beispiel des Inhaltsverzeichnis-ShortCodes mit individuellen Farben