Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

Sort/cellText – Modul zur Auswertung eines sortierbaren Textbeginns in Tabellen.

Funktionen für Vorlagen

f
Formatieren.
Parameter einer umgebenden Vorlageneinbindung:
keine
Parameter des #invokealle bis auf den Quelltext optional:
source
Diakritische Zeichen, Verlinkungen, HTML-Elemente werden auf die sichtbaren Grundbuchstaben reduziert – <ref> werden ignoriert
Möglichst ohne <nowiki>-Bereiche; diese werden ignoriert.
Wikitext
pre
Vorangestellter Wikitext, der die Sortierung nicht beeinflusst; mit einem Leerzeichen abgegrenzt falls nicht auf einen Bindestrich endend
Wikitext
rowspan
Tabellen-Attribut: Anzahl der Zeilen
colspan
Tabellen-Attribut: Anzahl der Spalten
class
Universal-Attribut: Leerzeichen-getrennte Liste von Klassenbezeichnern (der gesamten Tabellenzelle)
style
Universal-Attribut: CSS-Deklaration (der gesamten Tabellenzelle)
URL sowie Anführungszeichen " innerhalb von Eigenschaften sind unzulässig.
id
Universal-Attribut: Fragmentbezeichner
lang
Sprachcode (der gesamten Tabellenzelle) abweichend von Seitensprache
dir
Schreibrichtung (der gesamten Tabellenzelle); rtl oder ltr (geerbte Vorgabe)
cat
Titel einer Wartungskategorie im Fehlerfall
Rückgabewert: Wikitext.
  • Bei leerem sichtbaren Ergebnis erfolgt eine Fehlermeldung.
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 »2024-07-02«
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-07-02«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q90147626)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2024-07-02«
item ID des Wikidata-Items
  • leer, falls nicht definiert
»Q90147626«
~ Ü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

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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