Template:Tlx

From Wikipedia, the free encyclopedia
Jump to: navigation, search


Documentation icon Template documentation[view] [edit] [history] [purge]

This {{tlx}} template documentation is transcluded for all tlx family templates (tlx, tlxc, tlxw, tlxb) [edit].master page 

(In the following examples, three dots indicate where parameters have been omitted.)

Basic use
{{tlx|Template|first parameter|second parameter|third|...|tenth}}{{Template|first parameter|second parameter|third|...|tenth}}

Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{=}}:

{{tlx|Template|first{{=}}something|second|third{{=}}something|...|tenth}}{{Template|first=something|second|third=something|...|tenth}}

For more than ten parameters, possibly also containing equals-signs, use:

{{tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}}{{Template|first|second|third=something|...|999th}}

Purpose and naming

Mnemonically, "[t]emplate [l]ink e[x]panded" (after {{tl}}, "[t]emplate [l]ink").

This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.

Up to ten of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 10 parameters can be displayed using a coded vertical-bar (as in "&#124;..."). A keyword parameter can be used with equals code &#61; or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>" or all parameters as a string in "<nowiki>" tags; see Examples at bottom. For more details, see this talk page.

  • Exceptions: If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with <code><nowiki>, for example: <code><nowiki>{{Anytemplate|arg1=23|size=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>.

Parameters

  • 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 noticeably clearer font and spacing on most modern browsers.
    • {{Tl|Tl}} display compared to {{Tlx|Tl}}: (Tl: {{Tl}} versus Tlx: {{Tl}})
  • Comparatively, {{Tl}} will not take or display additional parameters, and for minor technical reasons, may be preferred for mere listing and referencing in long pages involving a lot of template expansions.
  • {{Tlx}} has a named parameter |subst=. Setting this parameter to any non-blank value will place the string "subst:" before the template name, linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example {{Tlx|Welcome|subst=Y}} will display {{subst:Welcome}}. This is similar to the action of the {{tlxs}} template: {{Tlxs|Welcome}} will display {{subst:welcome}}.
  • Additionally, Tlx will take a named parameter |SISTER= to link interwiki to other sister projects such as one of these examples: |SISTER=M: (Meta), |SISTER=Q: (WikiQuote), |SISTER=S: (WikiSource), etc. allowing documentation or discourse about a template across interwiki boundaries.
  • Tlx will also take a named parameter |LANG= to link to other language Wikipedias, such as one of these examples: |LANG=de: (German), |LANG=sv: (Swedish), etc. allowing documentation or discourse about a template across language boundaries.

Documentation

{{Tlx}} is a generalization of {{Tl}}, {{Tlp}}, et cetera 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|template name}}
{{Tlx|template name|param}}
{{Tlx|template name|1|2|3|4|5|6|7|8|9|10}}
{{Tlx|template name|1|2|3|4|5|6|7|8|9|10&#124;more}}
{{Tlx|template name|param&#61;value}}

Up to 10 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|4|5|6|7|8|9|10}} {{x3|1|2|3|4|5|6|7|8|9|10}}  
{{Tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} {{x4|1|2|3|4|5|6|7|8|9|10|...}} up to 10 parameters, then ...
{{Tlx|x5|1|2|3|4|5|6|7|8|9|10&#124;11}} {{x5|1|2|3|4|5|6|7|8|9|10|11}} &#124; for more
{{Tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}} unlimited parameters as one nowiki string
{{Tlx|x1|x=u}} {{x1}} = won't work
{{Tlx|x1|x&#61;u}} {{x1|x=u}} &#61; 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|&#32;|two}} {{x2| |two}} &#32; is okay
{{Tlx|x2|&nbsp;|two}} {{x2| |two}} &nbsp; is okay
{{Tlx|x2| &#124; two}} {{x2| | two}} &#124; 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:Tlxb – same as {{Tlx}}, but gives the template name in boldface type (this can be useful when stressing the difference between two similarly named templates). Template:Tlb is the same, except it uses regular text instead of a monospaced non-proportional font.
  • Template:Temt, – same as {{Tlx}}, but handles template names with the Template: prefix and templates not in the Template: namespace {{ns:10}}.
  • Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.
Template-linking templates

Templates by syntax

1 = {{tlg}} is the most general, allowing any combination of text style and/or link style options.
2 = Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.

Templates with example

code example effect note tc's
{{lts|Hatnote}} Template:Hatnote (edit talk links history) 14k
{{t links|Hatnote}} Hatnote (edit · talk · history · links · /subpages · /doc · /doc edit · /sbox · /sbox diff · /test · Module:hatnote) For intensive template editing
{{tfd links|Hatnote}}
Template:Hatnote (edit|talk|history|links|logs|delete)
Used in WP:TfD
{{tiw|Hatnote}} Template:hatnote (backlinks, edit) 300
{{tl|Hatnote}} {{hatnote}} 2.5M
{{tl2|Hatnote|lang=fr}} {{hatnote}} Sister and other language wikis (e.g., fr:Hatnote) 2600
{{tla|Hatnote|some label}} {{some label}} To add a wikilabel 1000
{{tlb|Hatnote}} {{hatnote}} TfD 82
{{tlc|Hatnote}} {{hatnote}} 200k
{{tld|Hatnote}} {{hatnote}} 14k
{{tlf|Hatnote}} {{hatnote}} 8000
{{tlg|Hatnote}} {{hatnote}} 14k
{{tlp|Hatnote}} {{hatnote}} 194k
{{tls|Hatnote}} {{subst:hatnote}} 21k
{{tlsp|Hatnote|Some text}} {{subst:Hatnote|Some text}} 4500
{{tlu|User:Ahunt/SSHFS}} {{User:Ahunt/SSHFS}} Any namespace 4600
{{tlx|Hatnote}} {{hatnote}} 850k
{{tlxb|Hatnote}} {{hatnote}} TfD 22
{{tlxi|Hatnote}} {{hatnote}} Italicises params. TfD 8
{{tlxs|Hatnote}} {{subst:hatnote}}
{{tn|Hatnote}} {{hatnote}} TfD 12k
{{tnull|Hatnote}} {{hatnote}} 4000
{{xpd|Hatnote|Some hatnote text}} "{{hatnote|Some hatnote text}}" gives " " [1] Show expanded text 64