Dieser Artikel basiert auf dem Wikipedia-Artikel "Hilfe:Vorlagenprogrammierung". Auf ihn wird daher - ungeachtet anderer Bestimmungen auf dieser Seite! - dieselbe Lizenz angewandt wie auf Wikipedia-Artikel:
GNU Lizenz für freie Dokumentationen
| Allgemein:
|
| Artikelgestaltung:
|
| Spezielles:
|
ParserFunctions sind Funktionen innerhalb von Vorlagen, die eine noch bessere Programmierung ermöglichen.
Inhaltsverzeichnis |
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.
ifeq vergleicht zwei Zeichenketten und gibt je nach Ergebnis verschiedene Texte zurück.
{{#ifeq: <text 1> | <text 2> | <text wenn gleich> | <text wenn ungleich> }}
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.
expr berechnet mathematische Ausdrücke.
{{ #expr: <ausdruck> }}
| Operator | Operation | Beispiel |
|---|---|---|
| * | Multiplikation | {{#expr: 30 * 7}} = 210 |
| / oder div | Division | {{#expr: 30 / 7}} = 4.28571428571 |
| + | 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 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).
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.
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.
ec zählt die Edits eines gewünschten Benutzers.
{{#ec:Benutzername}} <- Alle bisherigen Edits werden gezählt.
Mann kann die Funktion ec auch noch auf einem bestimmten Namensraum stellen:
| Eingabe | Ausgabe |
{{#ec:Name|0}}
|
Alle Beiträge zu Artikeln (wichtig für Stimmberechtigung) |
{{#ec:Name|talk}}
|
Alle Diskussionsbeiträge |
{{#ec:Name|template}}
|
Alle Vorlagen-Edits |
| etc... | Den Namensraum auf Englisch |
#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
oder
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 | 08 |
| D | Abkürzung des Wochentages, nur in seltenen Fällen internationalisiert. | Mi |
| j | Tag, ohne führende Null | 8 |
| W | Nummer der aktuellen Kalenderwoche (z.B. 04 oder 52) nach ISO-8601 | 06 |
| l | Ausgeschriebener Name des Wochentages, nur in seltenen Fällen internationalisiert. | Mittwoch |
| F | Ausgeschriebener Name des Monatsnamens, in der Regel internationalisiert | Februar |
| m | Monat, mit führender Null. | 02 |
| M | Abgekürzter Name des Monatsnamens, in der Regel internationalisiert | Feb. |
| n | Monat, ohne führende Null. | 2 |
| Y | Jahr, 4-stellig | 2012 |
| y | Jahr, 2-stellig. | 12 |
| H | Stunde, mit führender Null | 15 |
| i | Minute, mit führender Null | 35 |
| s | Sekunde, mit führender Null | 52 |
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:
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 | 6:2:2012 04:55:52 |
| {{ #time:j"."n"."Y H":"i":"s|yesterday}} | Gestern | 7.2.2012 00:00:00 |
| {{ #time:j"."n"."Y H":"i":"s|tomorrow}} | Morgen | 9.2.2012 00:00:00 |
| {{#time:j"."n"."Y H":"i":"s|2 days}} | Übermorgen | 10.2.2012 15:35:52 |
| {{#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 | 24.4.2014 15:35:52 |
| {{#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 | 16.3.2013 15:35:52 |
Siehe das „GNU tar manual“ für weitere Informationen.
{{#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
Die ParserFunctions können auch mit subst verwendet werden, solange kein Leerzeichen zwischen subst: und # steht.