Zum Inhalt springen

„Wikipedia:Lua/Modul/Vorlage:Seitenbewertung/de“ – Versionsunterschied

aus AufEinWort, der freien Forschung
AZ: Die Seite wurde neu angelegt: {{SeitenordnungWP.de | PageID = {{subst:PAGEID}} | Obereinordnung1 = MW-Verwaltung }}
 
KKeine Bearbeitungszusammenfassung
 
Zeile 1: Zeile 1:
{{SeitenordnungWP.de
{{SeitenordnungWP.de
| PageID = 0
| PageID = 93513
| Obereinordnung1 = MW-Verwaltung
| Obereinordnung1 = MW-Verwaltung
}}
}}
{{LuaModuleDoc}}
<onlyinclude>'''<code>Vorlage:Seitenbewertung</code>''' (<code>BadgesQuery</code>) – Modul zur Abfrage auf Wikidata registrierter [[:Kategorie:Wikipedia:Bewertung|Auszeichnungen]], insbesondere für [[Vorlage:Seitenbewertung]].
== {{Anker|Vorlage}} Funktionen für Vorlagen ==
; features  {{Anker|features}}
: Generiere Verlinkung, ggf. mit Anzeige einer registrierten Seitenbewertung
: ''Parameter des'' <code>#invoke</code>''; optional wo nicht eingefordert:''
::; 1
::: Lokaler Seitenname, dessen Bewertung ermittelt werden soll
::: ''Vorgabe:'' aktuelle Seite
::; nsTransclude
::: Namensraum-Nummer einer einzubindenden Seite zur Ergebnisdarstellung
::: ''Vorgabe:'' <code>10</code> – „Vorlage“
::; sTransclude
::: Titel einer [[#Darstellung|einzubindenden Seite zur Ergebnisdarstellung]] ''(Pflichtparameter)''
::; link
::: <code>1</code> – verlinke Seitennamen
::; long
::: <code>1</code> – ausführliche Ergebnisdarstellung
::; px
::: Anzahl der Pixel eines Icons
::; space
::: CSS-Breitenabstand zwischen Seitenname und Bewertung
::; site
::: [[Wikipedia:Technik/MediaWiki/Datenbankname|Datenbankname]] eines Wiki, in dem die Bewertung jener Seite ermittelt werden soll, die mit dem lokalen Seitennamen verknüpft ist
::: ''Vorgabe:'' (<code>dewiki</code>)
: ''Rückgabewert:'' Verlinkung der Seite, ggf. mit Bewertung.
; fulfils  {{Anker|fulfils}}
: Prüfe, ob fragliche Seite mit bestimmter Bewertung registriert ist
: ''Parameter des'' <code>#invoke</code>'':''
::; 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
::: [[Wikipedia:Technik/MediaWiki/Datenbankname|Datenbankname]] eines Wiki, in dem die Bewertung jener Seite ermittelt werden soll, die mit dem lokalen Seitennamen verknüpft ist
::: ''Vorgabe:'' (<code>dewiki</code>)
: ''Rückgabewert:'' <code>1</code> wenn Bewertung vergeben, sonst leer
; failsafe  {{Anker|failsafe}}
: Versionsbezeichnung: <code>{{#invoke:Vorlage:Seitenbewertung|failsafe}}</code>
{{Wikipedia:Lua/Modul-Failsafe|Modul=Vorlage:Seitenbewertung}}
== Darstellung ==
Aus <code>[[#features|features]]</code> wird eine Seite eingebunden, die die folgenden Parameterwerte erhält; mit fiktiven Beispielen:
* <code>subject=</code>''lokaler Seitenname''
* <code>linked=1</code> falls <code>link=1</code> außer selbst
* <code>space=2em</code>
* <code>px=18</code>
* <code>long=1</code>
* <code>q17437796=1</code> – exzellent
* <code>q17437798=1</code> – lesenswert
* <code>q17506997=1</code> – informative Liste
* <code>q17580674=1</code> – informatives Portal
* <code>site=</code>
Siehe beispielsweise: [[Vorlage:Seitenbewertung/Darstellung]]
== Verwendung ==
* [[Vorlage:Seitenbewertung]]
</onlyinclude>
== {{Anker|Lua}} Funktionen für Lua-Module ==
Die oben dokumentierten Funktionen können auch über <code>require()</code> in andere Module eingebunden werden:
<syntaxhighlight lang="lua">
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
</syntaxhighlight>
Danach stehen zur Verfügung:
; BadgesQuery.[[#features|features]]( arglist, frame )
:* arglist – ''table'', mit allen Optionen ähnlich Vorlageneinbindung
:** <code>subject</code> – Lokaler Seitenname, ''string'' oder <code>false</code>
:** <code>nsTransclude</code> – ''number''
:** <code>sTransclude</code> – ''string (Pflicht)''
:** <code>link</code> – ''boolean''
:** <code>long</code> – ''boolean''
:** <code>px</code> – ''number''
:** <code>space</code> – ''string''
:** <code>site</code> – ''string''
: Rückgabewert: ''string'' mit Wikitext
; BadgesQuery.[[#fulfils|fulfils]]( ask, array, another )
:* ask – ''string'', mit lokalem Seitenbezeichner ''(optional)'', oder <code>false</code>
:* array – sequence ''table'', mit ''number''-Elementen
:* another – ''string'', mit fremder Projekt-ID ''(optional)''
: Rückgabewert: ''boolean''
; BadgesQuery.[[#failsafe|failsafe]]( atleast )
: Versionsbezeichnung
: Rückgabewert: ''string'' oder <code>false</code>
== Abhängigkeiten ==
Keine.
[[Kategorie:Wikipedia:Lua/Modul/Dokumentation|Vorlage:Seitenbewertung]]

Aktuelle Version vom 3. Oktober 2026, 17:53 Uhr

WP

Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation
Weiterleitung der Diskussionsseite fehlt

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

Funktionen für Vorlagen

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
»2022-10-19«
@ 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.

Darstellung

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

Verwendung

Funktionen für Lua-Module

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
    • nsTransclude – number
    • sTransclude – string (Pflicht)
    • link – boolean
    • long – boolean
    • px – number
    • space – string
    • site – string
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

Keine.