Vorlagen sollen innerhalb von Artikeln eines Wikis bestimmte Funktionen auslösen und dienen z.B. als Hilfe bei der Formatierung oder zur Anzeige häufig verwendeter kurzer Texte.
Ein Beispiel ist:
{{Inuse}}
Dabei wird bei jedem Seitenaufruf des Artikels, der diese Vorlage verwendet, der aktuelle Inhalt der Vorlage an der entsprechenden Stelle in den Artikel eingesetzt und damit verbundene Funktionen werden ausgeführt.
Manchmal wird auch der Aufruf {{Vorlage:Inuse}} verwendet, obwohl bereits mit den Klammern {{ und }} die Funktion als Vorlage ausgelöst wird.
Die MediaWiki-Software stellt einige vordefinierte Vorlagen als Variablen bereit, z. B. {{PAGENAME}} und {{NUMBEROFARTICLES}}
2 Vorlagen erzeugen und ändern
Eine Vorlage wird wie jede andere Wikiseite erzeugt, indem man einen Link [[Vorlage:Name]] auf seiner Benutzerseite anlegt, dem Link folgt und die neue Seite mit dem gewünschten Inhalt füllt. Der Name für die Vorlage sollte bereits auf die Hauptfunktion hinweisen, z.B. als Navigationsleiste oder Infobox.
Siehe auch: Neue Seite anlegen
Bevor eine neue Vorlage erzeugt wird, sollte geprüft werden, ob es bereits ähnliche Vorlagen gibt, die sich bewährt haben. Vorlagen aus anderen Wikis funktionieren nicht immer und sollten daher nicht 1:1 übernommen werden.
Beim Ändern einer Vorlage sollte zunächst die Dokumentation gelesen werden, sofern diese vorhanden ist. Es ist sinnvoll, zu jeder Vorlage eine Erläuterung zu schreiben und die Vorlage selbst in eine passende Unterkategorie der Kategorie:Vorlage: einzusortieren. Insbesondere bei mehreren Funktionen und vielen Parametern ist eine Dokumentation wichtig.
3 Parameter
Der Vorlage kann man zusätzlich Parameter übergeben. Dazu gibt es zwei Schreibweisen:
{{Titel|wert1|wert2}}
{{Titel|name1=wert1|name2=wert2}}
Die Werte der Parameter lassen sich in der Vorlage verwenden, indem man sie in drei geschweifte Klammern setzt.
{{{1}}}, {{{2}}}
{{{name1}}}, {{{name2}}}
4 Beschreibung und Erläuterungen zur Vorlage
Die Beschreibung und weitere Erläuterungen, wie Anwendungs-, bzw. Aufrufbeispiele, sind vom <noinclude> … </noinclude> Tag zu umschließen.
Der Text zwischen diesen Tags wird beim Aufruf der Vorlage ignoriert.
5 Anteile der Vorlage nur Einfügen
Anteile der Vorlage, die nur beim Einfügen benötigt werden und in der Vorlage selber unwirksam sein sollen, werden zwischen <includeonly> … </includeonly> plaziert.
Der Text zwischen diesen Tags wird dann nur beim Aufruf der Vorlage wirksam.
So kann man z. B. erreichen, dass zwar Seiten, die die Vorlage aufrufen, in eine Kategorie K eingefügt werden, nicht jedoch die Vorlage selber, indem man den Bezug auf die Kategorie K (also [[Kategorie:K]]) in der Vorlage in einen von <includeonly> und </includeonly> begrenzten Abschnitt stellt.
6 Verwendung der Vorlagen
Über die Seite Special:Allpages nach Auswahl des Namensraums „Vorlage“ kann man sich sämtliche zur Verfügung stehenden Vorlagen anzeigen lassen. Ein Großteil der Vorlagen wurden vor längerer Zeit aus der Wikipedia übernommen und können sich dort seitdem verändert haben. Auch hier in der Pluspedia wurden Änderungen vorgenommen, so dass die Übernahme von Texten einschließlich der Vorlagen aus der Wikipedia nicht mehr ohne weiteres zu empfehlen ist. Vor der Benutzung einer Vorlage sollten die Funktionen mit der Vorschau überprüft und ggf. die Dokumentation gelesen werden. Die Dokumentationen befinden sich meist in der Kategorie:Vorlage:nur Dokumentation und sind über einen Link so eingebunden, dass sie bei Lesen der Vorlage angezeigt werden. Falls es keine Dokumentation gibt, sollte diese erstellt werden.
Es ist zu beachten, dass nicht alle Funktionen einer Vorlage sofort ausgeführt werden. So erfolgt der automatische Eintrag in die Kategorien oft mit zeitlicher Verzögerung. Dies ist insbesondere bei der Änderung von Vorlagen zu berücksichtigen.
7 Hinweise
Zu einzelnen technischen Fragen dient die Vorlagenwerkstatt. Hier werden nur die wichtigsten Hinweise aufgeführt.
7.1 Problem: Senkrechter Strich in Parameterwerten
Da das Zeichen „|“ zur Trennung von Parametern dient, darf es nicht selbst in Parameterwerten vorkommen. Es kann durch | vertreten werden, es sei denn, es soll Tabellensyntax in Parameterwerten verwendet werden. Dafür gibt es dann die folgenden speziellen Vorlagen, die ausschließlich in Parameterwerten eingesetzt werden sollten:
Vorlage
|
{{!}}
|
{{!-}}
|
{{!!}}
|
{{!-!}}
|
{{!}}+
|
{{!~}}
|
{{(!}}
|
{{!)}}
|
Inhalt
|
|
|
|-
|
||
|
|- |
|
|+
|
|- !
|
{|
|
|}
|
Ein verwandtes Problem tritt bei den geschweiften Klammern „{{“ und „}}“ auf. Werden diese Zeichenfolgen selbst eingegeben, so versucht der Interpreter den dazwischenliegenden Text auf Gedeih oder Verderb als Vorlage zu interpretieren. Mit den folgenden Vorlagen kann man durch bedingte Abfragen erreichen, dass der Interpreter nur notwendige Substitutionen vornimmt, man unterbindet somit unnötige Kaskaden. Diese Vorlagen sollen ausschließlich in Parameterwerten eingesetzt werden:
Vorlage
|
{{((}}
|
{{))}}
|
Inhalt
|
{{
|
}}
|
Zur Darstellung von einfach geschweiften Klammern können { für { und } für } verwendet werden. Eine lesbarere Variante ist es, den Text in nowiki-Tags einzufassen, wenn nichts darin als Vorlage interpretiert werden soll.
7.2 Untervorlagen
Größere Teile einer Vorlage oder bewährte Funktionen wie Tabellen, die in mehreren Vorlagen verwendet werden, können auch auf eine Unterseite (Untervorlage) geschrieben und dann eingebunden werden. Die Dokumentation zu einer Vorlage gehört ebenfalls auf eine Unterseite.
8 Siehe auch
9 Quellen
|