Wikipedia:Lua/Modul/Vorlage:Seitenbewertung/de

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

Modul: Dokumentation

Vorlage:Seitenbewertung (BadgesQuery) – Modul zur Abfrage auf Wikidata registrierter Auszeichnungen, insbesondere für Vorlage:Seitenbewertung.

Funktionen für Vorlagen

[Quelltext bearbeiten]
features
Generiere Verlinkung, ggf. mit Anzeige einer registrierten Seitenbewertung
Parameter des #invoke; optional wo nicht eingefordert:
1
Lokaler Seitenname, dessen Bewertung ermittelt werden soll
Vorgabe: aktuelle Seite
nsTransclude
Namensraum-Nummer einer einzubindenden Seite zur Ergebnisdarstellung
Vorgabe: 10 – „Vorlage“
sTransclude
Titel einer einzubindenden Seite zur Ergebnisdarstellung (Pflichtparameter)
link
1 – verlinke Seitennamen
long
1 – ausführliche Ergebnisdarstellung
px
Anzahl der Pixel eines Icons
space
CSS-Breitenabstand zwischen Seitenname und Bewertung
site
Datenbankname eines Wiki, in dem die Bewertung jener Seite ermittelt werden soll, die mit dem lokalen Seitennamen verknüpft ist
Vorgabe: (dewiki)
Rückgabewert: Verlinkung der Seite, ggf. mit Bewertung.
fulfils
Prüfe, ob fragliche Seite mit bestimmter Bewertung registriert ist
Parameter des #invoke:
1
Lokaler Seitenname, dessen Bewertung ermittelt werden soll
Vorgabe: aktuelle Seite
match
Leerzeichen-getrennte Liste der Item-Nummern, deren Zuordnung geprüft werden soll
site
Datenbankname eines Wiki, in dem die Bewertung jener Seite ermittelt werden soll, die mit dem lokalen Seitennamen verknüpft ist
Vorgabe: (dewiki)
Rückgabewert: 1 wenn Bewertung vergeben, sonst leer
failsafe
Versionsbezeichnung: 2022-10-19

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 »2022-10-19«
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 → »2022-10-19«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q114773646)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2022-10-19«
item ID des Wikidata-Items
  • leer, falls nicht definiert
»Q114773646«
~ Ü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.

Aus features wird eine Seite eingebunden, die die folgenden Parameterwerte erhält; mit fiktiven Beispielen:

  • subject=lokaler Seitenname
  • linked=1 falls link=1 außer selbst
  • space=2em
  • px=18
  • long=1
  • q17437796=1 – exzellent
  • q17437798=1 – lesenswert
  • q17506997=1 – informative Liste
  • q17580674=1 – informatives Portal
  • site=

Siehe beispielsweise: Vorlage:Seitenbewertung/Darstellung

Funktionen für Lua-Module

[Quelltext bearbeiten]

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

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

Danach stehen zur Verfügung:

BadgesQuery.features( arglist, frame )
  • arglist – table, mit allen Optionen ähnlich Vorlageneinbindung
    • subject – Lokaler Seitenname, string oder false
    • nsTranscludenumber
    • sTranscludestring (Pflicht)
    • linkboolean
    • longboolean
    • pxnumber
    • spacestring
    • sitestring
Rückgabewert: string mit Wikitext
BadgesQuery.fulfils( ask, array, another )
  • ask – string, mit lokalem Seitenbezeichner (optional), oder false
  • array – sequence table, mit number-Elementen
  • another – string, mit fremder Projekt-ID (optional)
Rückgabewert: boolean
BadgesQuery.failsafe( atleast )
Versionsbezeichnung
Rückgabewert: string oder false

Abhängigkeiten

[Quelltext bearbeiten]

Keine.