Vorlage:Dokumentation Links auf Vorlagen

Dokumentation für die Vorlage {{Dokumentation Links auf Vorlagen}}[Ansicht] [Bearbeiten] [Versionsgeschichte] []

Die Vorlage dient der Dokumentation von Vorlagen zur Verlinkung und Dokumentation von Vorlagen.
Zusätzliche Dokumentationsseiten: Folgende Unterseiten erweitern die Liste und können zusätzlich auf den Dokumentationsseiten bestimmter Vorlagen eingebunden werden.

• {{Dokumentation Links auf Vorlagen/Übersicht}} – Gibt eine Übersicht über alle Vorlagen dieses Typs aus und wird standardmäßig ausgegeben.
• {{Dokumentation Links auf Vorlagen/Tlg}} – Gibt eine separate Dokumentation der allgemeinen Vorlage {{Tlg}} aus und wird automatisch nur auf ihrer Dokumentationsseite angezeigt.

Folgender Inhalt wird ausgegeben:

Funktion

Die Vorlagen {{Tl}}, {{Tlg}} und ihre Geschwister dienen dazu, Verweise auf andere Vorlagen darzustellen. Somit entfällt die Angabe des Namensraums sowie die Verwendung von Tags wie <nowiki>...</nowiki> oder <code>...</code>. Damit die verlinkten Seiten als Vorlagen erkennbar sind, werden sie in funktionslosen geschweiften Klammern dargestellt. Somit bieten sie sich auch als Kopiervorlage an. Verwendung finden sie auf Hilfe- und Dokumentationsseiten sowie in Diskussionen.

Die einfachste Vorlage ist {{Tl}}, die eine Vorlage verlinkt und in geschweiften Klammern darstellt. Beispiel für eine Ausgabe: {{VCard}}

Erweiterte Vorlagen bieten zusätzliche Formatierungen und Ausgaben. Die nachfolgende Übersicht zeigt die verfügbaren Varianten. Sie basieren auf {{Tlg}}, die mit vielen Parametern bestückt werden kann. Diese können, neben der eigentlichen Vorlage auch bis zu 10 ihrer Parameter darstellen.

Übersicht über die Vorlagen

Vorlagen für die Verlinkung zu Vorlagen

	Typ →	Verlinkt	Nicht verlinkt	Linkt mit Ersetzung	Verlinkt inklusive der ersten Klammer	Verlinkt mit alternativem Text
Text Stil ↓	{{tlg}} option1	—	nolink=yes	subst=yes	braceinside=yes	alttext=FOO
Normal	—	{{tl}} · {{tlp}}2 · {{tlg}}1, 2	{{tlf}}2	{{tls}} · {{tlsp}}	{{tn}}	{{tla}}
Code	code=yes or tt=yes	{{tlx}}	{{tlc}}2 · {{tld}} · {{tnull}}	{{tlxs}} · {{tlxsp}}
Fett	bold=yes	{{tlb}}
Kursiv	italic=yes	{{tli}}
Fetter Code	bold=yes|code=yes	{{tlxb}}	{{tlcb}}
Kursiver Code	italic=yes|code=yes	{{tlxi}}	{{tlci}}

NOTES:  1 = {{tlg}} ist die allgemeine Vorlage, die alle mögliche Kombinationen an Textsstil und Linkarten erlaubt.
2 = Schützt vor Zeilenumbrüchen durch die Verwendung des Tags <span class="nowrap">...</span>

Beispiele für die Verwendung

	Typ →	Verlinkt	Nicht verlinkt	Linkt mit Ersetzung	Verlinkt inklusive der ersten Klammer	Verlinkt mit alternativem Text
Text Stil ↓		—	nolink=yes	subst=yes	braceinside=yes	alttext=FOO
Normal	—	{{VCard}} · {{VCard}} · {{VCard}}	{{VCard}}	{{subst:VCard}} · {{subst:VCard}}	{{VCard}}	{{Listing}}
Code	code=yes or tt=yes	{{VCard}}	{{VCard}} · {{VCard}} · {{VCard}}	{{subst:VCard}} · {{subst:VCard}}
Fett	bold=yes	{{VCard|param}}
Kursiv	italic=yes	{{VCard|param}}
Fetter Code	bold=yes|code=yes	{{VCard|param}}	{{VCard|param}}
Kursiver Code	italic=yes|code=yes	{{VCard|param}}	{{VCard|param}}

Tipp

Bei der Dokumentation von Hilfsvorlagen, die im allgemeinen sehr kurz sind, kannst du statt der Vorlage {{Tl}} auf {{Tn}} zurückgreifen. Dort werden die inneren Klammern mit in den Link aufgenommen. So lässt sich besser auf die Vorlage klicken, da der Zielbereich nicht so schmal ist.

Bsp.: {{!!}} lässt sich schwerer anklicken als {{!!}}, da man genauer zielen muss.

Hinweis

• Der Parameter |bold= wirkt nur auf die Vorlagenbezeichnung
• Der Parameter |italic= wirkt nur auf die Parameter

Stilvergleich

• {{tl|Dokumentation|Parameter}} …ergibt… {{Dokumentation}} Beachte! Eine Darstellung der Parameter erfolgt hier nicht.
• {{tlp|Dokumentation|Parameter}} …ergibt… {{Dokumentation|Parameter}}
• {{tlf|Dokumentation|Parameter}} …ergibt… {{Dokumentation|Parameter}}
• {{tlc|Dokumentation|Parameter}} …ergibt… {{Dokumentation|Parameter}}
• {{tlx|Dokumentation|Parameter}} …ergibt… {{Dokumentation|Parameter}}
• {{tli|Dokumentation|Parameter}} …ergibt… {{Dokumentation|Parameter}}
• {{tlb|Dokumentation|Parameter}} …ergibt… {{Dokumentation|Parameter}}

Vorlagen zur Beschreibung von Vorlagen

Beispiele

Für die Darstellung von Beispielanwendungen gibt es zwei Vorlagen, die eine Vorlage nach dem Schema <Beispielcode> ergibt <Ausgabe> dokumentiert. Für weniger komplexe Vorlagen (z. B. namenslose Parameter) ist dieses Werkzeug gut geeignet. Beide Vorlagen packen den Beispieltext in ein <code>...</code> Tag. Bei kompliziert anzuwendenden Vorlagen versagen diese Hilfsmittel unter Umständen. Probiere es einfach aus.

• {{Tlcex|<Vorlage>|<Parameter>|...}} – Ausgabe ohne Link auf die Vorlage (für die eigene Dokumentationsseite)
• {{Tlxex|<Vorlage>|<Parameter>|...}} – Ausgabe mit Link zur Vorlage (für alle anderen Fälle)

Anwendung: {{Tlxex|Red|roter Text}} ergibt folgendes: {{Red|roter Text}} ergibt: roter Text

Parameter

• {{Para}} – dient der ausführlichen Dokumentation von Paramatern, die in Vorlagen verwendet werden
  • {{Para|bild}} ergibt: |bild=
  • {{Para||bild}} ergibt: |bild
  • {{Para|bild|Berlin.jpg}} ergibt: |bild=Berlin.jpg

Verweise auf Schwesterprojekte

Die Vorlage {{Tl2}} kann auch auf Schwesterprojekte verweisen.

• Verwendung: {{Tl2|lang=Sprachversion|sister=projektname|Name der Vorlage}}
• Beispiele:

Code	Ergebnis
{{Tl|Dummy}}	{{Dummy}}
{{Tl2|Dummy}}	{{Dummy}}
{{Tl2|sister=M|3x}}	{{3x}}
{{Tl2|sister=wikibooks|lang=de|WP}}	{{WP}}

Siehe auch

• {{Tl2}} – Wie {{Tl}}, kann aber auf jedes beliebige Schwesterprojekt verlinken, indem man Projekt und Sprachversion als Parameter übergibt.
• {{Tlt}} – Wie {{Tl}}, aber erzeugt daneben in Klammern noch einen Link zur zugehörigen Diskussionsseite.
• {{Tfd links}} – Sie kann man benutzen, wenn eine Vorlage zum Löschen vorgeschlagen wird. Sie erzeugt neben dem Link zur Vorlage auch Links zum Sandkasten, Diskussionsseite, Versionsgeschichte und Bearbeitung.
• {{T links}} – Gut für den Start von Diskussionen. Sie erzeugt neben dem Link zur Vorlage auch Links zum Sandkasten, Diskussionsseite, Versionsgeschichte und Bearbeitung.
• {{Lts}} – Erzeugt neben einem Link zur Vorlage vier klein geschriebene Links für Bearbeiten, Diskussion, Links und Versionsgeschichte.

Hinweise

• Die obige Dokumentation wurde aus der Seite Vorlage:Dokumentation Links auf Vorlagen/Doku eingefügt. (bearbeiten | Versionsgeschichte) Die Kategorien für diese Vorlage sollten in der Dokumentation eingetragen werden. Die Interwiki-Links sollten auf Wikidata eingepflegt werden.
• Liste der Unterseiten