Hilfe:Vorlagen/Verwendung

Aus ConanWiki
Zur Navigation springen Zur Suche springen

Einbinden von Vorlagen auf anderen Seiten

Grundsätzlich gibt es zwei Möglichkeiten, eine Vorlage in einem Artikel oder einer anderen Seite zu verwenden:

  1. Der Seitenname der Vorlage wird an der Textstelle, an der die Vorlage eingebunden werden soll, in zwei geschweiften Klammern angegeben: {{<Name der Vorlage>}}. Beim Anzeigen der Seite ersetzt die Wiki-Software diesen Code dann durch den Inhalt der Vorlage. Ändert jemand die Vorlage, werden die Änderungen automatisch auf allen Seiten sichtbar, auf denen die Vorlage eingebunden ist.
  2. Der Vorlageninhalt wird substantiviert eingebunden. Hierbei wird dem Seitenname der Vorlage das Schlüsselwort subst: (für Substitution) oder auch ers: (für Ersetzen) vorangestellt:{{subst:<Name der Vorlage>}} bzw. {{ers:<Name der Vorlage>}}. Wird eine Vorlage auf einer Seite substantiviert eingebunden, so wird nach dem Speichern der Seite der Code durch den aktuellen Inhalt der Vorlage ersetzt. Anders formuliert, der Text aus der Vorlage wird in die Seite, auf der die Vorlage eingebunden wurde, hineinkopiert. Werden danach Änderungen an der Vorlage vorgenommen, so haben diese keine Auswirkungen auf Artikel oder andere Seiten, auf denen die Vorlage substantiviert eingebunden wurde.

Vorlagen, die ausschließlich substantiviert eingebunden werden sollen, sind in der Kategorie:Vorlage:nur Subst enthalten. Ein weiteres Beispiel ist die Vorlage:Willkommen, die bei der Begrüßung neuer Benutzer ebenfalls substantiviert eingebunden werden sollte, damit diese auf ihrer Seite auch beim Bearbeiten den Text der Begrüßung vorfinden und kein ggf. verwirrendes {{Willkommen|~~~~}}.

Weiterhin ist zu beachten, dass der Namensraum aus dem Seitenname der Vorlage nicht mit angegeben wird, sofern die Seite im Namensraum für Vorlagen erstellt wurde. Beispielsweise ist der volle Name der o. g. Willkommen-Vorlage "Vorlage:Willkommen", wobei das Präfix Vorlage: den Namensraum kennzeichnet. Es können aber auch beliebige andere Seiten wie Vorlagen eingebunden werden. Nachfolgend ein Überblick, wie Seiten als Vorlagen eingebunden werden können:

  • Liegt die Seite im Vorlagen-Namensraum, wird beim Einbinden als Vorlage der Seitenname ohne Namensraum-Präfix angegeben: {{<Name der Vorlage>}}.
  • Liegt die Seite im Artikel-Namensraum, wird beim Einbinden als Vorlage der Seitenname mit vorangestelltem Doppelpunkt angegeben: {{:<Name der Vorlage>}}.
  • Sonst: das Präfix für den Namensraum muss ebenfalls mit angegeben werden: {{<Namensraum>:<Name der Vorlage>}}.

Dass eine Seite als Vorlage verwendet wird, obwohl sie nicht im Vorlagen-Namensraum liegt, kann bei Vorlagen-Tests sinnvoll sein, wenn ein Benutzer eine neue Vorlage zunächst in seiner persönlichen Sandbox entwickelt und testet. Textbausteine, Formatierungshilfen oder Funktionen, die als Vorlage in Seiten in ConanWiki eingebunden und aktiv verwendet werden sollen, sind jedoch im Vorlagen-Namensraum zu erstellen bzw. nach den persönlichen Tests dorthin zu verschieben.

Verwenden von Parametern

In dem vorangegangenen Abschnitt "{{{refVorlageErlaeuterung}}}" wurde bereits angesprochen, dass Vorlagen nicht nur statische Textbausteine enthalten müssen. Dass eine Vorlage in einem gewissen Rahmen individualisiert und an den Inhalt der Seite angepasst werden kann, auf der sie eingebunden wird, wird über Parameter erreicht. Ein Parameter ist hierbei ein definierter Platzhalter innerhalb der Vorlage, der beim Einbinden der Vorlage mit einem Wert belegt werden kann. Ein Beispiel hierfür ist erneut die Willkommen-Vorlage, mit der ein neu angemeldeter Benutzer wie folgt begrüßt werden kann: {{subst:Willkommen|~~~~}}.

In diesem Beispiel trägt die Vorlage selbst den Namen "Willkommen" und wird substantiviert eingebunden. Als Parameter wird die eigene Signatur mitgegeben. Der neu angemeldete Benutzer bekommt dadurch, neben dem Willkommenstext aus der Vorlage, angezeigt, wann und von wem er begrüßt wurde.

Ob eine Vorlage parametrierbar ist oder nicht, kann auf der Vorlagen-Seite nachgeschaut werden. Dort sind in der Regel Beispiele angegeben, wie die Vorlage verwendet werden soll und welche Parameter möglich sind. Dort ist auch angegeben, wenn Parameter dediziert über einen Namen angesprochen werden können. Hierzu nachfolgend zwei Beispiele zu Vorlagen, die im Rahmen der Wiki-Arbeit recht häufig verwendet werden.

Vorlagen mit anonymen Parametern

Die Vorlage:K wird gemäß ihres Verwendungshinweises wie folgt eingebunden: {{K|XXX}}, wobei XXX der Nummer eines beliebigen Kapitels aus dem Detektiv Conan-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Formatierungshilfe, die für das mitgegebene Kapitel einen Verweis auf den entsprechenden Wiki-Artikel erstellt.

Die Nummern der Kapitel, auf die verwiesen werden soll, sind hierbei als Parameter an die Vorlage:K übergeben, indem sie durch einen senkrechten Strich („|“) getrennt hintereinander nach dem Vorlagennamen angegeben sind. Innerhalb der Vorlage werden die Parameter anhand der Reihenfolge, in der sie mitgeben sind, voneinander unterschieden und die Reihenfolge der Parameter wirkt sich auf die Darstellung durch die Vorlage aus.

Vorlagen mit ausgezeichneten Parametern

Die Vorlage:Infobox Kapitel kann gemäß ihres Verwendungshinweises wie folgt eingebunden werden: {{Infobox Kapitel|Kapitel=XXX}}, wobei XXX der Nummer eines beliebigen Kapitels aus dem Detektiv Conan-Manga entspricht. Bei dieser Vorlage handelt es sich um eine sogenannte Infobox, die in Kapitel-Artikeln verwendet wird.

Die Nummer des Kapitels wird hierbei explizit über den Parameter "Kapitel" an die Vorlage übergeben. Innerhalb der Vorlage wird dieser Parameter anhand seines Namens von anderen Parametern unterschieden und die Reihenfolge der Parameter wirkt sich nicht auf die Darstellung durch die Vorlage aus.