Hilfe:Vorlagenprogrammierung
aus Wikipedia, der freien Enzyklopädie
Seit Mitte April 2006 verfügt die Wiki-Syntax der MediaWiki-Software über verschiedene Konstrukte einer Programmiersprache für die Verwendung in Vorlagen.
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.
Inhaltsverzeichnis |
[Bearbeiten] Beschreibung der ParserFunctions
[Bearbeiten] 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.
Achtung: if unterstützt keine Gleichungen oder Ähnliches. Siehe dafür ifeq und ifexpr.
[Bearbeiten] 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> }}
[Bearbeiten] 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.
[Bearbeiten] Funktion expr
expr berechnet mathematische Ausdrücke.
{{ #expr: <ausdruck> }}
| Operator | Operation | Beispiel |
|---|---|---|
| * | Multiplikation | {{#expr: 30 * 7}} = 210 |
| / oder div | Division | {{#expr: 30 / 7}} = 4.2857142857143 |
| + | Addition | {{#expr: 30 + 7}} = 37 |
| - | Subtraktion (or 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 Bool'schen 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).
[Bearbeiten] Funktion ifexpr
ifexpr Wertet einen mathematischen Ausdruck aus.
{{#ifexpr: <ausdruck> | <dann-text> | <sonst-text> }}
Ist das Ergebnis von <bedingung> 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.
[Bearbeiten] 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: <comparison value>
| <wert1>
| <wert2>
| <wert3> = <ergebnis1,2,3>
| ...
| <wertn> = <ergebnisn>
| #default = <standardergebnis>
}}
Hier für <wert1>, <wert2> und <wert3> derselbe Wert <ergebnis1,2,3> zurückgegeben.
[Bearbeiten] Funktion time
#time ist eine Zeit- und Datums-Formatierungs-Funktion. Die Syntax ist
- {{ #time: format }}
oder
- {{ #time: format | time }}
Wenn „time“ nicht angegeben wird, wird die Zeit zum Zeitpunkt der Umwandung 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 | 16 |
| D | Abkürzung des Wochentages, nur in seltenen Fällen internationalisiert. | Do |
| j | Tag, ohne führende Null | 16 |
| l | Ausgeschriebener Name des Wochentages, nur in seltenen Fällen internationalisiert. | Donnerstag |
| F | Ausgeschriebener Name des Monatnamens, in der Regel internationalisiert | November |
| m | Monat, mit führender Null. | 11 |
| M | Abgekürzter Name des Monatnamens, in der Regel internationalisiert | Nov |
| n | Monat, ohne führende Null. | 11 |
| Y | Jahr, 4-stellig | 2006 |
| y | Jahr, 2-stellig. | 06 |
| H | Stunde, mit führender Null | 15 |
| i | Minute, mit führender Null | 35 |
| s | Sekunde, mit führender Null | 28 |
Die folgenden Codes sind Erweiterungen zu PHP:
| Code | Beschreibung |
|---|---|
| xn | Formatiere den nächsten numerischen Code als Roh-ASCII. Beispiel, in Hindi: {{ #time:H, xnH}} ergibt ०६, 06. |
| xr | Formatiere den nächsten numerischen Code als römische Zahl |
| xg | Gebe die Genitivform des Monatsnamens aus, für Sprachen, die eine Unterscheidung zwischen Genitiv und Nominativ machen. |
| xx | Der Buchstabe „x“ |
Jedes unbekannte Zeichen wird unbearbeitet zur Ausgabe durchgereicht. Dazu gibt es zwei Konventionen zur unbearbeiteten Zeichenausgabe:
- Zeichen in doppelten Anführungszeichen werden als solche ausgegeben (ohne Anführungszeichen). Anführungszeichen alleine werden als solche ausgegeben. Beispiele:
- {{ #time: "The month is" F}} → The month is January
- {{ #time:i's"}} → 20'11"
- 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(). Relavtive Angaben, wie z.B. „+10 hours“ werden unterstützt, welche für eine Zeitzonen-Berechnung genutzt werden kann. Siehe das „GNU tar manual“ für weitere Informationen.
[Bearbeiten] Verwendung mit subst
Die ParserFunctions können auch mit subst verwendet werden, solange kein Leerzeichen zwischen subst: und # steht.
[Bearbeiten] Ü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. |
|
|||||||||
| {{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.:
|
|
|||||||||
| {{boolxor|A|B}} | Wenn entweder A oder B wahr ist, ist das Ergebnis wahr. |
|
|||||||||
| {{boolnxor|A|B}} | Wenn A und B falsch sind oder A und B wahr sind, ist das Ergebnis falsch. |
|
|||||||||
| {{boolnand|A|B}} | Wenn A oder B falsch sind, ist das Ergebnis wahr. |
|
|||||||||
| {{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. |
|
|||||||||
| {{boolnot|A}} | Wenn A falsch ist, ist das Ergebnis wahr. |
[Bearbeiten] Besonderheiten
[Bearbeiten] Tabellen
Die Wikisyntax für Tabellen kann derzeit nicht innerhalb von Bedingungen verwendet werden, daher existieren zwei Workarounds:
[Bearbeiten] Methode A
Man versteckt das Pipe-Zeichen („|“) vor den Parserfunktionen indem man die Vorlage ! verwendet.
[Bearbeiten] Beispiel
{{#if {{{1|}}} | {{!}} Zelleninhalt | keine Zelle}}
[Bearbeiten] Weitere Vorlagen
| Parameter | {{!}} | {{!-}} | {{!!}} | {{!-!}} | {{!+}} |
|---|---|---|---|---|---|
| Inhalt | | | |- | || | |- | |
|+ |
[Bearbeiten] Methode B
Man verwende HTML-Tabellensyntax.
[Bearbeiten] Testen
Vorlagen mit Parserfunktionen können auf der Spezialseite „Vorlagen expandieren“ getestet werden.
