Glossar-Links erzeugen
Wenn die Länge einer Webseite nachrangig und/oder die Anzahl Glossareinträge überschaubar ist, kann mit der Funktion dir und einem Modul ein leicht pflegbares Glossar angelegt werden.
Glossar-Einträge
Dafür werden einzelne Dateien in einem eigenständigen Verzeichnis mit
Das „Glossar-Verzeichnis“ muss einen Namen sehr weit vorn im Alphabet habe,. damit es beim „Projekt neu generieren“ als erstes eingelesen wird.
Das ist notwendig, damit bei späteren Erzeugen der eigentlichen Glossar-Seite die Einträge vorhanden sind, die dort eingefügt werden sollen.
Die „Glossar-Einträge-Dateien“ haben haben kein Layout. Ohne Layout werden „HTML-Schnipsel“ erzeugt, die in bestehende HTML-Seiten eingefügt werden können.
Für den Eintrag selbst ist relevant, dass er eine Überschrift hat, die einen ID erzeugt – was bei Überschriften der Fall ist. Länge und Gestaltung des Eintrags ist beliebig.
- Buchstaben vorweg?
-
Dafür werden Dateien angelegt, die lediglich die Buchstaben als Überschriften enthalten. Sie müssen mit dem jeweiligen Buchstaben, gefolgt von einer Serie „aaaaa“ benannt sein.
Grundsätzlich würde als Dateiname der jeweilige Buchstabe ausreichen, doch
Die Glossar-Seite
Diese Seite nutzt die Funktion dir zum Einlesen der Glossar-Einträge. Zusätzlich kann die Darstellung mit einem nur auf dieser Seite gültigen Stil angepasst werden:
<style>.glossmod h1{border-top:0.1rem solid grey;margin-top:1em;}</style>
::: glossmod
$$$ dir a : /grundlagen/glossary/ $$$
:::
Diese Variante bindet die „HTML-Schnipsel“ statisch in die erzeugte Webseite ein.
Auf einem Server kann das mit einem PHP-Skript dynamisch erfolgen, womit sich die Aktualisierung der Glossar-Seite erübrigt. Dieses Skript könnte darüber hinaus dynamisch nur für vorhandene Anfangsbuchstaben „Buchstaben-Einträge“ erzeugen. Insbesondere für ein umfangreicheres Glossar kann es die Anzeige auf Buchstaben begrenzen, die z.B. am Seitenanfang angewählt werden.
Diese Lösung erfordert ein angepasstes Modul, das z.B. auf „Buchstabenseiten“ im Glossar verweist.
Das Modul
Ein HTML-Eintrag, der einem Suchbegriff den Namen der Glossar-Seite voranstellt und dort den auf der Seite erzeugten ID anspringt, macht ein nutzbares Glossar vollständig.
glo "verlinkt=" "suchid="
<span class="gloss"><a title="Im Glossar nachschlagen" href="/grundlagen/glossar#§§§suchid§§§">§§§verlinkt§§§</a></span>
Das Modul fordert zwei Elemente:
- verlinkt
-
Das ist der Text, zu dem ein Glossar-Eintrag angeboten wird. Der kann identisch damit sein, doch häufig ist er nur ähnlich.
- suchid
-
Der Glossareintrag, genauer: die ID davon. Sie kann ggf. durch kopieren aus der (bereits vorhandenen) Glossarseite mit dem Befehl ID/Dateiname erzeugt werden.
- „Schön machen“
-
Für Nutzende des Glossars ist es hilfreich, den Eintrag beim Hingehen mit etwas CSS hervorzuheben.