Wikipedia:Lua/Modul/Vorlage:Auflistung/de

Vorlagenprogrammierung	Diskussionen	Lua			Unterseiten
		Modul	Deutsch	English	Modul:	Dokumentation

Vorlage:Auflistung – Modul zur Anzeige horizontaler Aufzählungen (Fließtext-Form) mit Trennzeichen; dabei auch Unterstützung der {{Auflistung}}.

Funktionen für Vorlagen

f

Aufzählung darstellen.

1

Auflistung der Elemente, jede Zeile beginnend mit einem Sternchen * (ggf. #)

Gibt es nur ein Element, wird auch keine zusätzliche Dekoration generiert.

nowrap

1 – Jedes Element umbruchgeschützt

sep

Inhalt eines Separator-<span> zwischen den Elementen

(wird für Screenreader unterdrückt)

prefix

Vorspann

styles

Name einer TemplateStyles-Seite

classesBlock

Klassen für die gesamte Aufzählung

classesNowrap

Klassen für umbruchgeschütztes Element

classesPrefix

Klassen für Vorspann

classesSep

Klassen für ein Separator-<span>

style

CSS-Deklarationen für die gesamte Aufzählung

id

Fragmentbezeichner für die gesamte Aufzählung

lang

Sprachcode für die gesamte Aufzählung

failsafe

Versionsverwaltung

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

• Vorlage:Auflistung
• Beliebige weitere Vorlagen und Module.

Funktionen für Lua-Module

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

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

Danach stehen zur Verfügung:

Auflistung.f( all, altogether, access, alien, apart, frame )

Aufzählung aus Wikitext darstellen.

• all – string, mit Wikitext; jede Zeile beginnend mit * oder #
• altogether – boolean, um jedes Element umbruchgeschützt darzustellen
• access – string, mit Fragmentbezeichner, sofern gewünscht
• alien – string, mit Sprachcode, sofern gewünscht
• apart – string, für Separator-<span> zwischen den Elementen, sofern gewünscht
• frame – Objekt, falls zur Hand

Rückgabewert: Zeichenkette

Auflistung.fiat( all, advance, ahead, altogether, access, alien, apart, frame )

Aufzählung aus table darstellen.

• all – table, mit sequence von Elementen.
  • Jedes Element ist ein string oder ein mw.html Objekt.
• advance – boolean, falls <ol> gewünscht
• ahead – string, mit Vorspann, sofern gewünscht
• altogether – boolean, um jedes Element umbruchgeschützt darzustellen
• access – string, mit Fragmentbezeichner, sofern gewünscht
• alien – string, mit Sprachcode, sofern gewünscht
• apart – string, für Separator-<span> zwischen den Elementen, sofern gewünscht
• frame – Objekt, falls zur Hand

Rückgabewert: Zeichenkette

Auflistung.first( arglist )

Konfiguration

• arglist – table, mit optionalen Konfigurationswerten; Komponenten:

  styles

  TemplateStyles-Seite

  • string, mit Seitenname
  • mw.title Objekt.

  classesBlock

  Klassen für die gesamte Aufzählung

  • string, mit Klassen
  • table, mit Komponenten als string

  classesNowrap

  Klassen für umbruchgeschütztes Element

  • string, mit Klassen
  • table, mit Komponenten als string

  classesPrefix

  Klassen für Vorspann

  • string, mit Klassen
  • table, mit Komponenten als string

  classesSep

  Klassen für ein Separator-<span>

  • string, mit Klassen
  • table, mit Komponenten als string

  styleItem

  string, mit CSS-Deklarationen für jeden einzelnen Item

Auflistung.failsafe( atleast )

atleast

optional; siehe oben

Rückgabewert: Boolesch oder Zeichenkette

Abhängigkeiten

Keine.