Wikipedia:Lua/Modul/Vorlage:Seitenbewertung/de
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):
Wert | Ergebnis | aktuell |
---|---|---|
nichtsfalse
|
lokale Version | »2022-10-19« |
Mindestversion | Mindestversionsbezeichnung Datum im ISO-Format Es wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.
|
|
wikidata
|
Versionsbezeichnung der globalen Mutter (d:Q114773646)
|
»2022-10-19« |
item
|
ID des Wikidata-Items
|
»Q114773646« |
~
|
Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung
|
»« |
@
|
Ist die aktuelle (Modul-)Seite richtig mit Wikidata verknüpft?
|
|
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false ; andernfalls die angegebene Zeichenkette.
|
Darstellung
[Quelltext bearbeiten]Aus features
wird eine Seite eingebunden, die die folgenden Parameterwerte erhält; mit fiktiven Beispielen:
subject=
lokaler Seitennamelinked=1
fallslink=1
außer selbstspace=2em
px=18
long=1
q17437796=1
– exzellentq17437798=1
– lesenswertq17506997=1
– informative Listeq17580674=1
– informatives Portalsite=
Siehe beispielsweise: Vorlage:Seitenbewertung/Darstellung
Verwendung
[Quelltext bearbeiten]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 oderfalse
nsTransclude
– numbersTransclude
– string (Pflicht)link
– booleanlong
– booleanpx
– numberspace
– stringsite
– string
- arglist – table, mit allen Optionen ähnlich Vorlageneinbindung
- 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)
- ask – string, mit lokalem Seitenbezeichner (optional), oder
- Rückgabewert: boolean
- BadgesQuery.failsafe( atleast )
- Versionsbezeichnung
- Rückgabewert: string oder
false
Abhängigkeiten
[Quelltext bearbeiten]Keine.