Mediawiki/Vorlage/Parameter

Vorlagenparameter sind "called-by-value" und sind deshalb ausschliesslich Eingabeparameter.

In der Vorlage "Aufruf" kann die Anzahl der Parameter variieren (im Beispiel sind es zwei), weswegen die Syntax wie folgt lautet:

• {{vorlagenname|parname1=parwert1|parname2=parwert2}} mit den Tags {{{parname1|default}}}, {{{parname2|default}}} usw. in der Vorlage, oder
• {{vorlagenname|parwert1|parwert2}} mit den Tags {{{1|default}}}, {{{2|default}}} usw. in der Vorlage, oder
• eine Mischung aus den beiden Möglichkeiten.

Ein Vorlagenaufruf besitzt also nach dem Vorlagenamen, keine oder mehrere Parameterdefinitionen, die in der Wikisyntax durch das Verkettungszeichen ("|") voneinander getrennt werden. Zudem wird jede ein Gleichheitszeichen ("=") enthaltende Parameterdefinition an der Stelle dieses Gleichheitszeichens in einen Parameternamen und einen Parameterwert getrennt. Für alle übrigen Parameterdefinitionen werden Parameternamen von "1", "2", "3" usw. angenommen.

Ein formaler Parameter (der Platzhalter für den Parameterwert) wird durch ein Parameter-Tag mit drei aufeinanderfolgenden geschweiften Klammern dargestellt (z. B. {{{3}}}), optional gefolgt von einem Verkettungszeichen und einem Standardwert (z. B. {{{3|abc}}}).

Ein Parameter wie {{{3|abc}}} kann auf zwei Arten referenziert werden:

• explizit mit "3=pqr". Wenn der Parametername keine "kleine" positive Ganzzahl ist, so kann er nur explizit referenziert werden.
• implizit, indem "pqr" an dritter Stelle unter den unbenannten Parameterdefinitionen genannt wird.

Benannte Parameter

Implizit numerierte Parameter

Benannte Parameter können in jeder beliebigen Reihenfolge angegeben werden. Bei einem benannten Parameter werden Leerzeichen und Zeilenumbrüche vom Anfang und Ende der Parameterwerte entfernt. Deshalb ist der beste Name für einen Separatorparameter "1" - er bestimmt, wie die Ausgabe unterteilt wird.

Um den Wert eines bestimmten implizit numerierten Parameters anzugeben müssen alle vorangehenden ebenfalls angegeben werden (in diesem Fall wird oft eine leere Zeichenkette als Wert mitgegeben). Mit implizierter Numerierung ist der Aufruf kürzer. Einem implizit numerierter Parameter kann ein das Gleichheitszeichen ("=") enthaltender Wert nur indirekt zugewiesen werden. Bei einem implizit numerierten Parameter werden Leerzeichen und Zeilenumbrüche vom Anfang und Ende der Parameterwerte nicht entfernt.

Der Standardwert (optional, zusammen mit vorangestelltem Verkettungszeichen) kann bei jedem Vorkommen anders sein und wird angewendet, wenn beim Aufruf der Vorlage kein Wert angegeben wurde; er sollte nicht mit dem Fall verwechselt werden, dass der leere Wert angegeben wurde.

Um zwischen einem definierten und nicht-leeren Parameter einerseits und einem nicht definierten oder leeren Parameter andererseits unterscheiden zu können, kann "#if:" mit einem leeren Standardwert verwendet werden:

{{#if: {{{param|}}} | Parameter ist definiert und nicht leer | Parameter ist nicht definiert und leer}}

Um zwischen einem definierten (und möglicherweise leeren) und einem nicht definierten Parameter unterscheiden zu können:

{{#ifeq: {{{param|+}}} |  {{{param|-}}} | Parameter ist definiert | Parameter ist nicht definiert}}

Im Fall der Seitenersetzung mit einem undefinierten Parameter wird nicht der Standardwert, sondern der Parameter selber mit dem Standardwert ersetzt und in den Wikitext eingefügt. Falls das nicht erwünscht ist, so gibt es eine Alternative (die ebenfalls "#ifeq" verwendet): Help:Substitution#Parameter_default_considerations.

1. Beispiel: Ersetzung eines benannten Parameters

Es wird die folgende Vorlage "Namensbeispiel" angelegt (genauer gesagt heisst sie "Vorlage:Namensbeispiel") mit einem Parameter für den Vornamen ("vorname") und einem für den Nachnamen ("nachname"):

Ich bin ein Vorlagenbeispiel. Mein Vorname ist <b>{{{vorname}}}</b> und mein Nachname ist <b>{{{nachname}}}</b>.

Meine Seite kann unter [[{{{nachname}}}, {{{vorname}}}]] aufgerufen werden.

Auf einer zweiten Seite wird eingegeben: {{Namensbeispiel}}. Das Ergebnis wird das folgende sein, da die Vorlage keine Parameterwerte besitzt.

Ich bin ein Vorlagenbeispiel. Mein Vorname ist {{{vorname}}} und mein Nachname ist {{{nachname}}}.

Meine Seite kann unter [[{{{nachname}}}, {{{vorname}}}]] aufgerufen werden.

Wird auf der zweiten Seite jedoch folgendes eingegeben: {{Namensbeispiel|vorname=Hans|nachname=Muster}}, so wird das Ergebnis wie folgt aussehen.

Ich bin ein Vorlagenbeispiel. Mein Vorname ist Hans und mein Nachname ist Muster.

Meine Seite kann unter Muster, Hans aufgerufen werden.

Um die Arbeitsweise zu analysieren, kann die Spezialseite [[Special:ExpandTemplates]] verwendet werden (im Mikiwiki ist diese Erweiterung allerdings nicht installiert), um den expandierten Wikitext als Zwischenergebnis zu sehen. Wird dieser Wikitext direkt angewendet, so ist das Ergebnis dasselbe.

Ich bin ein Vorlagenbeispiel. Mein Vorname ist <b>Hans</b> und mein Nachname ist <b>Muster</b>.

Meine Seite kann unter [[Muster, Hans]] aufgerufen werden.

2. Beispiel: Ersetzung eines numerischen Parameters

Ein Beispiel um zu zeigen, wie die Parameterinhalte funktionieren.

Zuerst wird eine Vorlage mit dem Namen "t0" (also eigentlich "Vorlage:t0") definiert, die

• ein einziges Argument erwarten wird
• die den Text dieses Arguments ohne Leerzeichen davor oder danach zurückgeben wird
• und zwar zwischen "anfang-" und "-ende".

anfang-{{{1}}}-ende

Aufruf der Vorlage "t0"	Syntax	Ergebnis
mit dem Parameterwert "a"	{{t0|a}}	anfang-a-ende
mit dem Parameterwert " " (ein Leerzeichen)	{{t0| }}	anfang- -ende
mit dem Parameterwert "" (leere Zeichenkette)	{{t0|}}	anfang--ende
ohne Parameterwerte zu übergeben	{{t0}}	anfang-{{{1}}}-ende

Wenn irgendetwas in der Art von "{{{1}}}" oder "{{{name}}}" auf einer gewöhnlichen Wikiseite sichtbar ist, so bedeutet das typischerweise, dass der Pflichtparameter einer Vorlage auf dieser Seite nicht definiert wurde.

3. Deklaration eines Standardwerts

Dazu gibt es den Metawiki-Artikel "Help:Parameter_default".

Zuerst wird eine Vorlage mit dem Namen "t" (also eigentlich "Vorlage:t") definiert, die einen einzigen numerierten Parameter "1" mit dem Standardwert "pqr" enthält. Der einzige Unterschied der Ausgabe der beiden Vorlagen "t" und "t0" zeigt sich, wenn sie ohne Parameter (und auch ohne Verkettungszeichen "|") aufgerufen werden.

anfang-{{{1|pqr}}}-ende

Aufruf der Vorlage "t"	Syntax	Ergebnis
mit dem Parameterwert "a"	{{t|a}}	anfang-a-ende
mit dem Parameterwert " " (ein Leerzeichen)	{{t| }}	anfang- -ende
mit dem Parameterwert "" (leere Zeichenkette)	{{t|}}	anfang--ende
mit dem benannten Parameter "1="	{{t|1=keine Überraschung}}	anfang-keine Überraschung-ende
mit dem benannten Parameter "1=" nach einem unbenannten Parameter	{{t|keine|1=Überraschung}}	anfang-Überraschung-ende
mit dem benannten Parameter "1=" vor einem unbenannten Parameter	{{t|1=keine|Überraschung}}	anfang-Überraschung-ende
ohne Parameter	{{t}}	anfang-pqr-ende
ohne benannten oder unbenannten Parameter "1"	{{t|2=zwei}}	anfang-pqr-ende

4. Beschränkungen bei Parameterwerten

Ein implizit benannter Parameter kann einem Wert zugewiesen werden, der ein Gleichheitszeichen enthält - aber nur auf indirekte Weise. Zu den möglichen Methoden (hier mit einem Beispiel unter Verwendung von "Vorlage:t1") gehören:

Methode	Syntax	Ergebnis
Eingabe als Standardwert eines undefinierten Parameters	{{t1|{{{| a=b }}} }}	anfang- a=b -ende
Verwendung der "Vorlage:="	{{t1| a{{=}}b }}	anfang- a=b -ende
Wenn es nur um die Anzeige geht, kann das Gleichheitszeichen durch die HTML-Entität "=" ersetzt werden.	{{t1| a=b }}	anfang- a=b -ende

Dasselbe Beispiel mit "1 = a=b" ergibt "anfang-a=b-ende".

Unter den Gründen für die Verwendung eines unbenannten Parameters sind die folgenden:

• Leerzeichen und Zeilenumbrüche werden vom Anfang und Ende des Parameterwerts von benannten Parametern entfernt (wie gerade gezeigt).
• Die Numerierung der folgenden unbenannten Parameter soll nicht gestört werden (alternativ kann der Parameterdefinition auch ein zusätzliches Verkettungszeichen "|" vorangestellt werden, das eine leere Definition eines unbenannten Parameters erzeugt, welcher durch die betroffene Parameterdefinition überschrieben wird).

Jedes nicht übereinstimmende Paar von zwei aufeinanderfolgenden geschweiften Klammern muss innerhalb von "<nowiki>"-Tags gesetzt werden. Geschweifte Klammern können für verschachtelte Vorlagenparameter , verschachtelte Vorlagen oder Parserfunktionen, während eckige Klammern für Links verwendet werden können. Nicht übereinstimmende Paare, die nicht innerhalb von "<nowiki>"-Tags gesetzt werden, verhindern entweder die Vorlagen-Expansion oder werden als schliessende geschweifte Klammern für den Vorlagenaufruf angesehen.

5. Verkettungszeichen enthaltende Parameterwerte

Um einen Parameterwert zu definieren, der ein Verkettungszeichen ("|") enthält, das nicht Teil des Vorlagenaufrufs, Parserfunktionsaufrufs, piped Links oder Bild-Tags ist, muss "Vorlage:!" mit dem Inhalt "|" verwendet werden.

Für das Beispiel wird die "Vorlage:t0" mit folgendem Inhalt verwendet:

anfang-{{{1}}}-ende

Syntax	Ergebnis	Beschreibung
{{t0|a{{!}}b}}	anfang-a|b-ende	Der expandierte Wikitext ist "anfang-a|b-ende"
{{t0|a|b}}	anfang-a|b-ende	Der expandierte Wikitext ist "anfang-a|b-ende". Das ergibt zwar dasselbe Ergebnis, macht aber einen Unterschied, wenn das Zeichen in der Tabellensyntax verwendet werden soll: Hier wird das "echte" Verkettungszeichen gefordert.
{{t0|a|b}}	anfang-a-ende

Verwendung der "Vorlage:x2" mit folgendem Inhalt:

{{{1}}}{{{1}}}}

Syntax	Ergebnis
{{x2|{{{!}} {{!}} A {{!}} B {{!}}- {{!}} C {{!}} D {{!}}} }}	AB CD AB CD
{{x2|{| | A | B |- | C | D |} }}	{| | A | B |- | C | D |} {| | A | B |- | C | D |}
{{x2|{| | A | B |- | C | D |} }}	{{

Ähnliche Konstrukte können einem Parameterwert erlauben, zwei aufeinanderfolgende schliessende geschweifte Klammern zu enthalten. Sogar ein Parametername kann auf diese Weise "|" und "}}" enthalten, doch scheint das wenig Nutzen zu bringen. Ein Seitenname kann jedenfalls weder das Verkettungszeichen noch eine geschweifte Klammer enthalten.

6. Mischung von benannten und unbenannten Parametern

Im Fall einer Mischung von benannten und unbenannten Parametern in einem Vorlagen-Tag werden die unbenannten Parametern 1, 2, 3 usw. numeriert - sie werden also nicht nach ihrer Position in der gemischten Liste als ganzes numeriert.

Für das Beispiel wird die "Vorlage:t_sup" mit folgendem Inhalt verwendet:

{{{1}}}-{{{2}}}-{{{3}}}<noinclude> [[category:Vorlagen]]</noinclude>

Syntax	Ergebnis
{{t_sup|3=1|2|1=3|4|5|6|7}}	3-4-5

7. Parameter, die nicht expandieren

Innerhalb von "<nowiki>"- oder XML-style extension-Tags werden Parameter nicht expandiert.

Das folgende wird also innerhalb einer Vorlage nicht funktionieren, da die Parameter nicht expandiert werden.

<myextension xparam={{{tparam}}}> ... </myextension>

8. Mehr als drei öffnende geschweifte Klammern

Im Fall von mehr als drei öffnenden geschweiften Klammern werden die letzten drei als Parameterklammern interpretiert. Gibt es keine zugehörigen drei schliessenden geschweiften Klammern, so werden die letzten zwei öffnenden geschweiften Klammern als Klammern für eine Vorlagen- oder Parserfunktion angesehen.

"{{{{a}}}}" wird also als "{ {{{a}}} }" geparst.

Syntax	Ergebnis
{{{{t1|1}}}}	{1}
{{ {{t1|1}}}}	Vorlage:anfang-1-ende
{{{{t1|1}} }}	Vorlage:anfang-1-ende
{{{{t1|1}} }} {{{5}}}	Vorlage:anfang-1-ende {{{5}}}

Im weiteren wird "{{{{{a}}}}}" als "{{ {{{a}}} }}" geparst.

Syntax	Ergebnis
{{{{{abc|tc}}}}}	in

Beginnt also der Ausdruck für einen Parameternamen mit einer Vorlagen- oder Parserfunktion, so wird nach der dritten geschweiften Klammer ein Leerzeichen benötigt.

Syntax	Ergebnis	Beschreibung
{{{ {{#if:x|tc|ab}}}}}	{{{ tc}}}
{{{{{#if:x|tc|ab}}}}}	in	Hier wird der Standardwert "tc" von Parameter "#if:x" verwendet und "|ab" ignoriert.
{{{{{{a|b}}}|c}}}	c

9. Beobachtung der Parameterverwendung

Zum Beobachten der Verwendung des Parameters einer Vorlage (wenn viele Seiten die Vorlage verwenden), kann diese Vorlage eine Hilfsvorlage aufrufen, deren Name davon abhängt, ob der Parameter definiert wurde. Die möglichen Hilfsvorlagen brauchen nicht zu existieren, wenn sie beispielsweise als Parameterwerte der leeren "Vorlage:Leer" verwendet werden, um jegliche Anzeige zu vermeiden (mit dem neuen Präprozessor sollte stattdessen eine Vorlage mit dem Inhalt "{{{1}}}" verwendet werden). Werden nun die "Links auf diese Seite" auf diese Hilfsvorlagen angewendet, so zeigen diese, welche Seiten die Vorlage mit und welche ihn ohne Parameter verwenden. Diese Parameterbeobachtungsmöglichkeit sollte vorzugsweise beim Anlegen der Vorlage oder bei der Einführung eines neuen Parameters miteingebaut werden. Wenn es erst später geschieht, so zeigt "Link auf diese Seite" eine Seite womöglich erst an, wenn sie nach dem Bearbeiten einmal abgespeichert oder der Cache geleert wurde.

Einige Anwendungen der Parameterbeobachtung:

• Prüfung, wo der Parameter noch nicht angegeben wurde, um ihn hinzuzufügen.
• Prüfung, wo ein umbenannter Parameter verwendet wird, um die Vorlagenaufrufe zu ändern.
• Prüfung, ob ein Parameter verwendet wird, bevor er abgeschafft wird.
• Wurde eine Vorlage geändert, um einen bestimmten Parameter zu verarbeiten, so sollten die Seiten (oder wenigstens einige von ihnen) geprüft werden, welche den Parameter verwenden, um zu sehen, ob alles funktioniert wie gewünscht.

In einer ähnlichen Weise kann eine Hilfsvorlage für eine Kombination aus "Vorlage / Parameter / Parameterwert" oder "Vorlage / Parameter / Parameterwertbereich" aufgerufen werden. "Links auf diese Seite" zeigt dann, welche Seiten die Vorlage mit diesem Parametwert oder mit dem Parameterwert im angegebenen Bereich verwenden.

Siehe dazu: http://meta.wikimedia.org/wiki/Template:T_optional_parameter_demo

10. Parameterwert abhängig von Parametern

Wenn der Parameter undefiniert bleibt, funktioniert der in dreifache geschweifte Klammern eingeschlossene Parametername im Ergebnis nicht als Parameter, wenn die Seite als Vorlage von einer anderen Seite aufgerufen wird. Soll sie das aber, so darf der Parameterwert nicht weggelassen werden, sondern muss in der Art eines Parameters der aufrufenden Seite angegeben werden. Zum Vergleich:

Vorlage	Syntax	Ergebnis
{{t2ademo|b}}	{{t2demo|a}}	anfang-a-mitte-{{{2}}}-ende
{{t2a1|b}}	{{t2demo|a|{{{1}}} }}	anfang-a-mitte-b-ende
{{t2a2|b}}	{{t2demo|a|2={{{1}}} }}	anfang-a-mitte-b-ende

Der direkteste Weg um einen Parameterwert als Parameter auszudrücken, ist denselben Namen zu verwenden und ihn gleichzusetzen, beispielsweise in der Vorlage Template:Lan_is_mr:

{{Lan is|lr=af|le={{{le}}} }}

Weblinks

Herausgeber	Sprache	Webseitentitel	Anmerkungen
Wikimedia	eng	Help:Template#Parameterswbm