Hilfe:Vorlagen

Aus KGS-Wiki

Eine Vorlage ist ein einheitlicher Baustein, der immer wieder verwendet werden kann. Es gibt zum Beispiel Vorlagen für Flaggen, Tastenkombinationen, Navigationsleisten und viele mehr.

Eine Vorlage kann man in eine Seite einbinden, indem man ihren Namen in doppelte geschweifte Klammern schreibt.

💬
Beispiel

Nehmen wir als Beispiel die Vorlage:Lenny. Der Code {{Lenny}} erzeugt zum Beispiel immer diesen Output: ( ͡° ͜ʖ ͡°).

Wenn eine Vorlage bearbeitet wird, ändern sich auch (mit einiger Verzögerung) alle Seiten, die diese Vorlage einbinden. Dies sollte man unbedingt vor dem und beim Bearbeiten von Vorlagen berücksichtigen.

Wenn man im visuellen Editor die Zeichen {{ tippt, öffnet sich ein Fenster zur Auswahl und Bearbeitung einer Vorlage.

Parameter

Viele Vorlagen erzeugen nicht nur einfache Textbausteine, sondern formatieren Text oder Seitenabschnitte. Zum Beispiel kann man mit der Vorlage:Python kurze Schnipsel in Python farbig hervorgehoben und in einer anderen Schriftart darstellen lassen. Dafür muss die Vorlage natürlich wissen, welchen Text sie so darstellen soll.

Diese Informationen kann oder muss man Vorlagen als Parameter übergeben. Die Parameter werden hinter den Namen der Vorlage in die geschweiften Klammern geschrieben und mit senkrechten Strichen | abgetrennt.

Dabei unterscheidet man zwischen benannten und nummerierten Parametern

Benannte Parameter

Benannte Parameter haben einen Namen und müssen beim Einbau einer Vorlage mit diesen Namen angegeben werden. Die Reihenfolge ist dabei egal. Die Syntax der Angabe ist dabei Parametername=Parameterwert.

💬
Beispiel

💩

Poop.

Die Vorlage:Thumbnailbox erzeugt eine graue Box am rechten Seitenrand, ähnlich den Boxen um Bilder herum. Sie hat die Parameter INHALT und CAPTION für den (nicht zwingend grafischen) Inhalt der Box und eine optionale Bildunterschrift. Um eine Box wie die rechts angegebene zu zeichnen, muss man die Vorlage mit diesen beiden Parametern aufrufen:

  • {{Thumbnailbox|INHALT=💩|CAPTION=Poop.}} oder
  • {{Thumbnailbox|CAPTION=Poop.|INHALT=💩}}

Nummerierte Parameter

Die nummerierten Parameter einer Vorlage können einfach hintereinander weg, getrennt mit den senkrechten Strichen, angegeben werden. Die Reihenfolge der Parameter muss dabei eingehalten werden.

💬
Beispiel

Die Vorlage:Inf-Schule hat zwei nummerierte Parameter:

  1. die Kapitelnummer
  2. den Kapitelnamen

Beide Parameter müssen beim Einbinden der Vorlage in dieser Reihenfolge eingesetzt werden:

Falsch
{{Inf-Schule|Experimente mit dem Hex-Editor|1.2.3.4}}
erzeugt link=https://inf-schule.de/Experimente mit dem Hex-Editor mit dem Hex-Editor "1.2.3.4" auf inf-schule.de 🇩🇪
Richtig
{{Inf-Schule|1.2.3.4|Experimente mit dem Hex-Editor}}
erzeugt rahmenlos "Experimente mit dem Hex-Editor" auf inf-schule.de 🇩🇪

Alternativ können die Nummern der Parameter auch explizit angegeben werden:

{{Inf-Schule|2=Experimente mit dem Hex-Editor|1=1.2.3.4}} erzeugt dieselbe Ausgabe wie {{Inf-Schule|1.2.3.4|Experimente mit dem Hex-Editor}}, ist allerdings wesentlich schlechter lesbar und etwas verwirrend.

⚠️
Achtung

Wenn in einem Parameter ein senkrechter Strich | oder ein Gleichheitszeichen = vorkommen, funktioniert die Vorlage nicht mehr! Der senkrechte Strich wird nämlich als Trenner zwischen zwei Parametern interpretiert, das Gleichheitszeichen als Namenstrenner bei benannten Parametern.

Als Abhilfe kann man diese Zeichen folgendermaßen umschreiben:

Zeichen Umschreibung
| {{!}}
= {{=}}
Um die Probleme mit dem Gleichheitszeichen zu umgehen, kann man auch die Parameternummer explizit angeben und damit das Problem umgehen. Dies ist eine der wenigen Situationen, in denen es sinnvoll ist, eine Parameternummer anzugeben.

Neue Vorlagen erstellen

Eine neue Vorlage erzeugt man, indem man eine neue Seite namens Vorlage:NAME anlegt. Diese Vorlage kann dann mit {{NAME}} eingebunden werden.

Innerhalb einer Vorlage kann man mit {{{1}}}, {{{2}}} usw. auf die nummerierten Parameter zugreifen und mit {{{NAME}}} auf die benannten Parameter. Mit einem senkrechten Strich | kann außerdem ein Standardwert angegeben werden, der eingesetzt wird, wenn ein Parameter nicht definiert wird: {{{ANTWORT|42}}} zeigt den Parameter ANTWORT oder 42, falls ANTWORT nicht gesetzt ist.

Zum Weiterlesen