Die Auszeichnung von in textlichen Inhalten verwendeten Abkürzungen und Akronymen^[1] ist ein wesentliches Merkmal von benutzerfreundlichen Seiten. Gleichzeitig ist es eine zu erfüllende Anforderung, möchte man Inhalte BITV-konform ^[2] gestalten.

Abkürzungen und Akronyme, die sie hier anlegen, stehen Ihnen überall dort zur Verfügung, wo Inhalte ausgezeichnet werden können.

Zusätzlich zur Auszeichnung der Inhalte mit dem entsprechenden HTML Tag kann aus den angelegten Abkürzungen/Akronymen ein Abkürzungverzeichnis/Glossar erstellt werden, das mit wenigen Zeilen über ein Smarty-Plugin (s. unten Abschnitt 5.7.4, „Ausgabe Glossar“) in die Seitenvorlagen eingefügt wird. Da beispielsweise Screenreader den title-Tag unterschiedlich behandeln oder gar ignorieren, ist ein Glossar/Abkürzungsverzeichnis eine technische Möglichkeit, die Ausschreibung und weitere Erläuterung einer Abkürzung den Benutzern dieses Ausgabemediums zugänglich zu machen.

Die Verwaltung der Abkürzungen erfolgt im Administrationsbereich unter Inhalte im Unterpunkt Abkürzungen. Wenn Sie dort auf den Link Neu anlegen klicken, gelangen Sie zum Formular zum Anlegen einer neuen Abkürzung.

Abbildung 5.17. Abkürzungen anlegen

Zum Bearbeiten einer Abkürzung klicken Sie bitte in der entsprechenden Zeile auf der Übersichtsseite der Abkürzungen auf den Button Bearbeiten, um zu den Eingabefeldern des gewählten Eintrages zu gelangen.

Anmerkung

Wenn Sie eine bestehende Abkürzung bearbeitet haben, muss den inhaltlichen Seiten, in denen die Abkürzung verwendet wird, mitgeteilt werden, dass sich der Inhalt und unter Umständen die Syntax der Einbindung geändert hat. Die Aktualisierung der Seiteninhalte findet nicht automatisch statt. Hierzu gibt es im Adminstrationbereich Einstellungen das Untermenü Aktionen. Dort können Sie mit einem Klick auf den Button Ausführen der entsprechenden Funktion (Abschnitt 8.5.2.2, „Abkürzungen und Glossar anwenden“) alle Inhalte zeitgleich aktualisieren.

Die Verwendung der Abkürzungen ist überall dort möglich, wo Inhalte ausgezeichnet werden können. Das Menü zur Auswahl der Abkürzung, die benutzt werden soll, kann über den Menüpunkt Abkürzungen oberhalb des jeweiligen Inhaltsbereiches aufgerufen werden. Die vorhandenen Abkürzungen werden in einem Popup-Fenster alphabetisch sortiert aufgelistet und lassen sich mit einem Klick auf den Namen der gewünschten Abkürzung auswählen. Die Abkürzung wird daraufhin an der Stelle des Cursors in den Inhaltsbereich eingesetzt.

Abbildung 5.18. Abkürzung einsetzen

Um eine inhaltsnahe Bearbeitung zu ermöglichen, können Sie in diesem Fenster ebenfalls neue Abkürzungen anlegen. Diese stehen nach dem Speichern sofort zur Auswahl bereit. Zum Bearbeiten einer in diesem Fenster neu angelegten Abkürzung wechseln Sie bitte in den Administrationsbereich Abkürzungen (siehe Abschnitt 5.7.2, „Verwaltung“).

Abbildung 5.19. Abkürzung auswählen und/oder anlegen

Welcompose ermöglicht es ohne viel Aufwand ein Glossar/Abkürzungsverzeichnis aus den Abkürzungen zu erstellen, die einen Eintrag im Feld Glossar haben.

Ein Glossar/Abkürzungsverzeichnis ist in der Regel eine normale inhaltliche Seite (Typ: Simple Page), die auch über die Navigation erreichbar ist. Da die Glossarseite einmalig ist und sich in der Inhaltsdarstellung von anderen Seiten gleichen Typs unterscheidet, legen wir somit nachfolgend eine neue Vorlagengruppe, eine neue Seitenvorlage und zuletzt die inhaltliche Seite an.

Legen Sie zuerst eine neue Vorlagengruppe an. Gehen Sie hierzu zum Bereich Vorlagen und dort in das Untermenü Vorlagengruppen. Klicken Sie auf Neu hinzufügen, geben dort den Namen (bspw. Glossar) an und eventuell eine Beschreibung. Speichern Sie die neue Vorlagengruppe. Wechseln Sie nun in das Untermenü Seitenvorlagen. Dort legen Sie eine neue Seitenvorlage vom Typ simple_page_index an oder duplizieren eine schon bestehende Vorlage, die diesem Typ entspricht.

Benennen Sie die Vorlage um und wählen im Feld Vorlagengruppe die zuvor neu angelegte Vorlagengruppe aus.

Für die Ausgabe eines Glossar/Abkürzungverzeichnisses liefert Welcompose ein Smarty Plugin bereits mit. Das Glossar Plugin erzeugt automatisch eine alphabetische Linkleiste, setzt korrespondierende Ankerlinks und gibt die Inhalte der Abkürzung aus. Dem Prinzip von Welcompose folgend, findet keine Vorformatierung der Ausgabe statt, so dass Sie vollständig frei sind, die Ausgabe zu gestalten.

Smarty Plugin Get Glossary:

{* Smarty Get Glossary Plugin mit Parameter Action "pager" *}
{get_glossary var="glossary" action="pager"}

{* Smarty Get Glossary Plugin mit Parameter Action "content" *}
{get_glossary var="glossary" action="content"}

Das Plugin erwartet zwingend die Angabe zweier Parameter. Die Werteangabe des Parameter var ist frei wählbar. Der Parameter action erwartet entweder die Angabe pager oder content. Setzen Sie den Wert auf pager um die alphabetische Linkleiste zum Navigieren des Glossar auszulesen. Mit dem Wert content stellt das Plugin die Inhalte der Abkürzungstabelle zur Verfügung.

{* Smarty Get Glossary Plugin :: Linkleiste *}
{get_glossary var="glossary" action="pager"}

<ul>
{foreach item="_glossary" from=$glossary}
{if !empty($_glossary.has_link)}
  <li><a href="#{$_glossary.char}">{$_glossary.char}</a></li>
{else}
  <li>{$_glossary.char}</li>
{/if}
{/foreach}
</ul>

{* Smarty Get Glossary Plugin :: Ausgabe der Abkürzungstabelle *}
{get_glossary var="glossary" action="content"}

<dl>
{foreach item="_glossary" from=$glossary}
{if !is_null($_glossary.anchor)}
<h3>{$_glossary.anchor}<a id="{$_glossary.anchor}" name="{$_glossary.anchor}"></a></h3>
{/if}
  <dt>{$_glossary.name}<a id="{$_glossary.name}" name="{$_glossary.name}"></a></dt>
  <dd>{$_glossary.long_form}</dd>
  <dd>{$_glossary.content}</dd>
{/foreach}
</dl>

Speichern Sie die Seitenvorlage und gehen zum Adminstrationsbereich Inhalte und dort zum Untermenü Seiten um an gewünschter Stelle eine neue Seite für das Glossar anzulegen. Wählen Sie für die neue Seite als Vorlagengruppe die zuvor angelegte und zugewiesene Gruppe aus (Glossar). Speichern Sie die Seite.

Damit ist die Erstellung des Glossar abgeschlossen.