Wikipedia:Lua/Modul/TemplatePar

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

TemplatePar – Modul mit Hilfsfunktionen für die Vorlagenprogrammierung; namentlich die Analyse der Parameter der umgebenden Vorlageneinbindung.

  • check – Gesamt-Einbindung der Vorlage prüfen
  • count – Anzahl der Parameter der Vorlage
  • countNotEmpty – Anzahl der nicht-leeren Parameter der Vorlage
  • match – Vorlageneinbindung mit gefordertem Profil abgleichen
  • valid – Einzelnen Parameterwert prüfen
  • failsafe – Versionskontrolle

Insbesondere sollen den Anwendern für Standardfälle der Parameteranalyse auf einfache Weise Standard-Fehlermeldungen dargestellt werden.

Funktionen für Vorlagen

Einzelfunktionen

Alle Funktionen wirken hinsichtlich der analysierten Parameter auf die umgebende Vorlageneinbindung; die Parameter von #invoke spezifizieren die Regeln für die Analyse.

assert

Überprüfung einer beliebigen Zeichenkette nach den Regeln für das Parameterformat.
1
Zu untersuchende Zeichenkette (Pflichtparameter).
2
Format („Nur Ziffern“, „ASCII“, begrenzter Zeichensatz, Lua-pattern); siehe unten. Optional, aber sinnvollerweise in der Regel anzugeben.

check

Überprüfung auf vorgesehene und unerwartete Parameter der Vorlageneinbindung; Vollständigkeit von Pflichtangaben. Details siehe unten.
Eine Fehlermeldung wird mit class=error zurückgegeben.
Wenn nichts zurückgegeben wird, scheint alles in Ordnung zu sein.
Parameter (alle optional):
all
Namen der Pflichtparameter; müssen auch mit Wert belegt sein.
Untereinander durch Gleichheitszeichen = getrennt.
Fehlende Angaben lösen eine Standard-Fehlermeldung aus; wenn individuelle Fehlermeldungen gewünscht werden, sind sie unter opt aufzuführen und mittels Vorlagenprogrammierung zu analysieren.
opt
Namen der optionalen Parameter.
Untereinander durch Gleichheitszeichen = getrennt.
low
Ignoriere Groß- und Kleinschreibung.
Beispiele und Test.

count

Anzahl der Parameter der umgebenden Vorlageneinbindung.
Parameter: Keine (beim #invoke)
Das Ergebnis ist eine Zahl ab 0.
Beispiele und Test.

countNotEmpty

Anzahl der Parameter der umgebenden Vorlageneinbindung, die nicht leer sind (höchstens Leerzeichen oder Zeilenumbruch enthalten).
Parameter: Keine (beim #invoke)
Das Ergebnis ist eine Zahl ab 0.
Beispiele und Test.

match

Umgebende Vorlageneinbindung mit gefordertem Profil abgleichen.
1
Regel im Format   1=Parametername=Spezifikation
Die Spezifikation entspricht der von valid.
nnn
Wie 1 – beliebig viele unbenannte Parameter als Regeln; in beliebiger Reihenfolge und nicht lückenlos.
Alle zulässigen Parameternamen müssen aufgelistet werden; optionale sind mit der Bedingung * anzugeben oder einer geeigneten Spezifikation zu unterwerfen.
Es wird eine Fehlermeldung (class=error) zurückgegeben, wenn etwas nicht stimmt; sonst nichts.
Fatale Fehler führen in der folgenden Reihenfolge zum Abbruch: Unbekannter Parametername – fehlender Parameter – ungültiger Parameterwert.
Beispiele und Test.
Mittels der Funktion lässt sich durch einen einzigen Aufruf gleichzeitig für alle Parameter eine Prüfung ausführen auf
  • Pflichtparameter vorhanden?
  • keine unbekannten Parameternamen (Falschschreibung)?
  • gültige Werte für jeden Parameter?
Für jeden Parameternamen bei der Vorlageneinbindung muss mindestens eine Regel vorhanden sein. Gibt es für einen Vorlagenparameter keine Regel, ist er unbekannt und damit unzulässig.
  • Für denselben Parameternamen kann es mehrere Regeln geben. Die Einhaltung der Regeln wird in der Reihenfolge geprüft, in der sie vereinbart werden.
  • Die Reihenfolge der Parameternamen ist ohne Bedeutung.

valid

Überprüfung eines einzelnen Parameterwerts.
Eine Fehlermeldung wird mit class=error zurückgegeben.
Wenn nichts zurückgegeben wird, scheint alles in Ordnung zu sein.
Parameter (bis auf 1 alle optional):
1
Name des einzelnen Parameters.
2
Format („Nur Ziffern“, „ASCII“, begrenzter Zeichensatz, Lua-pattern); siehe unten.
min
Mindestlänge ≥0.
max
Maximale Länge >0.
low
Ignoriere Groß- und Kleinschreibung.
Aus der Gruppe 2, min, max sollte sinnvollerweise wenigstens eine angegeben werden.
Beispiele und Test.

failsafe

Versionsbezeichnung: 2018-08-10
Optionaler Zusatzparameter 1 – Mindestversionsbezeichnung oder wikidata
Rückgabewert:
  • Leer, falls Mindestversionsbezeichnung nicht erfüllt
  • Versionsbezeichnung (auf Wikidata registriert: 2018-08-10 bei wikidata) oder lokal (auch falls dort keine gefunden)

Handhabung von Fehlern

Alle Funktionen, die auf einen Fehlerfall führen können (check, valid), unterstützen auch die nachstehenden Parameter:

template
Titel der für Autoren sichtbaren Vorlage (für Fehlermeldungen).
Kann auch ein anderes Schlüsselwort sein; vor allem für Untervorlagen vorgesehen.
Ein Wikilink ist darin ebenfalls möglich; etwa auf eine bestimmte Doku-, Hilfe- oder Projektseite. (Hier wäre – anders als beim Titel – natürlich der Namensraum anzugeben.)
cat
Titel einer Wartungskategorie.
Im Fehlerfall wird diese aktiviert.
Mit errNS lässt sich die Kategorisierung auf bestimmte Namensräume beschränken.
Falls der Titel die Zeichenkette @@@ enthält und template gesetzt ist, wird dies durch template ersetzt.
errNS
Leerzeichen-getrennte Auflistung von Namensraum-Nummern, auf die cat beschränkt bleibt.
format
Fehlermeldung formatieren oder unterdrücken.
  • Standardfall, Standardmeldung mit class="error" formatiert:
    • Parameter format nicht angegeben.
    • |format=*|
  • Unterdrücken (dann sollte cat= gesetzt sein):
    • |format=|
    • |format=0|
    • |format=-|
  • Fester Text, eigene Formatierung:
    • |format=<anfang>Fester Text</ende>|
  • Freie Formatierung der Standardmeldung:
    • Enthält @@@ als Platzhalter für die unformatierte Standardmeldung.
    • |format=<anfang>Eigener Text; @@@</ende>|
preview
Fehlermeldung im Vorschaumodus immer anzeigen, auch wenn diese sonst unterdrückt ist, also trotz |format=0| usw. immer Standardmeldung anzeigen:
  • |preview=1|
Fester Text, eigene Formatierung im Vorschaumodus:
  • |preview=<anfang>Fester Text</ende>|
Standardmeldung in eigener Formatierung im Vorschaumodus:
  • |preview=<anfang>Standardmeldung: @@@</ende>|


Parameterprüfung (check)

Anwendungsfall für check am Beispiel der {{Information}}:

{{#invoke:TemplatePar
         |check
         |all= Beschreibung= Quelle= Urheber=
         |opt= Datum= Genehmigung= Andere Versionen= Anmerkungen=
         |template=[[Vorlage:Information]]}}
  • Weil der Name eines Vorlagenparameters kein Gleichheitszeichen = enthalten kann, werden diese zur Abtrennung der Namen benutzt. Leerzeichen vor und nach dem Namen werden ignoriert. Zusätzliche Gleichheitszeichen sind unproblematisch.
  • Die ersten drei Vorlagenparameter des Beispiels sind Pflichtparameter und müssen auch mit Wert angegeben werden.
  • Alle bei der Vorlageneinbindung benutzten Parameter, die weder unter all= noch opt= aufgeführt sind, lösen eine Fehlermeldung aus.
  • Die unbenannten Vorlagenparameter tragen ihre laufende Nummer als Namen; im Übrigen werden die Namen in der Fehlermeldung bezeichnet.
  • Es gibt vier Fehlermeldungen:
    1. #invoke:TemplatePar * Optionsparameter wiederholt
      • Beim Aufruf des Moduls wurde ein Name sowohl unter all= als auch opt= angegeben.
    2. Fehler bei Vorlage * Parametername unbekannt
      • Bei der Vorlageneinbindung wurde ein Parameter benutzt, der weder unter all= noch opt= aufgeführt ist.
    3. Fehler bei Vorlage * Pflichtparameter fehlt
      • Bei der Vorlageneinbindung fehlt ein unter all= aufgeführter Parameter.
    4. Fehler bei Vorlage * Pflichtparameter ohne Wert
      • Bei der Vorlageneinbindung ist ein unter all= aufgeführter Parameter nur mit Gleichheitszeichen, aber ohne sichtbaren Wert angegeben; oder ein unbenannter Parameter ist leer.
  • Die Fehlermeldungen sind hierarchisch gestaffelt. Bei einem Schreibfehler, der zu einem Problem höherer Ordnung führt, könnten die weiteren lediglich Folgefehler sein, die sich mit Korrektur des Grundproblems von selbst erledigen. Es wird daher nur die wichtigste gefundene Fehlerkategorie angezeigt.

Parameterformat (valid)

Für die optionale Bedingung 2 in valid gibt es zwei Grundtypen:

  1. Schlüsselwort
    • Erleichterung für Vorlagenprogrammierer; einige Ausdrücke mit Lua-Patterns nicht möglich.
    • Spezielle Datentypen wie URL, DOI, ISBN, Datum sind nicht erwünscht. Hier müssten bei jedem neuen Typ alle Artikel (mehrere Hunderttausend) neu zusammengestellt werden. Hingegen gibt es darauf spezialisierte Funktionen wie in URLutil.
  2. Lua-Pattern (Ustring)
    • Eingeschlossen in Schrägstriche, um sie von einem Schlüsselwort unterscheiden zu können und ggf. führende und schließende Leerzeichen bei Werten unbenannter Vorlagenparameter zu identifizieren.
    • Die Zeichenketten | sowie {{ und }} sind in der Vorlagenprogrammierung nicht möglich. Dafür sind zu ersetzen:
      • |%!
      • {{%((
      • }}%))

Zur Spalte Implementierung siehe Hilfe:Lua/Zeichenketten #Pattern

Schlüssel für vereinfachten Zugriff
Schlüssel Bedeutung Implementierung
ASCII ASCII-Zeichen (Codes 32–126), nur innerhalb einer Zeile, oder leer ^[ -~]*$
ASCII+ wie vor; nicht leer ^[ -~]+$
ASCII+1 in einem Wort; sonst wie vor und nicht leer ^[!-~]+$
n Nur ASCII-Ziffern 0–9, sowie vorangestelltes Vorzeichen ASCII-Minus, oder leer ^[%-]?[0-9]*$
einzelnes Minus ausschließen
n>0 Nur ASCII-Ziffern 0–9, ohne Vorzeichen, nicht leer und mindestens eine Ziffer nicht Null ^[0-9]*[1-9][0-9]*$
N+ Wie n, aber führende Null nicht erlaubt und nicht leer ^[%-]?[1-9][0-9]*$
N>0 Wie n>0, aber führende Null nicht erlaubt ^[1-9][0-9]*$
x Hexadezimalzahl; ASCII-Ziffern 0–9 Buchstaben a–f A–F, oder leer ^[0-9A-Fa-f]*$
x+ wie vor; nicht leer ^[0-9A-Fa-f]+$
X Hexadezimalzahl; ASCII-Ziffern 0–9 Buchstaben A–F, oder leer ^[0-9A-F]*$
X+ wie vor; nicht leer ^[0-9A-F]+$
0,0 Beliebige Zahl; auch kleiner Null; kann Komma enthalten; oder leer ^[%-]?[0-9]*,?[0-9]*$
nicht nur Minus oder Komma
0,0+ Zahl mit Komma und Nachkommastelle; auch kleiner Null ^[%-]?[0-9]+,[0-9]+$
0,0+? Beliebige Zahl; auch kleiner Null; kann Komma und Nachkommastelle enthalten; nicht leer ^[%-]?[0-9]+,?[0-9]*$
0.0 Beliebige Zahl; auch kleiner Null; kann Dezimalpunkt enthalten; oder leer ^[%-]?[0-9]*[%.]?[0-9]*$
nicht nur Minus oder Punkt
0.0+ Zahl mit Dezimalpunkt und Dezimalstelle; auch kleiner Null ^[%-]?[0-9]+%.[0-9]+$
0.0+? Beliebige Zahl; auch kleiner Null; kann Dezimalpunkt und Dezimalstelle enthalten; nicht leer ^[%-]?[0-9]+[%.]?[0-9]*$
.0+ Beliebige Zahl; auch kleiner Null; kann Dezimalpunkt und Dezimalstelle enthalten, aber nicht notwendigerweise mit Ziffer davor; nicht leer ^[%-]?[0-9]*[%.]?[0-9]+$
aa Mindestens zwei Buchstaben (nicht nur nebeneinander: N.N.) oder ein CJK %a.*%a
oder CJK
ID Identifizierer unter Einschränkungen, wie sie für viele Sprachen üblich sind: ASCII, beginnend mit Buchstaben; weiter Ziffern und Unterstreichungsstrich; oder leer.
Die nachfolgenden ASCII-Wörter sind ebenfalls unter dem Aspekt solcher Bezeichner zu sehen; etwa als Komponente einer URL.
^[A-Za-z]?[A-Za-z_0-9]*$
ID+ wie vor; aber nicht leer. ^[A-Za-z][A-Za-z_0-9]*$
ABC Wort in ASCII-Großbuchstaben; oder leer. ^[A-Z]*$
ABC+ wie vor; aber nicht leer. ^[A-Z]+$
Abc Wort in ASCII-Buchstaben mit nur erstem Buchstaben groß; oder leer. ^[A-Z]*[a-z]*$
Abc+ wie vor; aber nicht leer. ^[A-Z][a-z]+$
abc Wort in ASCII-Kleinbuchstaben; oder leer. ^[a-z]*$
abc+ wie vor; aber nicht leer. ^[a-z]+$
aBc+ Wort in ASCII-Buchstaben mit lower camel casing; nicht leer. ^[a-z]+[A-Z][A-Za-z]*$
base64 Base64; oder leer. ^[A-Za-z0-9%+/]*$
base64+ wie vor; aber nicht leer. ^[A-Za-z0-9%+/]+$
pagename Zulässiger Seitenname; nicht leer. nicht #<>[]|{} oder 12710 oder 1–3110

file
file+
file:
file:+
image
image+
image:
image:+

Zulässiger Titel oder Name einer Mediendatei bei file (der Namensraum darf vorangestellt sein).

  • Mit + nicht leer.
  • Mit : muss die Mediendatei existieren.

Als image muss das Dateiformat für ein Einzelbild geeignet sein.

<nnnn
<=nnnn
>nnnn
>=nnnn
==nnnn
!=nnnn

Bedingung: Arithmetischer Vergleich oder (auch) numerische Ungleichheit
url
url+
leer oder genau eine Internet URL
(Pflicht)
ref <ref> enthalten – Citation needed

lang
langs
langW
langsW
lang+
langs+
langW+
langsW+

leer oder Sprachcode

leer oder Leerzeichen-getrennte Liste von Sprachcodes
leer oder Wiki-Sprachversion
leer oder Liste von Wiki-Sprachversionen
(Pflicht)

* leer oder beliebig
+
nichts
nicht leer %S
In Planung
date Irgendein bekanntes Format für Datum und auch Zeit.
 
Hier eher nicht vorgesehen
  • Vermutlich eher in einem Modul:WLink:
    • Name einer existierenden Seite
  • Basis-Datentypen
    • Datum, Zeit, URL, ISBN

Beispiele (Testseite)

Eine Testseite illustriert praktische Beispiele.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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