Mediawiki/Vorlage
Erstellung
Eine Vorlage ist durch ein vorangestelltes "Vorlage:" (z. B. "Vorlage:Text") gekennzeichnet und kann wie jede andere Wikiseite erstellt werden.
Verwendung
Vorlagen sind Wikiseiten, welche in anderen Wikiseiten auf folgende Arten verwendet werden können.
| [[Template:Name]] [[Vorlage:Name]] |
Erzeugt einen Hyperlink zur Vorlage "Name". |
| {{Name}} | Der Inhalt der Vorlage "Name" wird erst zu dem Zeitpunkt in die aktuelle Seite eingefügt, wenn die aktuelle Seite aufgerufen wird. Im Bearbeitungsfenster ist stets nur "{{Name}}" zu sehen. |
| {{msgnw:Name}} | Der Inhalt der Vorlage "Name" erst zu dem Zeitpunkt in die aktuelle Seite eingefügt, wenn die aktuelle Seite aufgerufen wird, wobei die rohe Wikisyntax angezeigt wird, als ob der Text vom "<nowiki>"-Tag umschlossen wäre. Im Bearbeitungsfenster ist stets nur "{{msngw:Name}}" zu sehen. |
| {{subst:Name}} | (substitute) Der Inhalt der Vorlage "Name" wird sofort beim Speichern der aktuellen Seite in die aktuelle Seite eingefügt. Ab diesem Zeitpunkt ist im Bearbeitungsfenster nur noch der eingefügte Text zu sehen. |
Auch eine Seite aus einem anderen Namensraum als "Vorlage:" kann als Vorlage verwendet werden - Ausnahmen sind nur die in "$wgNonincludableNamespaces" ausdrücklich ausgenommenen Namensräume. Um eine Seite aus dem Hauptnamensbereich als Vorlage zu verwenden, wird ein Doppelpunkt (":") vor den Seitennamen geschrieben.
Im Fall eines Namenskonflikts mit einer Variable (z. B. "Vorlage:Ns:3" und "Vorlage:PAGENAME") kann ":Vorlage:" verwendet werden, um deutlich zu machen, dass die Vorlage gemeint ist:
- {{Ns:3}} bzw. {{PAGENAME}} zeigen den User talk bzw. die Seite "Mediawiki/Vorlage" (also die aktuelle Seite)
- {{:Vorlage:Ns:3}} bzw. {{:Vorlage:PAGENAME}} zeigen den Inhalt der Vorlage "Ns:3" bzw. "PAGENAME".
Eine Seite von ausserhalb des Namensraums "Vorlage:" kann in folgenden Fällen nützlich sein:
- Anzeige von Systemtexten im MediaWiki-Namensrtaum.
- Vorlagen für den persönlichen Gebrauch in den Unterseiten von jemandes Benutzerseite, beispielsweise zu Testzwecken.
- Einschluss von Seiten in anderen Seiten innerhalb desselben Namensraums, beispielsweise wird eine zusätzliche Seite (z. B. eine Arbeitsliste) mit jeder Seite durch eine einfache Namensübereinstimmung verbunden werden; sie kann mit {{{{NAMESPACE}}:{{PAGENAME}}/Arbeitsliste}} angelegt und eingeschlossen werden.
Eine Vorlage kann auch eine andere Vorlage enthalten. Für das wiederholte Einfügen von Vorlagen siehe:
Eine seitenbezogene Variable innerhalb einer Vorlage (z. B. {{PAGENAME}}) wird den Wert der die Vorlage aufrufenden Seite ergeben, nicht den Wert, den die Vorlage selbst liefern würde.
In einem Vorlagennamen wird das Zeichen "#" und alle darauffolgenden Zeichen ignoriert: "{{tc#abc}}" wird also den Inhalt der Vorlage "tc" liefern.
Ein Wikitext mit aufeinanderfolgenden doppelten öffnenden und schliessenden geschweiften Klammern (z. B. "{{{{tc}}}}") wird als Vorlage interpretiert, welche einen durch dreifache geschweifte Klammern begrenzten Vorlagenparameter-Tag (also "{ {{{tc}}} }") enthält. Um das zu vermeiden, sollte mindestens in einem der Klammernpaare ein Leerschlag eingefügt werden, am besten aber "{{ {{tc}} }}".
Die Erweiterung "ExpandTemplates" erstellt die Seite "Special:ExpandTemplates", welche den Wikitext anzeigt, der durch den Aufruf einer Vorlage erzeugt wird. Dasselbe geschieht auch bei Verwendung eines URL der Art "http://mikiwiki.org/wiki/index.php?title=Mediawiki/Vorlage&action=raw&templates=expand".
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 |
|---|---|
|
|
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.
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.
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.
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 |
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.
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|{{{!}} |
AB CD AB CD |
|
{{x2|{| |
{| | A | B |- | C | D |} {| | A | B |- | C | D |} |
|
{{x2|{| |
{{ |
Ä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.
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 | Beschreibung |
|---|---|---|
| {{t_sup|3=1|2|1=3|4|5|6|7}} | 3-4-5 |
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>
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 | Beschreibung |
|---|---|---|
| {{{{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 | Beschreibung |
|---|---|---|
| {{{{{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 |
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 "" 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
Vorlagen-Tag-Layout
Um ein gewünschten Vorlagen-Tag-Layout zu erzeugen, insbesondere im Fall vieler Parameter, können zusätzliche Blindparameter mit einem Zeilenumbruch, Leerzeichen und/oder Kommentaren verwendet werden. Im Fall unbenannter Parameter bedeutet das, dass dass einige Parameternummern im Vorlageninhalt nicht verwendet werden, sodass ihre im Vorlagen-Tag vorhandenen Werte das HTML-Rendering der Vorlage nicht beeinflussen.
Für ein Beispiel enthält die "Vorlage:t3d" folgendes:
{{{1}}} {{{2}}} {{{3}}}<br /> {{{5}}} {{{6}}} {{{7}}}<br /> {{{9}}} {{{10}}} {{{11}}}
| Syntax | Ergebnis | Beschreibung |
|---|---|---|
| {{t3d |a|b|c| 1 |d|e|f| 2 |g|h|i| 3 }} | a b c d e f g h i |
If parameters are named, dummy parameters can easily be inserted at any time. If they are unnamed, then, to avoid renumbering, one can insert named parameters: any text including an equals sign will do, if the text on the left is not one of the parameter numbers: this text is interpreted as the name of an unused parameter, hence ignored.
Weblinks
| Herausgeber | Sprache | Webseitentitel | Anmerkungen |
|---|---|---|---|