Heraldik-Wiki:Lua/Modul/TemplUtl

Aus Heraldik-Wiki
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen LuaW-Logo.png Unterseiten
Modul Deutsch English

Modul: Dokumentation
Zentrale Diskussionsseite fehlt

TemplUtl – Bibliotheksmodul mit Funktionen für die Analyse von Vorlageneinbindungen.

Funktionen für Vorlagen

faculty
Boolesche Auswahl (ja/nein) für Parameterwerte
Parameter
1
zu analysierender Parameterwert
Leerzeichen werden ignoriert, Groß- und Kleinschreibung egal; zwei Interpretationen:
  • leer, 0, false, n, no, nein
  • 1, true, y, yes, ja, j
2
Verhalten bei nicht erkanntem Wert 1
(optional)
1 – „ja“ (Vorgabe)
0 – „nein“
Ergebnis:
  • leer für „nein“
  • nicht leer (1) für „ja“
Testseite mit Beispielergebnissen
failure
Formatiere Fehlermeldung; in der Bearbeitungsvorschau des Quelltextes im Seitenkopf wiederholen und verlinken
1
Fehlermeldung
2
Sichtbarkeit der Fehlermeldung in der Darstellung
(optional)
0 – „unsichtbar“ (Vorgabe)
1 – „sichtbar“
Ergebnis: HTML-Element
failsafe
Versionsbezeichnung: 2025-07-16
Optionaler Zusatzparameter 1 – Mindestversionsbezeichnung
Rückgabewert: Leer, falls Mindestversionsbezeichnung nicht erfüllt

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: TemplUtl | Funktionsname | Wert1 | Wert2 | NameX=Wert … }}

Die Parameter können wie bei Vorlagen benannt oder unbenannt sein.

Wenn unbekannte Zeichenketten von außen kommen (als Vorlagenparameter), sollte immer mit der Form 1=Wert gearbeitet werden.

Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer {{Lua-Vorlage}} 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:LuaW-Logo.png.