Wikipedia:Lua/Modul/Vorlage:Handle

Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English Modul: Dokumentation

Vorlage:Handle – Modul zum Generieren betitelter Weblinks auf Ressourcen im Internet mittels eines Solvers über Vorlagen.

Vorlage:Handle ist eine virtuelle Vorlage mit zwei konkreten Instanzen in der deutschsprachigen Wikipedia:

Funktionen für Vorlagen

f
Formatieren.
Parameter der Vorlageneinbindung; alle optional:
1
Parameterwert (DOI oder Handle)
  • Spezifikation nach dem Schrägstrich darf URL- und HTML-escaped sein.
Alternativ:
Resultat eines früheren Aufrufs; mit URL oder Fehlermeldung oder als Wikilink; auch nichts.
Problem
1 – zeige einen Hinweis auf vorübergehende Nichterreichbarkeit
NoCat
1 – unterdrücke Einordnung in Fehlerkategorie errCat.
demo
1 – unterdrücke jede Ausblendung von Fehlermeldungen, etwa im Zusammenhang mit Dokumentationen
Parameter des #invoke zur projektspezifischen Anpassung; bis auf scheme alle optional:
scheme
Code des Anwendungsmodus; Pflichtparameter:
  • doi
  • hdl
errCat
Titel einer Fehlerkategorie bei ungültigem Parameterwert etc.
errClasses
Klassen, in die eine Fehlermeldung eingeordnet werden soll, etwa error
errHide
1 – verstecke standardmäßig Fehlermeldungen
errNS
Leerzeichen-getrennte Liste von Namensraum-Nummern, auf die die errCat beschränkt sein soll.
Vorgabe: In allen Namensräumen errCat auswerfen.
parProblem
Name des „Problem“-Parameters – Vorgabe: problem
showArticle
Seitenname des verlinkten Schemas
  • doi: – Vorgabe: Digital Object Identifier
  • hdl: – Vorgabe: keine
Leere Angabe: Schema nicht verlinken
Rückgabewert: Verlinkung; oder Fehlermeldung, ggf. als class="error".
failsafe
Versionsbezeichnung

Die Failsafe-Schnittstelle erlaubt den damit ausgerüsteten Modulen in globaler Verteilung

  • sicherzustellen, dass eine von einer Vorlage oder einem Modul benötigte Funktion in der lokalen Kopie eines Bibliotheksmoduls vorhanden ist, und ggf. auch in einer erforderlichen Mindestversion;
  • die globale Aktualisierung und Verknüpfung von Modulen über Wikidata zu verwalten.

Die Failsafe-Schnittstelle liegt sowohl auf Ebene der Vorlagen wie auch in direktem Lua-Zugriff vor.

Die Funktionen sind im Einzelnen (nicht alle werden bereits überall in vollem Umfang unterstützt):

Parameter
Wert Ergebnis aktuell
nichts
false
lokale Version »2026-01-29«
Mindest­version Mindestversionsbezeichnung
Datum im ISO-Format

Es wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.

  • leer, falls Mindestversion nicht erfüllt
  • 2001-01-01 → »2026-01-29«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q19644424)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2026-01-29«
item ID des Wikidata-Items
  • leer, falls nicht definiert
»Q19644424«
~ Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung
  • leer, falls aktuell
  • Versionsbezeichnung auf Wikidata, falls ungleich
»«
@ Ist die aktuelle (Modul-)Seite richtig mit Wikidata verknüpft?
  • leer, falls mit dem richtigen Item verknüpft
  • Item-ID, falls nicht
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false; andernfalls die angegebene Zeichenkette.

Verwendung

Ausschließlich in:


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Vorlage:Handle | Funktionsname | Wert1 | Wert2 | NameX=Wert … }}

Die Parameter können wie bei Vorlagen benannt oder unbenannt sein; deren Regeln gelten analog.

Wenn unbekannte Zeichenketten von außen kommen (als Vorlagenparameter), sollte immer mit der Form 1=Wert gearbeitet werden.

Zu allgemeinen Problemen beachte die Abhilfen wie bei Vorlagen.

Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer die Vorlage:Dokumentation/Lua in der Dokumentationsseite eingebunden werden.

  1. Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
  2. Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
  3. Die Vorlage wird zur Übersicht kategorisiert in Kategorie:Vorlage:mit Lua-Programmierung.

Zu weiteren Informationen siehe Hilfe:Lua.

Bei Problemen wende dich bitte an die Vorlagen-Werkstatt, in schweren Fällen hilft auch die Lua-Werkstatt.