Vorlage:Vorlage/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:Vorlage.

Beschreibung

Mit dieser Vorlage lässt sich ein Vorlagenname von geschweiften Klammern eingeschlossen darstellen, d. h. er wird so angezeigt wie er direkt im Wikitext (Quellcode) zum Einbinden der Vorlage verwendet wird. Standardmäßig wird der Vorlagenname zur Vorlage selbst verlinkt, sodass gezielt auf zu verwendende Vorlagen und deren Dokumentation hingewiesen werden kann. Zusätzlich können zur Vorlageneinbindung benötigte Parameter und deren Inhalt angegeben werden um die Vorlagenverwendung zu dokumentieren und Kopiervorlagen zu erstellen.

Zum Verlinken von Commons-Vorlagen empfielt sich die Verwendung von Vorlage:Commonsvorlage.

Beispiel

Diese Vorlage ist ein intuitives Hilfsmittel um dem Benutzer die nötige Textformatierung abzunehmen und automatisch einen Link zu setzen.
Vereinfacht wird folgender Wikitext erzeugt: {{[[Vorlage:Vorlagenname|]]}}

Die Angabe von {{Vorlage|Vorlage}} wird dargestellt als {{Vorlage}}.

Verwendung der Vorlage

Syntax	Erklärung	Beispiel	Ergebnis
{{Vorlage|Name der Vorlage}}	Im einfachsten Fall wird lediglich der Name der Vorlage benötigt.	{{Vorlage|Hallo}}	{{Hallo}}
{{Vorlage|Name der Vorlage|nolink=ja}}	Wenn der Parameter nolink einen (beliebigen) Wert hat, wird die Vorlage nicht verlinkt.	{{Vorlage|Hallo|nolink=ja}}	{{Hallo}}
{{Vorlage|Name der Vorlage|subst=ja}}	Wenn der Parameter subst einen (beliebigen) Wert hat, wird der Prefix subst: für die Vorlagenersetzung mit angegeben.	{{Vorlage|Unterschreiben|subst=ja}}	{{subst:Unterschreiben}}
{{Vorlage|Name der Vorlage|parameter1=wert1|parameter2=wert2}}	Parameter können auch kombiniert werden.	{{Vorlage|Unterschreiben|nolink=ja|subst=ja}}	{{subst:Unterschreiben}}
{{Vorlage|Name der Vorlage|Parameter}}	Zusätzlich können bis zu 9 unbenannte Parameter angegeben werden. Diese Parameter beeinflussen nicht die Darstellung sondern werden als Text angezeigt.	{{Vorlage|Löschen|deine Begründung --~~~~}}	{{Löschen|deine Begründung --~~~~}}

Hinweis zur Darstellung von Parametern

Das Gleichheitszeichen "=" ist in unbenannten Parametern nicht erlaubt. Sollen Paare der Form parameter=wert dargestellt werden muss es deshalb durch die HTML-Entität = oder die Angabe <nowiki>=</nowiki> ersetzt werden:

{{Vorlage|In SVG konvertieren|Vektordaten=www.test.de}} ergibt {{In SVG konvertieren|Vektordaten=www.test.de}}

{{Vorlage|In SVG konvertieren|Vektordaten<nowiki>=</nowiki>www.test.de}} ergibt {{In SVG konvertieren|Vektordaten=www.test.de}}

Alternativ können die unbenannten Parameter durchnummeriert und wie benannte Parameter verwendet werden. Dann ist auch das Gleichheitszeichen erlaubt. Zu beachten ist jedoch, dass der Name der Vorlage stets der erste unbenannte Parameter ist. Die Nummerierung beginnt also bei "2":

{{Vorlage|1=In SVG konvertieren|2=Vektordaten=www.test.de}} ergibt {{In SVG konvertieren|Vektordaten=www.test.de}}

{{Vorlage|In SVG konvertieren|2=Vektordaten=www.test.de}} ergibt {{In SVG konvertieren|Vektordaten=www.test.de}}

Hinweis zur Verwendung für andere Namensräume

Für Vorlagen im Vorlagen-Namensraum genügt die Angabe des Vorlagennamens (ohne den Prefix Vorlage:).

Wenn die Vorlage nicht im Vorlagen-Namensraum, sondern z. B. im Benutzer-Namensraum liegt, kann diese auf dieselbe Weise benutzt werden, allerdings muss der Prefix Benutzer: vorangestellt werden:

{{Vorlage|Benutzer:Church of emacs/geSLAt}} ergibt {{Benutzer:Church of emacs/geSLAt}}

Falls die Seite im Artikelsnamensraum liegt, muss (genau wie bei der Einbindung als Vorlage im Wikitext) ein Doppelpunkt davor gesetzt werden:

{{Vorlage|:Deutschland}} ergibt {{:Deutschland}}

Im Gegensatz zu Links in den Artikelnamensraum erfordert die Einbindung einer Kategorie- oder Dateibeschreibungsseite keinen Doppelpunkt:

{{Vorlage|Kategorie:!Hauptkategorie}} ergibt {{Kategorie:!Hauptkategorie}}

Abgekürzte Varianten

Zur schnellen und einfachen Verwendung der Vorlage existieren Weiterleitungen von Kurztiteln auf diese Vorlage. Diese sollen aber aus Gründen der Transparenz, der Nachvollziehbarkeit für Anfänger und der Quelltextlesbarkeit nicht im Artikelnamensraum verwendet werden.

Volle Darstellung	Abgekürzte Variante
{{Vorlage|Name der Vorlage}}	{{tl|Name der Vorlage}} (von engl.: template link)
{{Vorlage|Name der Vorlage|nolink=ja}}	{{tnl|Name der Vorlage'}} (von engl.: template non-linked)