Wikipedia:Lua/Modul/Vorlage:DtRechtswörterbuch/de

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

Modul: Dokumentation

Vorlage:DtRechtswörterbuch – Modul zur Unterstützung der Vorlage:DtRechtswörterbuch.

Funktionen für Vorlagen

[Quelltext bearbeiten]
f
Bereite die Vorlageneinbindung auf.
Die Parameter der Vorlageneinbindung werden entgegegenommen. Sie werden analysiert und um zusätzliche Informationen angereichert, die sich mittels Vorlagenprogrammierung nur mühsam verwalten lassen.
Anschließend wird die Vorlage:DtRechtswörterbuch/core eingebunden, und ihr werden die angereicherten Informationen zur Formatierung übergeben.
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-05-13«
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-05-13«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q124723073)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2024-05-15«
item ID des Wikidata-Items
  • leer, falls nicht definiert
»Q124723073«
~ Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung
  • leer, falls aktuell
  • Versionsbezeichnung auf Wikidata, falls ungleich
»2024-05-15«
@ Ist die aktuelle (Modul-)Seite richtig mit Wikidata verknüpft?
  • leer, falls mit dem richtigen Item verknüpft
  • Item-ID, falls nicht
»Q124723073«
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false; andernfalls die angegebene Zeichenkette.

Funktionen für Lua-Module

[Quelltext bearbeiten]

Bislang eine der oben dokumentierten Funktionen könnte auch über require() in andere Module eingebunden werden:

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

Danach stehen zur Verfügung:

DRW.failsafe( atleast )
Versionsbezeichnung
  1. atleast
    optional
    nil oder Mindestversion
Rückgabewert: string oder false

Abhängigkeiten

[Quelltext bearbeiten]

Keine.