Get our free book (in Spanish or English) on rainwater now - To Catch the Rain.

Template:Tlx/doc

From Appropedia
Jump to: navigation, search


{{Tlx|Template|first parameter|second|third| ...|tenth|11th}}{{Template|first parameter|second|third|...|tenth|11th}}
{{Tlx|Template|<nowiki>first|second|...|999th</nowiki>}}


Purpose and naming[edit]

Mnemonically 'Template link expanded'. After <tt>{{Tl}}</tt> 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 11 pass parameters (numbered or nowiki-keywords) for the specified template are displayed as 'placeholders', and over 11 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/keyword 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>.

  • If given no additional parameters except  'template name' ({{{1}}}),  it presents the same as the similar {{Tl}} W template -- a blue link nested in W-- 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 string of length 1 or greater will place the string "subst:" before the template name, linked to wikipedia:Help:Substitution. This is useful to indicate when a template should be substituted. For example {{Tlx|Stub|subst=Y}} will display {{subst:Stub}}.
  • 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 convenience templates wikipedia:Template:Tlxw and wikipedia:Template: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
  1. wikipedia:Template:Tlxc -- which links to templates on Wikimedia Commons (The Commons).
  2. wikipedia:Template:Tlxm -- which links to templates on Meta
  3. wikipedia:Template:Tlxw -- which links to templates on Wikipedia

Documentation[edit]

{{Tlx}} is a generalization of {{Tl}}, W, 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[edit]

{{Tlx|template name}}
{{Tlx|template name|param}}
{{Tlx|template name|1|2|3}}
{{Tlx|template name|1|2|3&#124;more}}
{{Tlx|template name|param&#61;value}}

Up to three placeholders for parameters of the specified template

Examples[edit]

E.g.

{{tlx|main|Water}}

displays as:

{{main|Water}}

See: wikipedia:Template:Tlx#Examples.

External links[edit]

Wikipedia
This page or section includes content from Wikipedia. The original article was at Template:Tlx. The list of authors can be seen in the history for that page. As with Appropedia, the text of Wikipedia is available under the CC-BY-SA.

  • wikipedia: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). wikipedia:Template:Tlb is the same, except it uses regular text instead of a monospaced non-proportional font.
  • wikipedia:Template:Para – for giving examples of template parameters and values only, instead of entire templates with parameters.