Vorlage:Vorlage/Doku

Vorlagenname von geschweiften Klammern eingeschlossen darstellen und verlinken, d. h. er wird so angezeigt wie er direkt im Wikitext (Quellcode) zum Einbinden der Vorlage verwendet wird.
Weil dies Vertrautheit mit Wikisyntax voraussetzt, bei der Einarbeitung jedoch mit dem VisualEditor gearbeitet wird und dann die Bedeutung der Klammern und Pipes unbekannt ist, darf diese Vorlage nicht in Hilfeseiten oder anleitenden Projektseiten benutzt werden.
Standardmäßig wird der Vorlagenname zur Vorlage selbst verlinkt, sodass gezielt auf zu verwendende Vorlagen und deren Dokumentation hingewiesen werden kann.

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
Vorlagenname	`1`	Name der Vorlage die dargestellt werden soll Beispiel Literatur	Einzeiliger Text	erforderlich
1. P-Name	`2`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|2=P-Name=Beispielinhalt` Das Gleichheitszeichen `=` ist in unbenannten Parametern nicht erlaubt. `\|P-Name=Beispielinhalt` ungültig. Zur Darstellung von `parameter=wert` sollte die HTML-Entität `=` als Ersatz eingefügt werden. Beispiel Autor=J. R. R. Tolkien	Mehrzeiliger Text	vorgeschlagen
2. P-Name	`3`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|3=P-Name=Beispielinhalt`. Beispiel Titel=Der Hobbit	Mehrzeiliger Text	vorgeschlagen
3. P-Name	`4`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|4=P-Name=Beispielinhalt`. Beispiel Verlag=Carlsen	Mehrzeiliger Text	vorgeschlagen
4. P-Name	`5`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|5=P-Name=Beispielinhalt`. Beispiel Ort=Hamburg	Mehrzeiliger Text	vorgeschlagen
5. P-Name	`6`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|6=P-Name=Beispielinhalt`. Beispiel Datum=2001	Mehrzeiliger Text	vorgeschlagen
6. P-Name	`7`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|7=P-Name=Beispielinhalt`. Beispiel ISBN=3-551-76102-7	Mehrzeiliger Text	vorgeschlagen
7. P-Name	`8`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|8=P-Name=Beispielinhalt`. Beispiel Seiten=14–27	Mehrzeiliger Text	vorgeschlagen
8. P-Name	`9`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|9=P-Name=Beispielinhalt`. Beispiel Reihe=Carlsen-Comics	Mehrzeiliger Text	vorgeschlagen
9. P-Name	`10`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|10=P-Name=Beispielinhalt`. Beispiel Originaltitel=The Hobbit	Mehrzeiliger Text	vorgeschlagen
10. P-Name	`11`	Parameternamen der Vorlage als Text mit Beispielinhalt anzeigen. Bitte möglichst als `\|11=P-Name=Beispielinhalt`. Beispiel Originalsprache=en	Mehrzeiliger Text	vorgeschlagen
Substituieren	`subst`	Vorlage über Substitution einbinden, Vorlage expandieren und einbinden. Standard `0` Beispiel `1`	Wahrheitswert	optional
Nicht verlinken	`nolink`	Wenn der Parameter nolink einen (beliebigen) Wert hat, wird die Vorlage nicht verlinkt. Standard `0` Beispiel `1`	Wahrheitswert	optional
Einbindungszähler	`counter`	Anzahl der Einbindungen hinter der Vorlage als Link anzeigen. Standard `0` Beispiel `1`	Wahrheitswert	optional
Mehrere Zeilen	`multiline`	Jeden Parameter in einer eigenen Zeile anzeigen. Standard `0` Beispiel `1`	Wahrheitswert	optional

Anmerkungen

Diese Darstellung entstammt einer Zeit, als es nur Quelltextbearbeitung gegeben hatte.

Neuere Mitwirkung erfolgt jedoch zunächst über den VisualEditor, und dort ist die Quelltextbearbeitung und die Bedeutung dieser Klammern und der Pipe-Symbole völlig unbekannt.

Die Verwendung dieser Darstellung sollte deshalb eher zurückgebaut werden und durch andere, selbsterklärende Methoden ersetzt werden. Es ist bereits nicht mehr verständlich, dass es sich um Vorlagenverwendung handeln soll, und dass das erste verlinkte Wort eine Vorlage bezeichnen soll.

Zusätzlich zum Pflichtparameter Vorlagenname (1) können die zur Vorlageneinbindung benötigten Parameter und deren Inhalt angegeben werden, um die Vorlagenverwendung zu demonstrieren oder Kopiervorlagen zu erstellen.

Diese Vorlage ist ein intuitives Hilfsmittel, um dem Benutzer die nötige Textformatierung abzunehmen und automatisch einen Link zur Vorlagenseite nebst Dokumentation zu setzen.

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

Zum Verlinken von Commons-Vorlagen empfahl sich früher die Verwendung der {{Commonsvorlage}}.

Kopiervorlagen

Mindestangabe

{{Vorlage |1= }} oder {{Vorlage | }}

Substitution

{{Vorlage |1= |subst=1}}

Unverlinkt

{{Vorlage |1= |nolink=1}}

Einbindungsabfrage

{{Vorlage |1= |counter=1}}

Alle Parameter

{{Vorlage |1= |2= |3= |4= |5= |6= |7= |8= |9= |10= |nolink= |subst= |counter=}}

Beispiele

Beispielsyntax	Ergebnis
Im einfachsten Fall wird lediglich der Name der Vorlage benötigt.
`{{Vorlage\|Hallo}}`	`{{Hallo}}`
Wenn der Parameter `nolink` einen booleschen Wert 1 hat, wird die Vorlage nicht verlinkt.
`{{Vorlage\|Hallo\|nolink=1}}`	`{{Hallo}}`
Wenn der Parameter `subst` einen booleschen Wert 1 hat, wird das Präfix `subst:` für die Vorlagenersetzung angezeigt.
`{{Vorlage\|Unterschreiben\|subst=ja}}`	`{{subst:Unterschreiben}}`
Parameter können auch kombiniert werden.
`{{Vorlage\|Unterschreiben\|nolink=1\|subst=1}}`	`{{subst:Unterschreiben}}`
Zusätzlich können bis zu 10 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 --~~~~}}`
Wenn der Parameter `counter` einen booleschen Wert 1 hat, wird ein zusätzlicher Link zur Anzeige der Anzahl aktiver Einbindungen ausgegeben.
`{{Vorlage\|Internetquelle\|counter=1}}`	`{{Internetquelle}}(Anzahl der Einbindungen)`
Wenn der Parameter `multiline` einen booleschen Wert 1 hat, wird jeder Parameter in einer eigenen Zeile angezeigt.
`{{Vorlage \|Literatur \|2=Autor=J. R. R. Tolkien \|3=Titel=Der Hobbit \|4=Verlag=Carlsen \|5=Ort=Hamburg \|6=Datum=2001 \|7=ISBN=3-551-76102-7 \|8=Seiten=14–27 \|multiline=1 }}`	`{{Literatur \|Autor=J. R. R. Tolkien \|Titel=Der Hobbit \|Verlag=Carlsen \|Ort=Hamburg \|Datum=2001 \|ISBN=3-551-76102-7 \|Seiten=14–27 }}`

Vorlage Literatur

{{Vorlage |1=Literatur |2=Autor=J. R. R. Tolkien |3=Titel=Der Hobbit |4=Verlag=Carlsen |5=Ort=Hamburg |6=Datum=2001 |7=ISBN=3-551-76102-7 |8=Seiten=14–27 |9=Originaltitel=The Hobbit |10=Originalsprache=en}}

Anzeige {{Literatur|Autor=J. R. R. Tolkien|Titel=Der Hobbit|Verlag=Carlsen|Ort=Hamburg|Datum=2001|ISBN=3-551-76102-7|Seiten=14–27|Originaltitel=The Hobbit|Originalsprache=en}}

Hinweise zur Einbindung

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}}