Vorlagenprogrammierung	Diskussionen	Lua			Test	Unterseiten
		Modul	Deutsch	English		Modul:	Dokumentation

Sort – Modul mit Hilfsfunktionen zur Bildung von Sortierschlüsseln.

Funktionen für Vorlagen

Alle Funktionen werten den ersten Parameter aus als Sortierbegriff.
- Sofern dieser nicht im #invoke spezifiziert wurde, wird der erste Parameter der umgebenden Vorlageneinbindung herangezogen.
Die optionalen Parameter von #invoke spezifizieren Ein- und Ausgabeformat sowie weitere Möglichkeiten.

Rückgabewert ist jeweils der Sortierschlüssel.

Alphanumerische Begriffe in lateinisch basierten Schriften werden auf ASCII-Grundzeichen reduziert.

Optionale Parameter

v

Variante

Vorgabe: ISO (Entfernung aller diakritischer Zeichen; Ligaturen durch zwei Buchstaben)

Allerlei typografische Codes für Leerzeichen, waagerechte Striche und unsichtbare Zeichen werden auf ASCII reduziert.
Mehrfache Leerzeichen (whitespace) werden auf eines reduziert.

Groß- und Kleinschreibung bleibt erhalten; diese kann mit Leichtigkeit nachträglich aus dem Ergebnis eliminiert werden.

Der Wert ist 1 wenn die erste Zeichenkette lexikalisch vor der zweiten Zeichenkette liegt; sonst leer.

Pflichtparameter, führender Whitespace ist signifikant

Versionsbezeichnung

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-06-14«
Mindestversion	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-06-14« 2099-01-01 → »«
`wikidata`	Versionsbezeichnung der globalen Mutter (d:Q24205172) Versionsbezeichnung auf Wikidata lokal, falls dort keine gefunden	»2024-06-14«
`item`	ID des Wikidata-Items leer, falls nicht definiert	»Q24205172«
`~`	Ü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	»Q24205172«
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua `false`; andernfalls die angegebene Zeichenkette.

Eine Testseite illustriert Resultate zu Eingabeformaten.

Datum und Zeit

Dies wird implementiert über das Modul DateTime.

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.

Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
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.