Template:Tlx/doc
 | This is a documentation subpage for Template:Tlx. It contains usage information, categories and other content that is not part of the original template page. |
Template:High-risk Template:Used in system This template is used to show example template usage without expanding the template itself.
Basic use
(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)
- {{tlxTemplate:\sandbox|tlx|Template|first parameter|second parameter|third|...|twentieth}} produces: {{tlxTemplate:\sandbox|Template|first parameter|second parameter|third|...|twentieth}}
Where parameters might contain one or more equals-signs ("="), replace each equals-sign with Template:Tlf:
- {{tlxTemplate:\sandbox|tlx|Template|first{{=}}something|second|third{{=}}something|...|twentieth}} produces: {{tlxTemplate:\sandbox|Template|first=something|second|third=something|...|twentieth}}
For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki> thus:
- {{tlxTemplate:\sandbox|tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} produces: {{tlxTemplate:\sandbox|Template|first|second|third=something|...|999th}}
Purpose and naming
Mnemonically, template link expanded (after template link).
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 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in |. A keyword parameter can be used with equals code = 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. If you use 21 or more parameters, all after the 20th will be replaced with a single |... at the end of the parameter list.
- Exceptions
If the intended template lists numerous parameters, then perhaps this template should really Template:Em 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 the only parameter supplied is Template:Param, i.e. a template's name,
{{tlx}}'s output is the same as{{tl}}– i.e. a link within braces – but in a monospaced font:- Template:Tc produces: {{tl}}
- Template:Tc produces: {{tlxTemplate:\sandbox|tl}}
{{tl}}will also not take nor display additional parameters.
- Named parameters
|subst=
- Setting this parameter to any non-blank value will prefix the string
subst:linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example, {{tlxTemplate:\sandbox|tlx|Welcome|3=subst=Y}} produces: {{tlxTemplate:\sandbox|Welcome|subst=Y}}. This is similar to the action of the {{tlxTemplate:\sandbox|tlxs}} template: {{tlxTemplate:\sandbox|tlxs|Welcome}} produces: Template:Tlxs.
|SISTER=
- For an interwiki link to other sister projects, such as:
|SISTER=M:(Meta),|SISTER=Q:(WikiQuote),|SISTER=S:(WikiSource), etc, facilitating interwiki template documentation and/or discussion.
|LANG=
- For a link to Wikipedias in other languages, such as:
|LANG=de:(German),|LANG=sv:(Swedish), etc, facilitating cross-language template documentation and/or discussion.
Documentation
{{Tlx}} is a generalization of {{tl}}, {{tlp}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as "Template:Thinsp{Template:Thinsp", "Template:Thinsp|Template:Thinsp", "Template:Thinsp}Template:Thinsp" and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}, see {{tlw}}, which makes the click target bigger).
Usage
{{tlx|Templatename}}{{tlx|Templatename|param}}{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10|more}}{{tlx|Templatename|param=value}}
There are up to 10 placeholders for parameters of the specified template.
Examples
- Note
- At the en.wikipedia and Meta sites, X0, X1, X2, ... X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other sister projects.
- Unlimited parameters as one
<nowiki>...</nowiki>string - {{tlxTemplate:\sandbox|tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
See also
- {{tlxb}}, a version of Template:Tlf where the template name is shown in bold.
- {{tlb}}, a version of Template:Tlf where the template name is shown in bold.
- {{temt}}, a version of Template:Tlf that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
- {{para}}, for the presentation of template parameters and values (e.g.
|paraname=val,|another=).
Template-linking templates
Template:Template-linking templates
TemplateData for Tlx
<templatedata> { "params": { "1": { "label": "Template name", "description": "Name of the template to link", "example": "Tlx", "type": "wiki-template-name", "required": true }, "2": { "label": "1st parameter", "type": "string" }, "3": { "label": "2nd parameter", "type": "string" }, "4": { "label": "3rd parameter", "type": "string" }, "5": { "label": "4th parameter", "type": "string" }, "6": { "label": "5th parameter", "type": "string" }, "7": { "label": "6th parameter", "type": "string" }, "8": { "label": "7th parameter", "type": "string" }, "9": { "label": "8th parameter", "type": "string" }, "10": { "label": "9th parameter", "type": "string" }, "11": { "label": "10th parameter", "type": "string" }, "12": {}, "subst": { "description": "Set to any value to show \"subst:\" before the template name", "example": "true", "type": "boolean" }, "LANG": { "label": "Language", "description": "For a link to Wikipedias in other languages", "example": "de:", "type": "string" }, "SISTER": { "description": "For an interwiki link to other sister projects", "example": "M:", "type": "string" } }, "description": "Show example template usage without expanding the template itself.", "paramOrder": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "subst", "LANG", "SISTER" ], "format": "inline" } </templatedata> Template:Collapse bottom