Heraldik-Wiki:Lua/Modul/TemplUtl/de

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

Modul: Dokumentation
Weiterleitung der 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

Funktionen für Lua-Module

Die Bibliothek muss über require() in das nutzende Modul eingebunden werden:

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

Danach stehen zur Verfügung:

TemplUtl.faculty( analyze, another, frame )
  • analyze – string, number, boolean, nil; was zu analysieren ist
  • another – (optional) string, number, boolean; Rückfallwert bei nicht erkanntem analyze
  • frame – (optional) Objekt; wenn zur Hand
Ergibt true, wenn „ja“, sonst false
Zahlen ungleich 0 sind „ja“.
TemplUtl.failure( alert, always )
  • analyze – string; Fehlermeldung
  • always – (optional) boolean; Sichtbarkeit
TemplUtl.feasible( address )
Beschreibt dies den Beginn einer Ressourcen-URL?
  • address – string; was zu durchsuchen ist
Ergibt true, wenn URL-Beginn (auch protokoll-relativ).
TemplUtl.feed( area, ahead, at, after )
Finde das nächste freie | oder }}.
  • area – string; was zu durchsuchen ist
    • Sollte nur die Vorlageneinbindung enthalten, um Treffer außerhalb der Einbindung zu vermeiden.
  • ahead – string; öffnendes Element, oder false
    • Eines von [ [[ {{ {{{ oder false
  • at – number; byte-Position in area, wo begonnen werden soll
  • after – true, wenn nur nach }} gesucht werden soll
  • Hinweis: Zu einem mit .find() gefundenen Beginn der Einbindung lässt sich damit das zugehörige Ende ermitteln, oder wenn für ahead {{ angegeben wird.
Ergibt zwei Werte:
  1. number; byte-Position in area
    • vor | oder }} – könnte auch das Ende von area sein.
    • Punkt zur Fortsetzung der Suche; ahead wurde geschlossen.
  2. true, wenn ab number eine Suche fortgesetzt werden soll.
TemplUtl.feeder( area, at )
Ermittle alle Parameter der Einbindung.
  • area – string; was zu durchsuchen ist
  • at – (optional) number; byte-Position in area, wo begonnen werden soll
Ergibt zwei Werte:
  1. table; Wertzuweisungen
    • [0] – Name der Vorlage, Seite, Parserfunktion
    • [1] … – unbenannte Parameter
    • ["name"] … – benannte Parameter
  2. string; Fehlermeldung(en), sonst nil
HTML-Kommentare werden nicht geliefert.
TemplUtl.fetch( area, ask )
Ermittle den Wert eines benannten Parameters.
  • area – string; was zu durchsuchen ist
    • Sollte nur die Vorlageneinbindung enthalten, um Treffer außerhalb der Einbindung zu vermeiden.
  • ask – string; Name des Parameters
Ergibt den getrimmten Parameterwert, oder nil.
TemplUtl.find( area, access, at, alter )
Finde das nächste Vorkommen einer Vorlageneinbindung.
  • area – string; was zu durchsuchen ist
  • access – string; getrimmter Seitentitel (Vorlage)
  • at – (optional) number; ustring-Position in area, wenn nicht 1
  • alter – (optional) string; Namensraum-pattern in Kleinschreibung (ohne Doppelpunkt)
    • "" für Artikel
    • false für Vorlagen
Ergibt ustring-Position der {{ in area, oder false.
TemplUtl.flat( area )
Eliminiere Syntaxelemente, die nur Syntax unwirksam machen (HTML-Kommentar, nowiki pre syntaxhighlight).
  • area – string; was zu durchsuchen ist
Ergibt area ohne nur maskierende Textsyntax.
TemplUtl.failsafe( atleast )
  1. atleast
    optional
    nil oder Mindestversion
Rückgabewert: string oder false

Verwendung

Allgemeine Bibliothek; nicht eingegrenzt.

Internationalisierung

Das Untermodul Modul:TemplUtl/local definiert sprachabhängige Varianten.

Abhängigkeiten

Keine.