Wikipedia:Lua/Modul/Vorlage:OxfordDNB/de

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

Vorlage:OxfordDNB – Unterstützung der Vorlage:OxfordDNB.

Funktionen für Vorlagen

[Quelltext bearbeiten]
www
Weblink generieren
Parameter (optional):
id
Bezeichner
  • 109876
  • 101012345
  • 12/101012345
err
Fehlermeldungstext
cat
Titel einer Wartungskategorie
Rückgabewert
  • Weblink, oder Fehlermeldung bei ungültigem Bezeichner
  • leer sonst
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 »2024-03-08«
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 → »2024-03-08«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q124723080)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2024-03-08«
item ID des Wikidata-Items
  • leer, falls nicht definiert
»Q124723080«
~ Ü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.

Funktionen für Lua-Module

[Quelltext bearbeiten]

Zwei der oben dokumentierten Funktionen können auch über require() in andere Module eingebunden werden:

local lucky, OxfordDNB = pcall( require, "Module:Vorlage:OxfordDNB" )
if type( OxfordDNB ) == "table" then
    OxfordDNB = OxfordDNB()
else
    -- Fehlerfall; OxfordDNB enthält Fehlermeldung
    return "<span class=\"error\">" .. OxfordDNB .. "</span>"
end

Danach stehen zur Verfügung:

OxfordDNB.www( at, alert, assign )
Parameter wie für Vorlage
  1. at – id
    string
  2. alert – err
    kann string sein oder mw.html table
  3. assign – cat
    string
Rückgabewert:
  • string mit Weblink, oder Fehlermeldung, sonst false
OxfordDNB.failsafe( atleast )
Versionsbezeichnung
  1. atleast
    optional
    nil oder Mindestversion
Rückgabewert: string oder false

Abhängigkeiten

[Quelltext bearbeiten]
  • Keine