Hilfe:Vorlagenprogrammierung

Seit Mitte April 2006 verfügt die Wiki-Syntax der MediaWiki-Software über verschiedene Konstrukte einer Programmiersprache für die Verwendung in Vorlagen. Voraussetzung ist die Extension ParserFunktions, siehe Weblinks.

Die Sprachkonstrukte sollten ausschließlich im Vorlagen-Namensraum verwendet und wohlüberlegt eingesetzt werden. Nicht jede Spielerei, die möglich ist, ist auch sinnvoll. Die genaue Syntax kann sich noch ändern! Programmierkonstrukte, die nicht ausreichend dokumentiert sind, werden wieder gelöscht.

Bei Problemen und Fragen zur Vorlagenprogrammierung hilft die Werkstatt des Wikiprojekts Vorlagen weiter.

Beschreibung der ParserFunctions

Funktion if

Die if-Funktion ist ein Wenn-Dann-Sonst-Konstrukt. Die Syntax:

{{#if: <bedingung> | <dann-text> | <sonst-text>}}

Enthält die <bedingung> Text, gilt sie als erfüllt und es wird <dann-text> zurückgegeben. Ist <bedingung> hingegen leer oder besteht ausschließlich aus Leerzeichen (whitespace), gilt sie als nicht erfüllt und es wird <sonst-text> zurückgegeben. <sonst-text> kann auch weggelassen werden, dann wird in diesem Fall nichts zurückgegeben.

Eine wichtige Anwendung ist der Test, ob ein bestimmter Parameter zugewiesen wurde. Dazu gibt man dem Parameter in der testbedingung einen leeren default-Wert. Beispiel:

{{#if: {{{foo|}}} | foo hat den Wert {{{foo}}} | foo hat keinen Wert }}

Achtung: if unterstützt keine Gleichungen oder Ähnliches. Siehe dafür ifeq und ifexpr.

Funktion ifeq

ifeq vergleicht zwei Zeichenketten und gibt je nach Ergebnis verschiedene Texte zurück.

{{#ifeq: <text 1> | <text 2> | <text wenn gleich> | <text wenn ungleich> }}

Funktion ifexist

ifexist prüft, ob ein angegebenes Lemma existiert, und gibt je nachdem verschiedene Texte zurück.

{{#ifexist: <Lemma> | <Text wenn Lemma existiert> | <Text wenn Lemma nicht existiert> }}

Interwiki-Links werden nicht geprüft. Es wird immer angenommen, dass Lemmata in anderen Wikis nicht existieren.

Funktion expr

expr berechnet mathematische Ausdrücke.

{{ #expr: <ausdruck> }}

Mögliche Operationen

Operator	Operation	Beispiel
*	Multiplikation	{{#expr: 30 * 7}} = 210
/ oder div	Division	{{#expr: 30 / 7}} = 4.2857142857143
+	Addition	{{#expr: 30 + 7}} = 37
-	Subtraktion (oder Negation)	{{#expr: 30 - 7}} = 23
mod	Modulo, der Rest einer Division	{{#expr: 30 mod 7}} = 2
round	Rundet die Zahl auf der linken Seite auf die Anzahl Nachkommastellen, die von der Zahl auf der rechten Seite angegeben wird	{{#expr: 30 / 7 round 7}} = 4.2857143
=	Gleichheit	{{#expr: 30 = 7}} = 0
<> oder !=	Ungleichheit	{{#expr: 30 <> 7}} = 1
<	Kleiner als	{{#expr: 30 < 7}} = 0
>	Größer als	{{#expr: 30 > 7}} = 1
<=	Kleiner oder gleich	{{#expr: 30 <= 7}} = 0
>=	Größer oder gleich	{{#expr: 30 >= 7}} = 1
and	Logisches UND	{{#expr: 30 and 7}} = 1
or	Logisches ODER	{{#expr: 30 or 7}} = 1
not	Logisches NICHT	{{#expr: not 7}} = 0
( )	Gruppierung/Klammerung	{{#expr: (30 + 7) * 7 }} = 259

Die booleschen Operatoren behandeln 0 (Null) als falsch und 1 als wahr. Zahlen werden mit dem Punkt als Dezimaltrenner angegeben.

Beispiel:

{{ #expr: (100 - 32) / 9 * 5 round 0 }}

ergibt:

38

Damit werden 100 Fahrenheit auf die Celsius-Skala umgerechnet (auf die nächste Ganze Zahl gerundet).

Da diese Berechnungen aus Kompatibilitätsgründen mit dem englischen Zahlenformat durchgeführt werden (Beispiel: {{ #expr: 13000 / 3.1 round 2 }} ergibt 4193.55) müssen solche Zahlen zusätzlich in das im deutschen Sprachraum übliche Format umgewandelt werden (Beispiel: {{ formatnum: {{ #expr: 13000 / 3.1 round 2 }} }} ergibt 4.193,55).

Funktion ifexpr

ifexpr Wertet einen mathematischen Ausdruck aus.

{{#ifexpr: <ausdruck> | <dann-text> | <sonst-text> }}

Ist das Ergebnis von <ausdruck> 0 (Null), wird <sonst-text> zurückgegeben. Sonst wird <dann-text> zurückgegeben. <sonst-text> kann auch weggelassen werden, dann wird in diesem Fall nichts zurückgegeben.

Die Syntax für Ausdrücke wird in der Beschreibung von expr erklärt.

Funktion switch

switch vergleicht einen Wert mit mehreren anderen. Die Grundsyntax ist:

{{#switch: <vergleichswert>
| <wert1> = <ergebnis1>
| <wert2> = <ergebnis2>
| ...
| <wertn> = <ergebnisn>
| #default = <standardergebnis>
}}

switch geht alle Werte durch, bis der Vergleichswert gefunden wird. Dann wird das entsprechende Ergebnis (hinter dem Gleichheitszeichen) zurückgegeben. Wenn kein Wert übereinstimmt, wird der Eintrag unter #default verwendet, sofern es diesen gibt. (Falls das Standardergebnis kein Gleichheitszeichen enthält, kann #default auch weggelassen werden.)

„Durchfall“-Werte sind ebenfalls möglich:

{{#switch: <vergleichswert>
| <wert1>
| <wert2>
| <wert3> = <ergebnis1,2,3>
| ...
| <wertn> = <ergebnisn>
| #default = <standardergebnis>
}}

Hier wird für <wert1>, <wert2> und <wert3> derselbe Wert <ergebnis1,2,3> zurückgegeben.

Funktion time

#time ist eine Zeit- und Datums-Formatierungs-Funktion. Sie liefert die Koordinierte Weltzeit (UTC).

Für die lokale Zeit kann die Funktion #timel angewandt werden.

Die Syntax ist

{{ #time: format }}

oder

{{ #time: format | time }}

Wenn „time“ nicht angegeben wird, wird die Zeit zum Zeitpunkt der Umwandlung in HTML benutzt. Durch das Servercaching kann es dabei zu Abweichungen bei der Artikelanzeige bis zu einer Woche kommen. Eine manuelle Aktualisierung kann durch einen „null edit“ (Seite bearbeiten und Speichern ohne Änderung) erfolgen.

Der „format“-Parameter ist ähnlich den der PHP-Datumsparameter.

Die folgenden Codes haben dieselbe Bedeutung wie in PHP. Bedeutende Differenzen vom PHP-Verhalten (abgesehen von sprachlichen und lokalen Unterschieden) sollten als Fehler der Parserfunktionen gesehen und als Bug gemeldet werden. Alle numerischen Codes geben Zahlen entsprechend der lokalen Spracheinstellung zurück, durch die Nutzung des xn-Codes kann dieses Verhalten überschrieben werden.

Code	Beschreibung	Ausgabe
d	Tag, mit führender Null	22
D	Abkürzung des Wochentages, nur in seltenen Fällen internationalisiert.	So
j	Tag, ohne führende Null	22
l	Ausgeschriebener Name des Wochentages, nur in seltenen Fällen internationalisiert.	Sonntag
F	Ausgeschriebener Name des Monatsnamens, in der Regel internationalisiert	Dezember
m	Monat, mit führender Null.	12
M	Abgekürzter Name des Monatsnamens, in der Regel internationalisiert	Dez.
n	Monat, ohne führende Null.	12
Y	Jahr, 4-stellig	2024
y	Jahr, 2-stellig.	24
H	Stunde, mit führender Null	09
i	Minute, mit führender Null	06
s	Sekunde, mit führender Null	32

Die folgenden Codes sind Erweiterungen zu PHP:

Code	Beschreibung
xn	Formatiert den nächsten numerischen Code als Roh-ASCII. Beispiel, in Hindi: {{ #time:H, xnH}} ergibt ०६, 06.
xr	Formatiert den nächsten numerischen Code als römische Zahl.
xg	Gibt die Genitivform des Monatsnamens aus; für Sprachen, die zwischen Genitiv und Nominativ unterscheiden.
xx	Der Buchstabe „x“

Jedes unbekannte Zeichen wird unbearbeitet zur Ausgabe durchgereicht. Dazu gibt es zwei Konventionen:

• Zeichen in doppelten Anführungszeichen werden als solche ausgegeben (ohne Anführungszeichen). Anführungszeichen alleine werden als solche ausgegeben. Beispiele:
  • {{ #time: "Der Monat ist" F}} → Der Monat ist Dezember
  • {{ #time:i's"}} → 06'32"
• Backslash-escaping wird unterstützt: \H ergibt das Zeichen H, \" ergibt das Zeichen ".

Das Format des „time“-Parameters ist identisch mit der PHP-Funktion strtotime(). Relative Angaben, wie zum Beispiel „+10 hours“, werden unterstützt, welche für eine Zeitzonen-Berechnung genutzt werden können.

Code	Beschreibung	Ausgabe
{{ #time:j"."n"."Y H":"i":"s|2 days 10 hours 40 minutes ago}}	Das angezeigte Datum wird um 2 Tage, 10 Stunden und 40 Minuten nach hinten verschoben	19:12:2024 22:26:32
{{ #time:j"."n"."Y H":"i":"s|yesterday}}	Gestern	21.12.2024 00:00:00
{{ #time:j"."n"."Y H":"i":"s|tomorrow}}	Morgen	23.12.2024 00:00:00
{{#time:j"."n"."Y H":"i":"s|2 days}}	Übermorgen	24.12.2024 09:06:32
{{#time:j"."n"."Y H":"i":"s|2 years 2 months 2 weeks 2 days}}	In 2 Jahren, 2 Monaten, 2 Wochen und 2 Tagen	10.3.2027 09:06:32
{{#time:j"."n"."Y H":"i":"s|1 year 1 month 1 week 1 day}}	In einem Jahr, einem Monat, einer Woche und einem Tag	30.1.2026 09:06:32

Siehe das „GNU tar manual“ für weitere Informationen.

Funktion titleparts

{{#titleparts:}} gibt die angegebene Anzahl an Teilen (ab einer angegebenen Stelle) eines Seitentitels zurück, die durch einen Schrägstrich („/“) getrennt sind. Beispiele:

• {{#titleparts:Hilfe:Verweis/a/b|0}} ergibt Hilfe:Verweis/a/b (Der ganze Name)
• {{#titleparts:Hilfe:Verweis/a/b|1}} ergibt Hilfe:Verweis
• {{#titleparts:Hilfe:Verweis/a/b|2}} ergibt Hilfe:Verweis/a
• {{#titleparts:Hilfe:Verweis/a/b|1|2}} ergibt a
• {{#titleparts:Hilfe:Verweis/a/b|2|2}} ergibt a/b

Siehe dazu r22711 und bug 6067.

Verwendung mit subst

Die ParserFunctions können auch mit subst verwendet werden, solange kein Leerzeichen zwischen subst: und # steht.

Überprüfung von Zeichenketten

Mit #expr: können zwar numerische Werte, jedoch keine Zeichenketten verwendet werden. Dies lässt sich aber über die folgenden Vorlagen bewerkstelligen. Sie sind nicht Teil der ParserFunctions, werden allerdings der Vollständigkeit halber hier mit aufgelistet, um einen umfassenden Überblick über die zur Vorlagen-Programmierung einsetzbaren Mittel zu geben.

Nachfolgend bedeutet wahr, dass der jeweilige Parameter eine nicht-leere Zeichenkette enthält sowie nicht nur aus Whitespaces besteht.

Syntax	Beschreibung	Wahrheitstabelle
{{booland|A|B}}	Wenn A und B wahr sind, ist das Ergebnis wahr.	Vorlage:Wahrheitstabelle
{{boolor|A|B}}	Wenn A oder B wahr sind, ist das Ergebnis wahr. Statt dessen können die zu überprüfenden Parameter auch einfach verkettet werden, z. B.: {{#if: {{{1|}}}{{{2|}}} | <dann-text> | <sonst-text> }}	Vorlage:Wahrheitstabelle
{{boolxor|A|B}}	Wenn entweder A oder B wahr ist, ist das Ergebnis wahr.	Vorlage:Wahrheitstabelle
{{boolnxor|A|B}}	Wenn A und B falsch sind oder A und B wahr sind, ist das Ergebnis falsch.	Vorlage:Wahrheitstabelle
{{boolnand|A|B}}	Wenn A und B wahr sind, ist das Ergebnis falsch.	Vorlage:Wahrheitstabelle
{{boolnor|A|B}}	Wenn A und B falsch sind, ist das Ergebnis wahr. Statt dessen kann auch die oben beschriebene Oder-Syntax mit vertauschten Dann- und Sonst-Zweigen verwendet werden.	Vorlage:Wahrheitstabelle
{{boolnot|A}}	Wenn A falsch ist, ist das Ergebnis wahr.

Besonderheiten

Tabellen

Die Wikisyntax für Tabellen kann derzeit nicht innerhalb von Bedingungen verwendet werden, daher existieren zwei Workarounds:

Methode A

Man versteckt das Pipe-Zeichen („|“) vor den Parserfunktionen indem man die Vorlage ! verwendet.

Beispiel

{{#if: {{{1|}}} | {{!}} Zelleninhalt | keine Zelle}}

Weitere Vorlagen

Problematische Syntax	Alternative Schreibweise
|	{{!}}
||	{{!!}}
|+	{{!}}+
|-	{{!-}}
|-|	{{!-!}}
|- !	{{!~}}
{|	{{(!}}
|}	{{!)}}
{{	{{((}}
}}	{{))}}

Methode B

Man verwende HTML-Tabellensyntax.

Programmierhilfen

Um den Quelltext nicht zu sehr aufzublähen gibt es Vorlagen, mit denen Berechnungen eingebunden werden können:

• Vorlage:Ziffer extrahiert eine Ziffer aus einer Ganzzahl.
• Vorlage:Quersumme berechnet eine Quersumme.
• Vorlage:Zwischen prüft, ob eine Zahl in einem Intervall liegt.
• Vorlage:Min und Vorlage:Max bestimmen das Minimum bzw. Maximum von zwei bis drei Zahlen.

Testen

Vorlagen mit Parserfunktionen können auf der Spezialseite „Vorlagen expandieren“ getestet werden.

Siehe auch

• Wikipedia:WikiProjekt Vorlagen

Weblinks

• ParserFunctions – Zentrale Hilfeseite im Meta-Wiki
• The discussion about the ParserFunctions in the Wikitech-l list archive
• ParserFunctions trial
• Expr.php
• ParserFunctions.php
• ParserFunctions in MediaWiki SVN