Wikipedia:Lua/Modul/TemplatePar/de

Einzelfunktionen

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

Handhabung von Fehlern

Alle Funktionen, die auf einen Fehlerfall führen können (check, valid sowie downcase, verify), 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

Durch Leerzeichen getrennte Auflistung von Namensraumnummern, auf die cat beschränkt bleibt.
 Info: Die Angabe des Parameters ohne Wert (errNS=) bedeutet keine Namensräume!

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:
  • |format=Fester Text
• Fester Text, eigene Formatierung:
  • |format=<span …>Fester Text</span>
• Freie Formatierung der Standardmeldung:
  • Enthält @@@ als Platzhalter für die unformatierte Standardmeldung.
  • |format=<span …>Standardmeldung: @@@</span>

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 im Vorschaumodus:

• |preview=Fester Text

Fester Text, eigene Formatierung im Vorschaumodus:

• |preview=<span …>Fester Text</span>

Standardmeldung in eigener Formatierung im Vorschaumodus:

• |preview=<span …>Standardmeldung: @@@</span>

Lua-Module liefern false bei fehlerfreier Analyse, ansonsten die Fehlermeldung.

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.
     • Siehe Tabelle.
   • 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

Beispiele (Testseite)

Eine Testseite illustriert praktische Beispiele.