Hilfe:Vorlagen
Eine Vorlage ist eine Seite, die nach dem Transklusionsprinzip die Einbindung häufig verwendeter Elemente in andere Seiten erleichtert. Vorlagen wurden ursprünglich „Bausteine“ genannt, die zunächst auch nicht durch Parameter beeinflusst werden konnten. Im einfachsten Fall sind es vorformulierte Textbausteine, die auf einer anderen Seite eingefügt werden können.
Prinzipiell können Seiten sämtlicher Namensräume wie eine Vorlage verwendet (transkludiert) werden. Die Verwendung des Vorlagen-Namensraums ist jedoch bei Vorlagen, die in Artikeln verwendet werden sollen, generell zu bevorzugen. Elemente, die spezifisch für ein einzelnes Portal, eine Redaktion, Wikiprojekt oder Benutzer sind, sollen nicht im Vorlagen-Namensraum angelegt, sondern als Unterseite im eigenen Bereich intern betreut werden.
Häufig enthalten Vorlagen auch die Möglichkeit, veränderliche Daten einzufügen, binden grafische Elemente ein und verwenden mehr oder weniger komplexe Programmierungen. Auf diese Art werden beispielsweise die Einbindung von Personendaten, Infoboxen, die Georeferenzierung und Navigationsleisten realisiert.
Vorlagen verwenden
Um eine einfache Vorlage in einer Seite zu verwenden, gibt es in der Quelltextbearbeitung drei Möglichkeiten (zum VisualEditor siehe hier):
- Im Hauptanwendungsfall fügst du eine Vorlage mit
{{Titel}}ein. Beim Anzeigen der Seite ersetzt die MediaWiki-Software dies dann durch den Inhalt der Vorlage „Titel“. Ändert jemand die Vorlage, ändert sich dadurch auch die Darstellung. -
{{subst:Titel}}(für Substitution) oder auch{{ers:Titel}}(für Ersetzen) fügt ebenfalls den Inhalt der Vorlage ein, ersetzt den Titel der Vorlage jedoch auch in der Bearbeitungsumgebung (die Ansicht, die man erhält, wenn man oben auf den Reiter „Seite bearbeiten“ geklickt hat) durch den eigentlichen Text der Vorlage. Auf diese Art werden zum Beispiel neue Benutzer begrüßt, die anschließend auf ihrer Seite auch beim Bearbeiten den Text der Begrüßung vorfinden sollen und kein verwirrendes {{Hallo}}. Andere Vorlagen sind so konstruiert, dass man sie mit{{subst:Titel}}einbindet, z. B. die Vorlage Löschantrag. Mehr zu{{subst}}unter Hilfe:Substitution. {{msgnw:Titel}}zeigt in der Seite den Quellcode der Vorlage an. Diese Funktion wird extrem selten – eigentlich nur zur Erklärung von Vorlagen – gebraucht.
Seiten, die nicht im Namensraum Vorlage stehen, lassen sich dennoch als Vorlage verwenden, wenn man den Namensraum mit angibt. Zum Beispiel würde {{Wikipedia:Fragen zur Wikipedia}} die Seite Wikipedia:Fragen zur Wikipedia als Vorlage einbinden. Will man eine Seite aus dem Artikelnamensraum einbinden, muss allerdings noch ein Doppelpunkt vor den Namen gesetzt werden: So würde {{:Test}} beispielsweise den Artikel Test wie eine Vorlage einbinden; der Name des Namensraums ist hier „leer“.
Zur vollständigen Beschreibung der Interpretation einer Einbindung siehe hier.
Vorlagen erstellen
Vorlagen werden wie jede andere Seite erstellt und bearbeitet: Wähle einen geeigneten (selbsterklärenden) Namen, gehe auf diese Seite und klicke auf den Erstellen-Tab oder den Bearbeiten-Tab. Wie bereits erwähnt, werden Vorlagen standardmäßig im Vorlagen-Namensraum erstellt bzw. nach Tests dorthin verschoben. Vorlagen können zur Eigenverwendung eines Autors oder zu Testzwecken auch im Benutzernamensraum als Unterseite erstellt werden, diese sollen dann allerdings nicht im Artikelnamensraum verwendet werden. Alle Funktionalitäten, die andere Seiten enthalten können, können auch Vorlagen beinhalten. Grundsätzlich sind enzyklopädische Inhalte und Aussagen in den Artikeln darzustellen, davon ausgenommen sind Metadaten, um die Wartung selbiger für Nutzer zu vereinfachen. Damit ist explizit auch die Auslagerung häufig eingebundener Funktionen in Untervorlagen bzw. weitere Vorlagen gemeint. Vorlagen nutzen programmierbare Eigenschaften wie Parameter und Parserfunktionen, was den eingebundenen Inhalt von Vorlagen stark variieren lässt. Es existieren ebenso Tags, die ein bedingtes Einbinden von Inhalt einer Vorlage steuern können.
Vor dem Erstellen einer Vorlage suche nach bereits bestehenden Vorlagen (etwa durch Nachschauen in Kategorie:Vorlage:), um Dopplungen zu vermeiden. Existiert bereits eine ähnliche Vorlage, so steht es dir frei, diese um das Gewünschte zu erweitern. Zeitweise sind auch parallele Verwendungen zweier ähnlicher Vorlagen möglich, sofern gleiche bzw. ähnliche Vorlagen entweder zusammengeführt werden oder diese verändert werden, um sich stärker voneinander abzugrenzen. Schau auch nach ähnlichen Vorlagen bzw. Vorlagen für Vorlagen (Kategorie:Vorlage:für Vorlagen), deren Inhalt du ggf. kopieren und anpassen kannst.
Es existieren keine genauen Regeln für die Auswahl eines Vorlagennamens; er sollte jedoch für alle anderen Autoren ausreichend beschreibend sein, dann so kurz wie möglich. Abkürzungen mit weniger als vier Buchstaben sollten ausgesuchten Anwendungen vorbehalten sein. Existieren bereits ähnliche Vorlagen, dann nutze eine konsistente Benennung. Vorlagen können umbenannt (bzw. verschoben) werden, ohne dass bestehende Einbindungen verloren gehen, solange die entstehende Weiterleitung bestehen bleibt oder die Einbindung korrigiert wird. Für Infoboxen, Positionskarten, Navigationsleisten und vieles andere mehr existiert eine Standardform, bei der der Vorlagentyp wie ein Präfix vorangestellt wird; anschließend folgt mit Großschreibung und wo angebracht nach der Singularregel die Bezeichnung, die auch als Überschrift dienen könnte.
Wenn eine Vorlage ausschließlich einer einzelnen Seite oder einer kleinen und begrenzten Gruppe von Seiten außerhalb des Artikel-Namensraums dienen soll, etwa einem Portal, dann sollen keine Vorlagen im Vorlagen-Namensraum angelegt werden, sondern Unterseiten in diesem Kontext. Sie können genau wie Vorlagen eingebunden werden.
Vorlagen, die ausschließlich dazu bestimmt sind, einer einzigen Vorlage oder einer eng begrenzten Gruppe verwandter Vorlagen zuzuarbeiten, und in der Regel nicht von außerhalb benutzt werden sollen, werden nur als Unterseite der zentralen Vorlage angelegt. Aus technischen Gründen kommt das häufiger vor; dann wird oft der Name /core für die Kernfunktionalität benutzt.
Sei vorsichtig, wenn du bestehende Vorlagen bearbeitest, diese können teils sehr komplex, häufig eingebunden oder auch beides zugleich sein. Daher sind viele Vorlagen ab einer gewissen Zahl an Einbindungen auf Anfrage gesperrt. Ebenso können Vorlagen wie alle anderen Seiten zum Löschen vorgeschlagen werden.
Einsatzmöglichkeiten
Vorlagen sind nur dann sinnvoll, wenn es von ihnen nur eine überschaubare Anzahl gibt, die sich Benutzer auch merken können. Insbesondere sollten Vorlagen nicht doppelt oder sehr ähnlich entstehen. Um dies zu verhindern, sollten Vorlagen von allgemeiner Relevanz gefördert werden, indem sie in eine spezielle Liste in alphabetischer Reihenfolge eingetragen werden: Wikipedia:Textbausteine und/oder Wikipedia:Bewertungsbausteine bzw. Wikipedia:Textvorlagen.
Vorlagen dienen in Wikipedia zur:
- Konsistenzmaximierung: Mit Vorlagen lässt sich ein einheitliches Erscheinungsbild erreichen. Bekannte Beispiele sind etwa die Vorlage:Begriffsklärung oder Vorlage:Commons.
- Redundanzminimierung: Wenn der Inhalt zentral nur an einer Stelle festgelegt wird (d. h. in einer Vorlage), dann erscheint der Inhalt in allen Artikeln gleich, auch bei einer nachträglichen Änderung. Das mühselige und fehlerträchtige Übertragen einer Änderung in jeden Artikel entfällt. Bekannte Beispiele sind hier Datenbanklinks und die so genannten Navigationsbausteine. Dazu gehört auch die Auslagerung von Metadaten, die so zentral aktualisiert werden.
- Workflowoptimierung: Mit einer Vorlage kann ein Wikiautor prägnant anderen Wikiautoren mitteilen, in welche Richtung ein Artikel verbessert werden sollte. Bekannte Beispiele sind: Vorlage:URV (Urheberrechtsverletzung), Vorlage:Überarbeiten oder Vorlage:Löschantrag. Bei der Verwendung der Vorlagen wird der Artikel automatisch in spezielle Kategorien für andere Wikiautoren oder Administratoren eingetragen.
- Codeoptimierung: Manche schöne Darstellung lässt sich nur mit einem unschönen Mix aus Wiki-, HTML- bzw. CSS-Befehlen erreichen. Der Artikelquellcode wird dann schnell unübersichtlich und verschreckt Wikianfänger, sich an der weiteren Verbesserung eines Artikels zu beteiligen. Hier kann eine Vorlage helfen, den Artikelquellcode lesbarer zu gestalten. Ein bekanntes Beispiel ist Vorlage:Gesprochene Version.
- Auswertung: Neben der einheitlichen Präsentation lassen sich die der Vorlage übergebenen Daten (Parameter) auch automatisiert auswerten. Insbesondere Geodaten lassen sich vielfältig weiternutzen.
Keine Themenringe
Wie unter Wikipedia:Themenring nachzulesen, sollen in der deutschsprachigen Wikipedia keine Themenringe erstellt werden. Zulässig sind ausschließlich Navigationsleisten oder andere Zusammenstellungen wie auch Linkboxen, die eine vollständige Aufzählung gleichrangiger Elemente enthalten (z. B. Vorlage:Navigationsleiste Deutsche Länder, Lokomotiven der Baureihe XY).
Unerwünschte Verwendungen
Vorlagen sollten nicht dienen als:
- Benutzersignaturen: Die Idee, Vorlagen für die eigene Benutzersignatur zu verwenden, mag ja gut klingen: Man muss nur die Vorlage ändern und alle Signaturen, die man irgendwann mal hinterlassen hat, werden „aktualisiert“. Dabei sollte man aber die nicht ganz offensichtliche Tatsache bedenken, dass jede Benutzung einer Vorlage eine zusätzliche Anfrage an die Datenbank bedeutet und somit die Wikipedia belastet, ohne zum eigentlichen Zweck derselben beizutragen. Daher sind Signaturvorlagen nicht erwünscht. Man sollte lieber zu seinen alten Signaturen stehen.
- Ersetzung von Zeichenketten: Die Ersetzung von regelmäßig vorkommenden Zeichenketten durch Vorlagen mag praktisch sein (beispielsweise
{{BND}}statt[[Bundesnachrichtendienst]] der Bundesrepublik Deutschland), sind jedoch unerwünscht. Solche Vorlagen haben im normalen Wikitext nichts zu suchen und sind deshalb auch nicht anzulegen.
Bedingtes Einbinden von Quelltextblöcken
Folgende Tags sollten nur innerhalb von Seiten verwendet werden, die auch wie eine Vorlage eingebunden werden:
<onlyinclude>- Wenn die Vorlage direkt betrachtet wird, haben
<onlyinclude>und</onlyinclude>keine Wirkung auf alles, was dazwischen steht. Wenn die Vorlage jedoch auf einer anderen Seite eingebunden ist, wird ausschließlich angezeigt, was zwischen<onlyinclude>und</onlyinclude>steht. Außerhalb dieses mit<onlyinclude>festgelegten Bereichs können Dokumentation, Kategorie und Interwiki-Links in Vorlagen eingefügt werden, ohne dass diese in den Artikeln auftauchen. Es können auch mehrere nicht-verschachtelte<onlyinclude>-Blöcke in einer Vorlage stehen. - Üblich ist das auch bei Artikeln; etwa bei Personennamen-(BKS) in den zugehörigen Familiennamen: Der zentrale Inhalt von Artikel Hans Meier soll in den Zielartikel eingebunden werden, hier Meier (Familienname).
<includeonly>- Alles, was in einer Vorlage zwischen
<includeonly>und</includeonly>steht, wird nur dann angezeigt, wenn die Vorlage auf einer anderen Seite eingebunden wird. Mit<includeonly>lassen sich zum Beispiel alle Seiten, die eine bestimmte Vorlage enthalten, automatisch einer Kategorie hinzufügen.<includeonly>kann auch in<onlyinclude>-Blöcken stehen. <noinclude>- Alles, was in einer Vorlage zwischen
<noinclude>und</noinclude>steht, wird dagegen nur dann angezeigt, wenn die Vorlage selbst betrachtet wird. Die Nutzung im Vorlagencode birgt die Gefahr, dass bei Einbindung der Vorlage unbemerkt und ungewollt unerwünschte Leerzeichen oder gar Zeilenumbrüche entstehen, daher sollte bevorzugt<onlyinclude>zum Abgrenzen des eigentlichen Vorlagentextes von der Dokumentation, den Kategorien und Interwikilinks verwendet werden.<noinclude>kann auch in<onlyinclude>-Blöcken stehen.
| Tag-Kombination | Auf der Vorlagenseite sichtbar? | Einbindung? | Anmerkung |
|---|---|---|---|
| keine | Ja | Ja | Nur, wenn kein onlyinclude in der Vorlage ist. |
| <includeonly>…</includeonly> | Nein | Ja | Nur, wenn kein onlyinclude in der Vorlage ist. |
| <noinclude>…</noinclude> | Ja | Nein | Auch innerhalb von onlyinclude möglich. |
| <onlyinclude>…</onlyinclude> | Ja | Ja | Text außerhalb wird nicht eingebunden. |
| <onlyinclude><includeonly>… </includeonly></onlyinclude> |
Nein | Ja | Text außerhalb wird nicht eingebunden. |
| <includeonly>Text 2</includeonly> | Text 2: Nein | Text 2: Nein |
Beispiel
Der folgende Vorlagen-Quelltext:
Dokumentierender Text … <onlyinclude>{| class="wikitable float-right" | [[Datei:{{{1<noinclude>|Bilderwunsch.svg</noinclude>}}}|mini|{{{3}}}]] | {{{2}}} | {{{3}}} |} <includeonly>[[Kategorie:!Hauptkategorie]]</includeonly></onlyinclude> [[Kategorie:Vorlage:Linkbox]]
- erzeugt beim Betrachten der Vorlagenseite (Vorlagennamensraum) folgende Ansicht:
- erzeugt bei der Einbindung in Wikipedia (Artikelnamensraum) mittels
{{Vorlagenname|Bilderwunsch.svg|class="hintergrundfarbe5"|← Beispiel}}folgende Ansicht:
 |
← Beispiel |
Parameter einfügen und verwenden
Oft sollen in einer Vorlage Inhalte auftauchen, die sich jedoch von Seite zu Seite ändern, zum Beispiel eine Unterschrift oder der individuelle Name des Bildes auf den Commons in der Vorlage:NowCommons. Das erreicht man mit Parametern.
Im Quelltext einer Vorlage kennzeichnet man durch drei geschweifte Klammern Stellen als Platzhalter; diese können entweder durchnummeriert oder durch frei gewählte Namen bezeichnet werden. Ein Platzhalter kann auch als Wikilink fungieren, wenn er seinerseits mit zwei eckigen Klammern umgeben ist, wie zum Beispiel in [[{{{1}}}]]. Eine solche Vorlage mit Parametern verwendet man, indem man nach dem Namen der Vorlage, getrennt mit jeweils einem senkrechten Strich von diesem und voneinander, die aktuell gewünschten Werte angibt.
Parameter sind entweder nummeriert oder benannt, auch eine Mischung aus nummerierten und benannten Parametern ist möglich.
Eine Vorlage mit nummerierten Parametern sieht so aus:
Nach Angaben von Wikipedianer {{{1}}} ist diese Seite kopiert von {{{2}}}
Würde man sie auf der Seite [[Vorlage:Titel1]] abspeichern, könnte man sie so benutzen:
{{Titel1|wikiwichtel|http://www.irgendwo.de/}}
Das Ergebnis wäre der Text
Nach Angaben von Wikipedianer wikiwichtel ist diese Seite kopiert von http://www.irgendwo.de/
Dieselbe Vorlage sieht mit benannten Parametern so aus:
Nach Angaben von Wikipedianer {{{wikipedianer}}} ist diese Seite kopiert von {{{quelle}}}
Bei der Benutzung der Vorlage muss man nun die Namen auch angeben:
{{Titel 2|wikipedianer=wikiwichtel|quelle=http://www.irgendwo.de/}}
Die Ausgabe wäre identisch, wie oben.
Für nummerierte Parameter gibt es noch die Besonderheit, die Nummer als Namen zu benutzen. Dies ist hilfreich, wenn man nicht alle nummerierten Parameter davor angeben möchte bzw. Gleichzeichen in den Parametern enthalten sind. Ansonsten sollte darauf aus Gründen der Übersichtlichkeit verzichtet werden.
{{Titel1|2=http://www.irgendwo.de/}}
Nach Angaben von Wikipedianer {{{1}}} ist diese Seite kopiert von http://www.irgendwo.de/
Wenn für einen Parameter kein Wert übergeben wird, so erscheint er mit seinem Namen.
Wird ein Parameter nachträglich in eine bestehende Vorlagenprogrammierung eingefügt, müssen eventuell die verwendenden Artikel entsprechend geändert werden. Wird dies unterlassen, so wird entweder der Standardwert des Parameters verwendet oder die Änderung hat keine Auswirkungen auf den Artikel.
Daneben existieren in MediaWiki auch einige Parserfunktionen, die als Parameterwerte nützlich sind, zum Beispiel der Titel der aktuellen Seite ({{PAGENAME}}).
Achtung: Parameter im MediaWiki-Namensraum werden anders verwendet ($1, $2 …).
Vorgabe-Parameterwert definieren
Man kann einen Parameter so definieren, dass für ihn bei Gebrauch der Vorlage kein Wert angegeben werden muss. Ohne diese Angabe wird dann ein in der Vorlage vorgegebener Wert eingefügt. Bei einem Konstrukt wie {{{Titel|Vorgabe}}} wird, wenn angegeben, der Wert des Parameters Titel ausgegeben, ansonsten der Vorgabewert, der beispielsweise auch die Parserfunktion {{PAGENAME}} sein könnte.
Wichtig:
Wenn der Parameter angegeben ist, aber sein Wert leer bleibt,
{{Vorlagenname|Titel=}}
dann wird für {{{Titel|Vorgabe}}} der übergebene leere Text ausgegeben!
Nur ohne Parameter wird der Vorgabewert verwendet:
{{Vorlagenname}}
Ein gesondertes Verhalten bei leerem Wert ist niemals wünschenswert; alle Altlasten wurden eliminiert. Wird eine Vorlageneinbindung mittels VisualEditor bearbeitet, dann haben die Anwender keine Kontrolle über den entstehenden Quelltext; insbesondere wenn Parameter als „empfohlen“ deklariert wurden.
Soll der Vorgabewert also auch bei
{{Vorlagenname|Titel=}}
verwendet werden, so muss in der Vorlage stattdessen
{{#if:{{{Titel|}}}|{{{Titel}}}|Vorgabe}}
oder
{{#switch:{{{Titel|}}}|=Vorgabe|{{{Titel}}}}}
stehen.
Textformatierung
Sinn und Zweck von Vorlagen ist vor allem auch die artikelübergreifende einheitliche Darstellung von bestimmten Elementen und Texten. Insbesondere die Textformatierung sollte also soweit möglich über die Vorlage erfolgen. So sollte beispielsweise Kursivsetzung, Fettschrift oder Schriftgröße über die Programmierung der Vorlage geändert werden.
Entsprechend ist bei der Vorlageneinbindung bei der Eingabe von Parametern, die auch als Ausgabetext verwendet werden, auf Formatierungen zu verzichten, da damit die festgelegte Formatierung unterlaufen wird und eine uneinheitliche Darstellung entsteht. Dies gilt auch, wenn eine Formatierung nicht mit den aktuellen Vorgaben kollidiert. Vorlagen können auch dazu genutzt werden, eine nachträgliche Änderung über alle Vorkommen in den Artikeln zu bewirken. Individuelle Formatierungen können also auch nachträglich zu einem Problem werden.
Es kann Gründe geben, warum auch Parametertexte eine Formatierung vorsehen können, zum Beispiel wenn die Parameterbestandteile unterschiedlich dargestellt werden sollen und eine Programmierung zu aufwendig wäre. Dann sollte dies aber einheitlich erfolgen und entsprechend dokumentiert sein. Grundsätzlich ist diese Vorgehensweise aber zu vermeiden, weil sie oft nur mit viel Aufwand zu überprüfen ist und sich die Programmierer bei Vorlagenänderung auf die regelgemäße Verwendung verlassen.
Probleme bei der Benutzung von Vorlagen
Problem: Aufzählungszeichen
- Will man Aufzählungszeichen (
*oder#), wie am Anfang dieser Zeile eines steht, als Parameterwert benutzen, so sollte in der Vorlage vor dem Parameter eine neue Zeile begonnen werden, wie dies z. B. in der Vorlage:Infobox Film beim Parameter {{{Besetzung}}} für Darsteller der Fall ist.
Problem: Gleichheitszeichen in Parameterwerten
Wird einer Vorlage als Wert eines unbenannten („nummerierten“) Parameters ein Text übergeben, der ein Gleichheitszeichen enthält, nimmt die MediaWiki-Software an, vor dem ersten Gleichheitszeichen stünde der Name eines Parameters, dem der Rest des Textes hinter dem ersten Gleichheitszeichen als Wert zugewiesen werden solle. Alle Parameterangaben mit enthaltenem Gleichheitszeichen werden also als Name-Wert-Paare interpretiert und dazu am ersten Gleichheitszeichen zerlegt.
Dieses Problem tritt etwa auf, wenn man als Parameterwert an eine Vorlage eine URL übergeben will, in der ein Gleichheitszeichen enthalten ist (z. B.: https://de.wikipedia.org/w/index.php?title=Hilfe:Vorlagen&action=edit§ion=3), oder auch einen Text mit enthaltenen HTML-Attributzuweisungen, wie etwa style= in einer Dekoration.
Das Problem tritt nicht auf, wenn Gleichheitszeichen nur innerhalb von Vorlagenaufrufen im Parameterwert erscheinen.
Die Abhilfe gegen diese unerwünschte Interpretation ist, dass man dem Parameterwert den numerischen Index des Parameters und ein weiteres Gleichheitszeichen voranstellt. Dann wird wie gewünscht interpretiert, dass der Parameterwert erst hinter dem (hinzugefügten) ersten Gleichheitszeichen beginnt, und der diesem vorangestellte Index bezeichnet unmissverständlich den Zielparameter für den Wert. Die Zählung der Parameter beginnt dabei mit 1 beim ersten Parameter nach dem Vorlagennamen.
| Statt: | {{Vorlagenname|http://…/index.php?title=…&action=edit§ion=3}}
|
| Richtig: | {{Vorlagenname|1=http://…/index.php?title=…&action=edit§ion=3}}
|
| Statt: | {{Vorlagenname|erster Wert|xx<span style="font-style:italic;">kursiv</span>zz}}
|
| Richtig: | {{Vorlagenname|erster Wert|2=xx<span style="font-style:italic;">kursiv</span>zz}}
|
Danach folgende unbenannte Parameter müssen ebenfalls nummeriert werden, da die automatische Zählung die explizite Nummerierung nicht berücksichtigt, d. h. bei {{Vorlagenname|erster Wert|2=zweiter Wert|dritter Wert}} würde zweiter Wert durch dritter Wert ersetzt werden.
Im normalen Fließtext, in dem das Gleichheitszeichen keine syntaktische Bedeutung hat, kann das Gleichheitszeichen durch = maskiert werden.
Problem: Sonderzeichen in Parameterwerten
Wenn Sonderzeichen der Wikisyntax und vor allem der Vorlagensyntax in Parameterwerten benutzt werden müssen, können Probleme auftreten.
Soll das Zeichen einfach nur im dargestellten Text oder in einer URL erscheinen, ist ein Ersatz durch eine HTML-Entität die einfachste Möglichkeit. In URLs kann gegebenenfalls auch URL-Encoding verwendet werden.
| Zeichen | {
|
|
|
}
|
=
|
[
|
]
|
*
| |
|---|---|---|---|---|---|---|---|---|
| Entity | {
|
|
|
}
|
=
|
[
|
]
|
*
| |
| Zeichen | "
|
#
|
:
|
;
|
Leerzeichen | <
|
>
|
&
|
| Entity | "
|
#
|
:
|
;
|
 
|
<
|
>
|
&
|
Leerzeichen zu Beginn und am Ende von Werten benannter Parameter werden „geschluckt“; * und # am Beginn eines Parameterwertes werden als Wikisyntax für Aufzählungszeichen interpretiert, wenn innerhalb der Vorlage der Zeilenumbruch vorgesehen ist. Sind mehrere Zeichen vorhanden, ist es eine lesbarere Variante, den Text in <nowiki>…</nowiki> einzufassen, wenn nichts darin als Wikisyntax interpretiert werden soll.
Senkrechter Strich
Ob ein senkrechter Strich | („Pipe“) vom Parser als Wikisyntax interpretiert wird, hängt von der Art der Verwendung ab (siehe Tabelle). Innerhalb einer geschlossenen Einheit wie eines betitelten Wikilinks wird er nicht nach außen wirksam; gleichfalls nicht innerhalb einer geschlossenen inneren Vorlageneinbindung. Mitunter ist es erforderlich, Teilstücke eines Wikisyntax-Konstruktes wie Wikilinks oder Tabellen als Parameterwert zu übergeben, aus denen schließlich das vollständige Element zusammengesetzt werden soll. In diesem Fall empfehlen sich die nachstehend beschriebenen Vorlagen, die die Sonderzeichen einfügen und noch die spätere Interpretation als Wikisyntax zulassen. Sie sollen ausschließlich in Parameterwerten eingesetzt werden.
| | | {{!}} |
| | |
|---|---|---|---|
| Trennung von Vorlagenparametern | Ja | Nein | Nein |
| Trennung von Parametern bei Wikilinks | Ja | Ja | Nein |
| Tabellensyntax | Ja | Ja | Nein |
Tabellenelemente
Da das Zeichen | zur Trennung von Parametern dient, darf es nicht selbst in Parameterwerten vorkommen. Um dennoch eine funktionstüchtige Tabelle zu erhalten, ist die Parserfunktion {{!}} zu verwenden.
| benötigter Code | |
|
|-
|
|+
|
||
|
{|
|
|}
|
|-|
|
| Quelltext mit Parserfunktion | {{!}}
|
{{!}}-
|
{{!}}+
|
{{!}}{{!}}
|
{{{!}}
|
{{!}}}
|
{{!}}-{{!}}
|
Größere Tabellenteile können auch auf eine Unterseite der Vorlage ausgelagert und von dort eingebunden werden. Ist auch das nicht praktikabel, kann notfalls auf HTML (<td> usw.) zurückgegriffen werden.
Wikilink
Vollständige Wikilinks als Parameterwerte sind wie üblich anzugeben, also ohne besondere Maßnahmen, wenn nach einem senkrechten Strich ein Link-Titel folgt. Ist es dagegen nur ein Teil eines Wikilinks oder einer Datei-Einbindung, das erst noch zusammengebaut werden soll, so ist {{!}} statt | zu benutzen:
Nicht {{Linkvorlage|Inhalt=Lemma|Linktext}}, sondern {{Linkvorlage|Inhalt=Lemma{{!}}Linktext}}.
Eckige Klammern
Darstellung von einfachen eckigen Klammern als [ für [ und ] für ] oder Einfassung in nowiki-Tags oder Einschub von <noinclude />.
Geschweifte Klammern
Darstellung von einfachen geschweiften Klammern als { für { und } für } oder Einfassung in nowiki-Tags oder Einschub von <noinclude />.
Problem: Zuweisung von leeren Parameterwerten
Vorlagensyntax verhält sich grundsätzlich unterschiedlich, wenn ein Parameter überhaupt nicht angegeben wird oder wenn er angegeben ist, jedoch ein leerer Wert zugewiesen wird.
Viele, vor allem modernere, an allgemeine Autoren adressierte Vorlagen fangen dieses Verhalten jedoch durch eine gesonderte Programmierung ab und behandeln leere Parameterwerte und nicht angegebene Parameter gleich.
Die Zuweisung eines leeren Wertes entsteht bereits dadurch, dass zwei Pipe-Striche unmittelbar aufeinander folgen. Der entsprechende Parameter dazwischen erhält eine Wertzuweisung und gilt als angegeben.
Problem: Leerzeichen um Parameterwerte
Bei unbenannten („nummerierten“) Parametern wird grundsätzlich berücksichtigt, wenn bei der Angabe des Wertes Leerzeichen oder gar Zeilenumbrüche vor oder nach der Angabe des Wertes mitgegeben werden.
Das führt jedoch häufig zu unerwünschten Resultaten, etwa wenn eine URL dann nicht mehr korrekt in einem Stück zusammengefügt wird.
Viele, vor allem modernere, an allgemeine Autoren adressierte Vorlagen fangen dieses Verhalten jedoch durch eine gesonderte Programmierung ab und reduzieren den Wert auf seinen Nutzinhalt, wenn es für diese Anwendung sinnvoll ist. Sehr viele ältere Vorlagen sind auf diese Situation aber nicht vorbereitet.
Es sollten deshalb bei unbenannten Parametern besser niemals zusätzliche Leerzeichen angegeben werden, falls die Programmierung nicht genau bekannt ist.
Bei benannten Parametern besteht das Problem nicht; diese werden immer „getrimmt“, also aus umgebenden Leerzeichen und Zeilenumbrüchen herausgezogen.
Problem: Generisches Maskulinum in Infoboxen
Bei Berufsbezeichnungen muss nicht durchgehend das generische Maskulinum verwendet werden. Näheres siehe unter Hilfe:Infoboxen/Geschlecht.
Vorlagen dokumentieren
Siehe ausführlich: Hilfe:Vorlagendokumentation
Vorlagen, die in normalen Artikeln verwendet werden, sollten so einfach gestaltet sein, dass Zweck und Anwendung unmittelbar verständlich sind. In jedem Fall ist eine Beschreibung ihrer Funktion notwendig. Dies kann außerhalb des include-Bereichs der Vorlagenseite geschehen. Bei häufig eingebundenen Vorlagen sollte die Funktionsbeschreibung jedoch besser auf einer separaten Seite stehen; auf diese kann dann mithilfe der Vorlage:Dokumentation außerhalb des include-Bereichs der Vorlagenseite verwiesen werden. Eine Änderung der Vorlagenseite selbst bewirkt nämlich, dass alle davon abhängigen Seiten bei einem erneuten Aufruf neu generiert werden müssen, anstatt sie aus dem Cache laden zu können. Diese Serverlast sollte vermieden werden. Die vorstehende Überlegung ist allerdings auch nur relevant, wenn mit Überarbeitungen der Dokumentation bei unveränderter Funktion zu rechnen ist; das Auslagern der Dokumentation verbessert jedoch ohnedies die Übersichtlichkeit.
Ausführliche Dokumentation auf einer Unterseite
Für eine ausführliche Dokumentation eignet sich eine Unterseite der Vorlage. Dafür sollte die Systematik der Vorlage:Dokumentation verwendet werden. Diese sieht vor, dass die Funktion der Vorlage auf einer Unterseite /Doku der Vorlagenseite beschrieben wird. Der Inhalt der Unterseite erscheint dann beim Betrachten der Vorlagenseite. Die Vorlage:Dokumentation wird durch <noinclude>{{Dokumentation}}</noinclude> am Ende der Vorlage eingebunden. Zum weiteren Vorgehen siehe die Dokumentation der Vorlage:Dokumentation.
Kategorisierung
Jede Vorlage soll in eine entsprechende Unterkategorie der Kategorie:Vorlage: einsortiert werden. Achte bei der Einsortierung darauf, eine oder mehrere thematisch passende Kategorien zu finden. Eine Einsortierung von Vorlagen in Artikelkategorien ist nicht erlaubt. Eine Ausnahme sind Wartungskategorien, dort steht die Vorlage gelegentlich auch mit in der Kategorie. Bei einer Einsortierung ist zu beachten, dass dies innerhalb von <noinclude>…</noinclude> geschieht, damit nur die Vorlage der Kategorie zugeordnet wird und nicht alle Seiten, in denen die Vorlage verwendet wird. Das WikiProjekt Vorlagen hat eine Systematik zur Kategorisierung aller Vorlagen erarbeitet. Des Weiteren kann bei Bedarf eine vom Namen abweichende Sortierung der Vorlage innerhalb der Kategorie angegeben werden (etwa bei einer Infobox oder Navigationsleiste), dafür muss hinter den Kategorienamen ein senkrechter Strich und dann die Sortierung eingetragen werden ([[Kategorie:Vorlage:Unterkategorie|Sortierung]]).
Bei der Verwendung der Vorlage:Dokumentation gehören alle Metadaten, also auch die Kategorien, auf diese eine Unterseite. Nur die Programmierung und die Einbindung {{Dokumentation}} verbleiben auf der einzubindenden Seite.
Vorlagen mit speziellen Eigenschaften werden in den passenden Zweig der Kategorie:Vorlage:nach Eigenschaft eingeordnet. Beispiele wären Vorlagen, die Artikel automatisch in eine Kategorie einsortieren, oder solche mit Koordinateneinbindung.
Vorlagen testen
Vorlagen können auf der Spezialseite „Vorlagen expandieren“ getestet werden, siehe auch Hilfe:Vorlagen/Programmierung #Testen und Änderungen an Vorlagen mit komplexen Abhängigkeiten unter Spezial:Vorlagenspielwiese (Beschreibung unter Hilfe:Vorlagenspielwiese).
Vorlagen weiterleiten
Auch bei Vorlagen ist eine Weiterleitung möglich und einer redundanten Kopie der Vorlage vorzuziehen. Dabei sind sowohl dem Namen der Weiterleitung als auch dem Weiterleitungsziel der Namensraum „Vorlage:“ voranzustellen.
Weil sie jedoch verwirren, eine separate Funktionalität vortäuschen und Autoren mehr unterschiedliche Namen von Vorlagen erlernen müssen, um den Quelltext zu verstehen, sollten nach Umbenennungen die Namensvarianten nach und nach auf den eigentlichen Namen umgestellt werden.