قالب:Tlx/doc
ظاهر
< قالب:Tlx
| This is a documentation subpage for قالب:Tlx (see that page for the قالب itself). It contains usage information, categories and other content that is not part of the original قالب page. |
| Similar templates at English sister projects [edit] | |||
|---|---|---|---|
| wpd | Wikipedia | Tlx/doc | |
| cms | Commons | Tlx/doc | |
| wbk | Wikibooks | Tlx/doc | |
| wsp | Wikispecies | Tlx/doc | |
| wvy | Wikiversity | Tlx/doc | |
{{tlx|template|first parameter|second|etc.}} → {{template|first parameter|second|third|etc.}}
Purpose and naming
[دچينواچين]Mnemonically 'Template link expanded'... after {{tl}} Template link'
- This template takes another template-name and some associated pipe-tricked (numbered) parameters (or 'pass parameters'), and displays them as an 'example demonstration' of how the template-name template could be coded, literally. Its primary use is in instruction and documentation.
- Specifics: Up to five pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 5 parameters can be displayed using a coded vertical-bar (as in "|..."). A keyword parameter can be used, when tagged as a nowiki-keyword: "<nowiki>siz=10<\nowiki>" with each keyword parameter surrounded by "<nowiki>" tags; see Examples at bottom. For more details, see the this talk page.
- Exceptions: If the intended template lists numerous/keyword parameters, then perhaps this template should really not be used, and just hardcode the usage with
<code><nowiki></code>, for example: <code><nowiki><code><nowiki>{{Anytemplate|arg1=23|siz=250px|other parameters...}}</nowiki></code>. If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with<pre>...</pre>.
- If given no additional parameters except
'template name' ({{{1}}}),it presents the same as the similar {{Tl}} macro template -- a blue link nested in curly-braces-- the same as a user would apply the template without parameters, but with a noticably clearer font and spacing on most modern browsers.
- Comparatively, {{Tl}} will not take or display additional parameters, and for minor technical reasons, may preferred for mere listing and referencing in long pages involving a lot of template expansions1.
- Additionally, Tlx will take a 'named' parameter 'SISTER' to link interwiki to other sister projects such as one of these examples: '|SISTER=W:', 'Tlx|SISTER=M:', 'Tlx|SISTER=Q:', 'Tlx|SISTER=S:', allowing documentation or discourse about a template across interwiki boundaries. Small 'front end' Shell or convience templates {{Tlxw}} and {{Tlxm}} are typing-aid templates available at Meta for automatic substitution in discussions about templates on Wikipedia or Meta.
- This usage also applies to interwiki capable template variations
- {{Tlxc}} -- which links to templates on Wikimedia Commons (The Commons).
- {{Tlxm}} -- which links to templates on Meta
- {{Tlxw}} -- which links to templates on Wikipedia
Documentation
[دچينواچين]{{Tlx/doc}} is a generalization of قالب:Tlxw, قالب:Tlxw, etcetera with arguably better readable output. This depends on the browser, but too narrow uses of "{", "|", "}" in conjunction with links can be hard to read.
Usage
[دچينواچين]- {{Tlx/doc|template name}}
- {{Tlx/doc|template name|param}}
- {{Tlx/doc|template name|1|2|3}}
- {{Tlx/doc|template name|1|2|3|more}}
- {{Tlx/doc|template name|param=value}}
Up to three placeholders for parameters of the specified template
Examples
[دچينواچين]| Code | Result | Remark |
|---|---|---|
{{Tlx|x0}} |
{{x0}} | |
{{Tlx|Abc}} |
{{Abc}} | |
{{Tlx|ABC}} |
{{ABC}} | |
{{Tlx|AbC}} |
{{AbC}} | |
{{Tlx|x1|one}} |
{{x1|one}} |
|
{{Tlx|x2|one|two}} |
{{x2|one|two}} |
|
{{Tlx|x3|1|2|3}} |
{{x3|1|2|3}} |
|
{{Tlx|x4|1|2|3|4}} |
{{x4|1|2|3|etc.}} |
up to 5 parameters, then ... |
{{Tlx|x4|1|2|3|4}} |
{{x4|1|2|3|4}} |
| for more |
{{Tlx|x1|x=u}} |
{{x1}} | = won't work |
{{Tlx|x1|x=u}} |
{{x1|x=u}} |
= is okay |
{{Tlx|x1|x{{=}}u}} |
{{x1|x=u}} |
{{=}} is okay |
{{Tlx|x1|<nowiki>x=u</nowiki>}} |
{{x1|x=u}} |
sticky nowiki is okay |
{{Tlx|x2| |two}} |
{{x2|two}} |
empty won't work |
{{Tlx|x2| |two}} |
{{x2| |two}} |
  is okay |
{{Tlx|x2| |two}} |
{{x2| |two}} |
is okay |
{{Tlx|x2| | two}} |
{{x2| | two}} |
| is okay |
{{Tlx|x2| {{!}} two}} |
{{x2| | two}} |
{{!}} is dubious |
{{Tlx|x2|2=|3=two}} |
{{x2|two}} |
empty really doesn't work |
{{Tlx|x2|2=one|two}} |
{{x2|two}} |
two clobbers 2=one |
{{Tlx|x2|3=two|2=one}} |
{{x2|one|two}} |
right to left okay |
See also
[دچينواچين]Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.