Permanently protected template

Template:Tlx

From Festipedia, hosted by the FR Heritage Group
Jump to navigation Jump to search


Template documentation[view] [edit] [history] [purge]
{{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

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 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.
  • 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}} 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.
  • {{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 Help:Templates#subst. This is useful to indicate when a template should be substituted. For example {{Tlx|Deletion proposed|subst=Y}} will display {{subst:Deletion proposed}}.

Usage

{{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