Template-Sprache

Automatisches Inhaltsverzeichnis erstellen lassen

Eine große Arbeitserleichterung - gerade bei umfangreicheren Newsletter-Ausgaben - ist die automatische Erstellung eines Inhaltsverzeichnisses. Selbiges verschafft Empfängern einen Überblick über die enthaltenen Beiträge und erlaubt den Sprung zu Ankerpunkten innerhalb der E-Mail. Um sich die aufwändige händische Erstellung zu sparen, kann die Template Engine über einige Attribute angewiesen werden, diese Aufgabe zu übernehmen.

Inhaltsverzeichnis gestalten

Zur Generierung eines Inhaltsverzeichnisses erstellt man ein entsprechendes Beitragsmuster und legt mit sipa:type seinen Typ auf "toc" fest. In der Regel werden sipa:id und sipa:icon mit dem gleichen Wert versehen. Über sipa:title gibt man dem Inhaltsverzeichnis eine aussagekräftige Bezeichnung.

Innerhalb des Beitrags wird der sich wiederholende Bereich mit sipa:tocloop gekennzeichnet. Optional lässt sich über sipa:evenclass eine Stylesheet-Klasse für jeden zweiten Verzeichniseintrag zuweisen, etwa um diesen farblich zu hinterlegen.  Die einzelnen verlinkten Einträge im Verzeichnis erhalten das Attribut sipa:tocitem.

Beispiel

<div sipa:type="toc" sipa:id="toc" sipa:icon="toc" sipa:title="Inhaltsverzeichnis">
<h1>Themen dieser Newsletter-Ausgabe</h1>
<ol>
<li sipa:tocloop="true"><a sipa:tocitem="true" sipa:id="ueberschrift" href="#">Eintrag</a></li>
</ol>
</div>

Kennzeichnung von Überschriften

Um festzulegen, welche Überschriften aus den im Template vorhandenen Beitragsmustern in das Inhaltsverzeichnis übernommen werden sollen, müssen diese noch entsprechend markiert werden. Das geschieht mit dem Attribut sipa:toc.

<h2 sipa:id="ueberschrift" sipa:toc="true">Überschrift</h2>

Wird dieses Attribut weggelassen, erscheint der Beitrag nicht in der Liste. Übrigens kann es auch auf andere HTML-Tags angewendet werden, auch wenn Überschriften die naheliegenden sind.

Übersicht über wichtige Attribute
Attribut Möglicher Wert Beschreibung
sipa:type "toc" Beitragstyp Inhaltsverzeichnis
sipa:tocloop "true" Sich wiederholender Bereich
sipa:evenclass alphanumerisch CSS-Klasse für jeden zweiten Eintrag
sipa:tocitem "true" Link für den Verzeichniseintrag
sipa:toc "true" Kennzeichnung der Überschrift