Mediawiki/Vorlage

Aus Mikiwiki
Zur Navigation springen Zur Suche springen
Noch in Arbeit / Work in progress

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
  • 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.

Beispiel: Ersetzung eines benannten Parameters

Es wird die 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.



Weblinks

Von «https://mikiwiki.org/mikiwiki/index.php?title=Mediawiki/Vorlage&oldid=8531»