Vorlage:Abk/Doku

Beschreibung

Diese Vorlage dient dazu, Abkürzungen und Akronyme semantisch korrekt zu kennzeichnen. Beim Überfahren der Abkürzung mit der Maus (Mouseover) wird die vollständige Bedeutung als Tooltip angezeigt.

Sie basiert auf dem HTML5-Element <abbr>

, das speziell für diesen Zweck vorgesehen ist und die Barrierefreiheit verbessert.

Verwendung

Die Vorlage erwartet zwei Parameter: Zuerst die Abkürzung selbst, dann deren vollständige Bedeutung.

Syntax

Die grundlegende Syntax lautet: {{Abk|Abkürzung|Vollständige Bedeutung}}

• Parameter 1 (Abkürzung): Der Text der Abkürzung, der sichtbar auf der Seite erscheinen soll. Dies ist ein Pflichtparameter.
• Parameter 2 (Vollständige Bedeutung): Der Text, der als Tooltip beim Mouseover angezeigt wird. Dies ist ein optionaler Parameter.

Beispiele

Normalfall (beide Parameter vorhanden)

{{Abk|RAM|Random-Access Memory}} Wird zu: RAM

{{Abk|CPU|Central Processing Unit}} Wird zu: CPU

Nur Abkürzung (ohne explizite Bedeutung)

Wenn der zweite Parameter (Vollständige Bedeutung) weggelassen wird, wird die Abkürzung selbst als Tooltip verwendet. Dies kann nützlich sein, um eine Abkürzung technisch zu kennzeichnen, auch wenn keine längere Erklärung nötig ist.

{{Abk|FAQ|}} oder {{Abk|FAQ}} Wird zu: FAQ (Hier erscheint beim Mouseover über "FAQ" ebenfalls "FAQ".)

Fehlende Abkürzung (Fehlermeldung)

Wenn der erste Parameter (Abkürzung) fehlt, kann die Vorlage nichts Sinnvolles anzeigen und gibt eine Fehlermeldung aus.

{{Abk||Random-Access Memory}} Wird zu:

{{Abk}} Wird zu:

Verlinkung von Abkürzungen

Wenn die Abkürzung selbst ein Link sein soll, muss die Vorlage innerhalb der Link-Klammern stehen, nicht umgekehrt:

• Empfohlen: [[Random-Access Memory|{{Abk|RAM|Random-Access Memory}}]]

   Wird zu: RAM
   (Der Link und der Tooltip funktionieren beide korrekt.)

• Nicht empfohlen: {{Abk|[[RAM|RAM]]|Random-Access Memory}}

   (Dies führt zu fehlerhaftem HTML und kann dazu führen, dass der Tooltip in einigen Browsern nicht angezeigt wird.)

Technische Details

Die Vorlage verwendet das HTML5-Element <abbr> mit dem title-Attribut, um die Funktionalität zu gewährleisten. Intern sieht der generierte Code dann beispielsweise so aus: <abbr title="Random-Access Memory">RAM</abbr>

Sie nutzt zudem Parserfunktionen (#if:), um das Vorhandensein der Parameter zu prüfen und so eine robustere Fehlerbehandlung zu gewährleisten.