Einfaches Verschlagworten von Webseiten mit dem Admin-Tool dbGlossary

Mit dem Admin-Tool dbGlossary lassen sich sehr einfach und bequem Abkürzungen, Akronyme, Fachbegriffe sowie Querverweise anlegen und verwalten.

Das Tool unterstützt Redakteure und Webmaster bei der Verschlagwortung von Webseiten.

Systemvoraussetzungen:

• Website Baker 2.8
• PHP 5.2 oder höher
• dbConnect installiert
• rhTools installiert

Download:

• dbGlossary

Während der Installation patched dbGlossary den Ausgabefilter von Website Baker um seine eigene Filterroutine einzufügen.

Sie erhalten eine Meldung, ob der Patch erfolgreich angewendet werden konnte. Die Installationsroutine sichert den ursprünglichen Ausgabefilter unter original-dbglossary-filter-routines.php im Verzeichnis /modules/output_filter/.

Bei einer Deinstallation von dbGlossary wird der ursprüngliche Ausgabefilter wieder hergestellt.

Sollte die automatische Aktualisierung fehlschlagen, führen Sie die Aktualisierung bitte von Hand durch. Hierzu öffnen Sie den Ausgabefilter filter-routines.php im Verzeichnis /modules/output_filter/ und ändern Sie ab Zeile 55:

// function to filter the output before displaying it on the frontend
if (!function_exists('filter_frontend_output')) {
    function filter_frontend_output($content) {

        // get output filter settings from database
        $filter_settings = get_output_filter_settings();

den Ausgabefilter zu:

// function to filter the output before displaying it on the frontend
if (!function_exists('filter_frontend_output')) {
    function filter_frontend_output($content) {

        // exec dbGlossary filtering 
        if(file_exists(WB_PATH .'/modules/dbglossary/class.filter.php')) { 
            require_once (WB_PATH .'/modules/dbglossary/class.filter.php'); 
            $content = parseGlossary($content); 
        }
 
        // get output filter settings from database
        $filter_settings = get_output_filter_settings();

Damit ist dbGlossary einsatzbereit.

 

Erste Schritte mit dbGlossary

Bitte öffnen Sie nun im Backend über die Admin-Tools die Verwaltungsoberfläche von dbGlossary. Wenn noch kein Stichwort eingetragen ist, wird Ihnen automatisch die Hilfeseite angezeigt.

Wählen Sie den Reiter Bearbeiten.

Sie befinden sich in einem Dialog zum Erstellen eines neuen Eintrag für dbGlossary.

In unserem ersten Beispiel verwenden wir die Abkürzung CMS, die für Content Management System steht.

Tragen Sie als Stichwort CMS ein.

Bei Erläuterung tragen Sie entsprechend Content Management System ein.

Bei Stichwort Typ stehen Ihnen mehrere Möglichkeiten zur Auswahl:

• eine Abkürzung, zum Beispiel z.B.,
• ein Akronym. Akronyme sind Kurzworte, die aus den Anfangsbuchstaben mehrerer Wörter zusammengesetzt sind, wie USA, das sich aus United States of America bildet,
• ein Stichwort (Fachbegriff), dieser Typ steht in der Variante TEXT (keine Formatierungen) und HTML zur Verfügung,
• ein Querverweis (Hyperlink),
• ein dbGlossary: Verweis, dies ist ein spezieller Typ auf den wir noch genauer eingehen werden.

Wählen Sie als Stichwort Typ bitte Abkürzung aus.

Mehr ist für die Erstellung eines Stichwort vom Typ Abkürzung nicht erforderlich. Klicken Sie auf Übernehmen, übernimmt dbGlossary das neue Stichwort und wechselt zur Listenansicht.

Jetzt möchten Sie natürlich ein praktisches Anwendungsbeispiel für das Stichwort CMS ausprobieren.

Erstellen Sie hierzu eine neue Seite vom Typ WYSIWYG und tragen Sie als Text bitte:

Das CMS Website Baker zeichnet sich durch eine einfache Bedienung aus.

ein.

Damit dbGlossary aktiv werden kann, müssen Sie die entsprechenden Stichworte kennzeichnen. Dies erreichen Sie, in dem Sie das jeweilige Stichwort (das durchaus auch aus mehreren Worten bestehen kann) mit je zwei senkrechten Strichen, sogenannten Pipes umfassen: CMS.

Ändern Sie den Text entsprechend in:

und speichern Sie die Seite.

Das Ergebnis sieht für die Besucher Ihrer Website so aus:

Das CMS Website Baker zeichnet sich durch eine einfache Bedienung aus.

 

Die Unterschiede zwischen Abkürzungen, Akronymen, Stichworten und Querverweisen

Es wird gerne vergessen, dass HTML eine Auszeichnungssprache ist, die ursprünglich für die Typisierung von wissenschaftlichen Texten entwickelt wurde. In der heutigen Zeit wird HTML bzw. XHTML allerdings auf Millionen von Webseiten ausschließlich für die Darstellung von Inhalten verwendet.

Wenig überraschend ist, dass HTML über unterschiedliche Tags für Abkürzungen <abbr> und Akronyme <acronym> verfügt, allerdings sucht man vergeblich nach einem Tag für die Auszeichnung von Fachbegriffen oder Stichworten.

"Das ist doch egal" wird vielleicht der eine oder andere Leser sagen, "wen interessiert das schon?".

Es interessiert auf jeden Fall Personen, die auf Screenreader angewiesen sind oder die entsprechenden Informationen auswerten, insbesondere Sehbehinderte, ältere Menschen und Suchmaschinen. 

Eine korrekte Auszeichnung von Abkürzungen und Akronymen sorgt dafür, dass ein Screenreader Texte flüssig und verständlich vorlesen kann.

dbGlossary sorgt "on the fly" für die korrekte Auszeichnung. So wird aus unserem Einstiegsbeispiel mit der Abkürzung CMS bei der Ausgabe:

<abbr title="Content Management System">CMS</abbr>

Aus einem Akronym, z.B. USA wird:

<acronym title="United States of America">USA</acronym>

und ein Stichwort oder einen Fachbegriff, z.B. SQL Injection setzt dbGlossary in: 

<span class="stichwort_text" title="SQL Einschleusung über eine Sicherheitslücke">SQL Injection</span>

um. Ein Querverweis wird als Hyperlink ausgegeben, wenn Sie zusätzlich eine Erläuterung mit angegeben haben, fügt dbGlossary einen title Tag in den Hyperlink ein, z.B. bei HTML:

<a href="http://de.wikipedia.org/wiki/Html" target="_blank" title="Hypertext Markup Language">HTML</a>

Die Templates, die dbGlossary hierfür verwendet finden Sie bei den Einstellungen, für Querverweise wird

<a href="{link}" target="{target}" title="{explain}">{catchword}</a>

verwendet. Die Platzhalter stehen in geschweiften Klammern und bedeuten:

• {catchword} - das verwendete Stichwort, "HTML"
• {explain} - die Erläuterung zu dem Stichwort, "Hypertext Markup Language" 
• {link} - der Querverweis zu dem Stichwort, "http://de.wikipedia.org/wiki/Html"
• {target} - das Verweisziel, "_blank"

Die Formatierung erfolgt über die screen.css des Templates, das Sie für Ihre Website verwenden. Auf der phpManufaktur ist für die Formatierung der Stichworte eingetragen:

abbr {
  cursor: help;
  border-bottom: 1px dotted #da251d;
}
acronym {
  cursor: help;
  border-bottom: 1px dotted #da251d;
}
.stichwort_text {
  cursor: help;
  border-bottom: 1px dotted #da251d;
}

Diese Vorgaben sorgen dafür, dass die Stichworte mit einer gepunkteten roten Linie unterstrichen sind und sich beim Überfahren der Cursor in ein Fragezeichen verwandelt. Die Verwendung des title Tag sorgt dafür, dass beim Überfahren mit dem Mauszeiger ein Tooltip mit der jeweiligen Erläuterung angezeigt wird.

Automatisches Erzeugen von Stichwortlisten (Glossar)

dbGlossary installiert zwei Droplets:

• glossary_list - erzeugt automatisch Stichwortlisten
• literature_list - erzeugt automatisch Literaturlisten

Das Glossar auf der phpManufaktur Website wird ebenfalls mit dem Droplet glossary_list erzeugt.

Die Handhabung ist sehr einfach: wenn Sie

• eine vollständige Liste aller Stichworte,
• die alphabetisch sortiert ist und
• über ein A-Z Register verfügt

erstellen möchten, brauchen Sie nur an der gewünschten Stelle, das Droplet [[glossary_list]] einzufügen.

Das Droplet kennt drei Parameter, über die es gesteuert werden kann:

[[glossary_list?link_intern=1&link_extern=1,groups=one,two]]

• link_intern - erlaubt das Ein- bzw. Ausschalten von internen Querverweisen (Typ: dbGlossary: Verweis)
• link_extern - erlaubt das Ein- bzw. Ausschalten von externen Querverweisen, z.B. auf Wikipedia
• groups - erlaubt das Auswählen von bestimmten Gruppen, haben Sie z.B. für Querverweise auf Wikipedia eine entsprechende Gruppe angelegt, können Sie die Ausgabe des Glossars auf die Gruppe Wikipedia beschränken.

Wenn Sie das A-Z Register nicht anzeigen möchten, können Sie es über die Einstellungen von dbGlossary und dort den Eintrag A-Z Tabs verwenden ausschalten.

Bei den Tipps & Tricks finden Sie einen Artikel.der Ihnen beschreibt, wie Sie mit dbGlossary Fußnoten und Literaturverweise organisieren und verwalten können.

Diese Seite befindet sich noch im Aufbau, ich bitte um Verständnis!

Ralf Hertsch, 11.09.2009