Hilfe:Variables
Hilfeseiten |
---|
Allgemein: |
Seitengestaltung |
Community: |
Spezielles: |
Die Variables-Extension erlaubt es, Variablen zu definieren und später auf der Seite wieder abzurufen. Dadurch können Vorlagen miteinander kommunizieren und stellenweise deutliche Quelltexteinsparungen geschehen.
Verwendung
Definition
Variablen werden durch die Funktion {{#vardefine:Variablenname|Inhalt}}
definiert. Es existiert die alternative #vardefinecho, die den Wert zusätzlich direkt ausgibt.
Beispiele:
Aussehen | Quelltext | Effekt |
---|---|---|
{{#vardefine:Hilfe_1|Beispielwert 1}}
|
Der Variable Hilfe_1 wird der Wert Beispielwert 1 zugewiesen.
| |
Beispielwert 1 | {{#vardefineecho:Hilfe_1|Beispielwert 1}}
|
Zusätzlich wird der Wert der Variable direkt angezeigt. |
Auslesen
Der Wert eine Variable kann durch {{#var:Variablenname|ggf. Standardwert}}
abgerufen werden. Entsprechend wird die Funktion vom Parser durch den Wert der Variable substituiert und kann so ausgegeben werden oder an eine Parserfunktion übergeben werden. {{#varexists:Variablenname}}
gibt die Möglichkeit zu überprüfen, ob eine Variable definiert wurde.
Beispiele:
Aussehen | Quelltext | Effekt |
---|---|---|
Beispielwert 1 | {{#var:Hilfe_1}}
|
Die Variable Hilfe_1 wird ausgegeben.
|
Standard | {{#var:Hilfe_2|Standard}}
|
Da die Variable Hilfe_2 nicht definiert ist, wird der Standardwert ausgegeben.
|
1 | {{#varexists:Hilfe_1}}
|
Da die Variable definiert ist, wird 1 ausgegeben.
|
{{#varexists:Hilfe_2}}
|
Da die Variable nicht definiert ist, wird nichts ausgegeben. |
Komplexe Beispiele
# {{#vardefineecho:Hilfe_3|2}}<br /> # {{#varexists:Hilfe_1|{{#vardefine:Hilfe_3|{{#expr:{{#var:Hilfe_3}}+1}}}}}} # {{#ifexpr:{{#var:Hilfe_3}} > 2|Yay!|Hä?}}
wird zu:
- 2
- Yay!
Richtlinien
Da Variables, wenn sie in einer Vorlage verwendet werden, auch die Variables anderer Vorlagen beeinflussen können, gelten gewisse Richtlinien für ihre Verwendung. Diese Regelungen betreffen insbesondere den Artikel- und Vorlagennamensraum, auf Benutzerseiten haben sie keine Gültigkeit.
Variables, die nur in einer Vorlage verwendet werden
Variables, die in nur einer Vorlage verwendet werden, können frei benannt werden. Kurze Namen sind vorzuziehen.
Variables, die in mehreren Vorlagen verwendet werden
Variables, die in mehreren Vorlagen verwendet werden, dürfen nur in Absprache mit dem Projekt, zu dem die Vorlage gehört, verwendet werden. Ihr Name ist sinnvoll zu wählen. Alle Variables dieses Typs sind in der Liste am Ende dieser Seite anzugeben, um Konflikte zu vermeiden und ihren Inhalt festzuhalten.
Variablen werden in Gruppen abhängig von den Artikeln eingeteilt, in denen sie verwendet werden. Diese stellen zugleich den Beginn des Variablennamens dar. Er ist also nach dem Prinzip Gruppe-Titel aufgebaut. Pro Artikel sollten also jeweils nur Variablen aus einer Gruppe verwendet werden.