Wikipedia: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-11-15«
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-11-15« 2099-01-01 → »«
wikidata	Versionsbezeichnung der globalen Mutter (d:Q111520596) Versionsbezeichnung auf Wikidata lokal, falls dort keine gefunden	»2024-11-15«
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	»«
@	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

• Projektseiten zu Gadgets.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: MediaWikiGadgetDefinition | 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.