NRW:Arbeitsgruppe/Website/HowTo/Wikivorlagen
Inhaltsverzeichnis
Wikivorlagen
Was ist das?
Vorlagen im Wiki sollen das Festhalten von Informationen vereinfachen. Sie können benutzt werden um bestimmte Inhalte graphisch ohne Programmierkenntnisse auszuwerten, Daten besser zu strukturieren und Daten später leichter automatisiert zu verarbeiten.
Im Grunde genommen ist eine Vorlage nichts anderes als jeder andere Artikel im Wiki auch. Jedoch wurde speziell für Vorlagen der Namensraum Vorlage angelegt.
Vorlagen haben den Vorteil, dass sie Variablen verwenden können. Deren Inhalte können dann an beliebiger Stelle innerhalb der Vorlage verarbeitet oder angezeigt werden. Diese Variablen können einen Namen haben oder durchnummeriert sein.
Wie nutze ich das?
Eine Vorlage zu benutzen ist denkbar einfach.
{{Hinweis|Hallo Welt}}
sieht dann so aus:
Eine Vorlage wird also so verwendet, dass zunächst zwei direkt aufeinanderfolgende geschweifte Klammern {{ kommen. Unmittelbar danach steht der Name der Vorlage. Die im Beispiel verwendete Vorlage heißt Hinweis und liegt im Namensraum Vorlage.
Verarbeit die Vorlage auch Variablen, so werden diese nachfolgend angegeben und jeweils durch ein Pipesymbol, also den senkrechten Strich |, getrennt. Handelt es sich, wie im Beispiel, um eine nicht benannte Variable, kann der Variablenname weggelassen werden.
Der Text Hallo Welt wird also als Wert einer Variablen an die Vorlage übergeben. Der Name der Variablen im Beispiel ist 1, denn die Variable hat keinen eigenen Namen und somit werden die Variablen durchgezählt.
{{Hinweis|Hallo Welt}} ist also das Gleiche wie {{Hinweis|1=Hallo Welt}}.
Variablen, die einen Namen haben, bekommen ihren Wert zugewiesen, indem man zunächst den Variablennamen, gefolgt von einem Gleichheitszeichen =, gefolgt vom zuzuweisenden Wert, schreibt.
{{EineVorlage|Farbe=red}}
Im Beispiel wird also der Variablen Farbe der Wert red zugewiesen. Die Namen der Variablen beachten Groß- und Kleinschreibung. Das bedeutet, dass var ungleich Var ist.
Bei Vorlagen, die im Namensraum Vorlage abgelegt sind, kann man die Angabe des Namensraums weglassen. Das heißt, man kann anstelle von {{Vorlage:Hinweis|Hallo Welt}} das gezeigte {{Hinweis|Hallo Welt}} verwenden.
Wie zuvor erwähnt, unterscheiden sich Vorlagen im Prinzip nicht von anderen Artikeln. Daher kann man auf die gleiche Weise jeden beliebigen Artikel einbinden. Beispielsweise: {{NRW:Konto}}
Kontoinhaber: Piratenpartei Landesverband NRW Kontonummer: 1007115494 Bankleitzahl: 300 501 10 Kreditinstitut: Sparkasse Düsseldorf IBAN: DE66 3005 0110 1007 1154 94 BIC: DUSSDEDDXXX
Wie schreibe ich so was?
Vorlagen sollten prinzipiell im Namensraum Vorlage erstellt werden. Also beispielsweise Vorlage:Meine_neue_Vorlage.
Der Inhalt kann beliebig sein, Rekursionen von Vorlagen sind aber unzulässig.
Werte von Variablen werden eingebunden, indem man den Namen der Variablen zwischen 3 geschweifte Klammern {{{ stellt.
Die gewählte Farbe ist {{{Farbe}}}.
Wenn man vermeiden möchte, dass die Vorlage bei Nichtübergabe eines Wertes an die Variable dennoch funktioniert, kann man einen Vorgabewert festlegen. Dies geschieht, indem unmittelbar nach dem Variablennamen das Pipesymbol, gefolgt vom Vorgabewert, angegeben wird.
Die gewählte Farbe ist {{{Farbe|blue}}}.
Da man Vorlagen auch als Artikel sehen sollte und in eine gute Vorlage auch ein kurzer Text über die Verwendung, die Anzahl, die Namen und den Sinn der verwendeten Variablen gehören, besteht die Notwendigkeit die eigentliche Vorlage von dem Teil zu trennen, der beschreibenden Charakter hat.
Zu diesem Zweck gibt es die drei Tags <noinclude></noinclude>, <includeonly></includeonly> und <onlyinclude></onlyinclude>.
Jeder Inhalt, der innerhalb des noinclude-Tags steht, wird beim Einbinden der Vorlage nicht verarbeitet und nicht angezeigt. Dieser Bereich eignet sich also für die Beschreibung der Vorlage und Metadaten, wie die Kategorisierung der Vorlage.
Jeder Inhalt, der innerhalb des includeonly-Tags steht, wird nur auf der Seite angezeigt, welche die Vorlage einbindet, nicht aber auf der Seite der Vorlage selber. Auf diese Weise lassen sich beispielsweise Seiten, die diese Vorlage verwenden, einer bestimmten Kategorie zuweisen.
Inhalte, die innerhalb des onlyinclude-Tags stehen, werden sowohl auf der Seite der Vorlage selbst als auch auf der einbindenden Seite angezeigt.
Mehr Infos dazu gibt es bei der Wikipedia.
Tipps und Tricks
- Hier folgen noch ein paar Tipps und Tricks.
- Subst
- Variablen
- Parserfunktionen
