Simpsonspedia

Simpsonspedia:Lua/Modul/MediaWikiGadgetDefinition/de

< Simpsonspedia:Lua‎ | Modul‎ | MediaWikiGadgetDefinition
Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

MediaWikiGadgetDefinition – Modul zur Dokumentation, Validierung und zu Vergleich von MediaWiki Gadget Definitionen.

Funktionen für Vorlagen

f
Parameter: #invoke (alle optional)
  • Build – Ausgabeformat
    • ROWS – klassische Definitionszeilen
    • HTML (Vorgabe)
    • JSON
  • ExportLink
    1 – Verlinkungen auf Exportvariante der Spezialseite generieren.
  • ID
    falls nicht über TEMPLATE=1 spezifiziert
  • StrictRows
    1 – Strikte Syntax für klassische Definitionszeilen
  • Use
  • TEMPLATE
    1 – ein Parametersatz wird aus der Vorlageneinbindung bezogen.
  • IGNORE
    Durch Pipe getrennte Liste zusätzlicher Parameternamen in der Vorlageneinbindung, die ignoriert werden sollen.
Rückgabewert: Wikitext, HTML-Code, klassische Definitionszeilen, JSON.
params
Liste der möglichen Parameter, als HTML-Element <ul>
Parameter: Keine.
suggestedvalues
Liste der möglichen Parameter, geeignet für TemplateData, als JSON-Array
Parameter: Keine.
failsafe

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

Verwendung

  • Projektseiten zu Gadgets.

Funktionen für Lua-Module

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

local lucky, GadgetDef = pcall( require, "Modul:MediaWikiGadgetDefinition" )
if type( GadgetDef ) == "table" then
    GadgetDef = GadgetDef()
else
    -- Fehlerfall; GadgetDef enthält Fehlermeldung
    return '<span class="error">' .. GadgetDef .. '</span>'
end

Danach stehen folgende Funktionen zur Verfügung:

  • GadgetDef.f()
  • GadgetDef.params()
  • GadgetDef.suggestedvalues()
Abgerufen von „https://simpsonspedia.net:443/index.php?title=Simpsonspedia:Lua/Modul/MediaWikiGadgetDefinition/de&oldid=329231“