Vorlage:Tlx/doc

Diese Seite enthält Informationen zur Verwendung für Vorlage:Tlx.

Vorlage zur Darstellung von Vorlagenaufrufen mit Parametern.

Die Vorlage {{tlx}} (tlx - ein Akronym für "template link expanded", dt. "erweiterter Vorlagen-Link") ist eine Erweiterung der Vorlage {{tl}} zur Darstellung von Vorlagenaufrufen. Mit ihr kann nicht nur der Vorlagenname, sondern auch deren Parameter angezeigt werden. Es ist fast immer besser, {{tlx}} statt {{tl}} zu verwenden, auch wenn Sie keine Parameter anzuzeigen sind, da diese das Ergebnis in einer nichtproportionalen Schriftart anzeigt.

• Verwendung von {{tl}}: {{Tl}}
• Verwendung von {{tlx}}: {{Tl}}

Offensichtlich ist {{tlx}} besser lesbarer. Es gibt zwar Verwendungsmöglichkeiten für {{tl}}, aber {{tlx}} ist oft die bessere Lösung und zusätzlich können Parameter der Vorlage dargestellt werden.

Details

Die TLX-Vorlage übernimmt den Namen einer anderen Vorlage und einige zugehörige (nummerierte) Parameter (oder "Übergabeparameter") und zeigt in einer "Beispieldemonstration" an, wie die entsprechende Vorlage eingebunden werden kann. Sie wird in erster Linie für Anleitungen und Dokumentationen verwendet.

Eigenschaften

Für die angegebene Vorlage können bis zu 10 Übergabeparameter (nummeriert oder Nowiki-Schlüsselwörter) als "Platzhalter" angezeigt werden. Mehr als 10 Parameter können mit einem codierten vertikalen Balken angezeigt werden (wie in "|..."). Ein Parameter kann mit einem kodierten Gleichheitszeichen ("=" oder "{{=}}") oder im Nowiki-Context verwendet werden ("<nowiki>size=10</nowiki>"). Alle Parameter können auch als String in "<nowiki>"-Tags angegeben werden (siehe Beispiele am Ende.

Besonderheiten

• Wenn die vorgesehene Vorlage zahlreiche Parameter auflistet, dann sollte die TLX-Vorlage besser nicht verwendet werden, sondern einfach die hardcodierte Darstellung <code><nowiki>, beispielsweise

<code><nowiki>{{Vorlage|arg1=23|size=250px|weitere Parameter...}}</nowiki></code>

Ist eine vertikale Darstellung mit Parametern in eigenen Zeilen gewünscht, so kann diese auch manuell auf diese Weise gestaltet werden oder schneller mit <pre>...</pre> erfolgen.

• Im Vergleich dazu nimmt die Vorlage {{Tl}} keine zusätzlichen Parameter an und zeigt sie auch nicht an. Aus geringfügigen technischen Gründen kann die Verwendung der Tl-Vorlage für die reine Auflistung und Referenzierung in langen Seiten mit vielen Vorlagenerweiterungen vorteilhafter sein.

• {{Tlx}} hat einen benannten Parameter "subst". Setzt man diesen Parameter auf eine beliebige Zeichenkette der Länge 1 oder größer, wird die Zeichenkette "subst:" vor den Vorlagennamen gesetzt und mit Substitution verlinkt. Dies ist nützlich, um anzuzeigen, wann eine Vorlage ersetzt werden soll. Beispiel:

{{Tlx|Welcome|subst=Y}} ergibt {{Tlx|Welcome|subst=Y}}.

• Zusätzlich nimmt die Tlx-Vorlage einen 'benannten' Parameter 'SISTER' an, um mit Schwesterprojekten in anderen Sprachen zu verlinken, beispielsweise

'|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', was die Dokumentation oder den Diskurs über eine Vorlage über Interwikigrenzen hinweg ermöglicht.

• {{Tlx}} ist eine Verallgemeinerung von {{Tl|x}}, {{Tl|x|y}}, usw. mit wahrscheinlich besser lesbarer Ausgabe. Dies hängt vom Browser ab, aber in Verbindung mit Links kann eine zu enge Verwendung von "{", "|", "}" schwer zu lesen sein.

Verwendung

{{Tlx|Vorlage}}

{{Tlx|Vorlage|Parameter}}

{{Tlx|Vorlage|1|2|3|4|5|6|7|8|9|10}}

{{Tlx|Vorlage|1|2|3|4|5|6|7|8|9|10|mehr}}

{{Tlx|Vorlage|Parameter=Wert}}

für die Parameter der entsprechenden Vorlage können bis zu 10 Platzhalter verwendet werden.

Beispiele

Hinweis

In den Quell-Schwesterprojekten en.wikipedia und Meta sind X0, X1, X2,..., X9 "Sandbox"-Vorlagen für Experimente mit bestimmten Vorlagen, die sich im Vorlagenbereich befinden müssen. Es gibt eine Software zur automatischen Reinigung, die für andere Schwester-Projekte verwendet werden kann.