Template:Tlx/doc

Template:Mbox

---

Basic use

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

{{tlx|Template|first parameter|second parameter|third|...|tenth}} Template:Bigger {{Template|first parameter|second parameter|third|...|tenth}}

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

{{tlx|Template|first{{=}}something|second|third{{=}}something|...|tenth}} Template:Bigger {{Template|firstTemplate:=something|second|thirdTemplate:=something|...|tenth}}

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

{{tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} Template:Bigger {{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 "|..."). 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.

• 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}}, etc., with arguably better-readable output. This depends on the browser, but too-narrow uses of "{", "|", "}" in conjunction with links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}, see {{tln}}, which makes the click target bigger).

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|more}}

{{tlx|template name|param=value}}

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

{{tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}

See also

• Template:Tlxb, a version of Template:Tlspc where the template name is shown in bold.

  Template:Tlb, a version of Template:Tlspc where the template name is shown in bold.

• Template:Temt, a version of Template:Tlspc that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
• Template:Para, for the presentation of template parameters and values (e.g. |paraname=val, |another=, etc).

General-purpose formatting

• ¹ {{tlg}} is the most general, allowing any combination of text style and/or link style options.
• ² Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
• ³ Allows links to templates in any namespace.
• ⁴ {{tlg|plaincode[[:Template:=]]yes}} uses <code style="border:none; background:transparent;">...</code>.
• ⁵ Displays monospaced font using <kbd>...</kbd> tags (changed from <tt>...</tt> for HTML5 compliance).
• ⁶ Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	{{User:Ahunt/SSHFS}}	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:If	Shows code, example and a link to expand the template code
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix

With utility links

Code example	Effect
{{lts|Hatnote}}	Template:Lts
{{t links|Hatnote}}	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) · Module:hatnote
{{tfd links|Hatnote}}	Template:Hatnote (edit · talk · history · links · logs · subpages · delete)
{{tiw|Hatnote}}	Template:hatnote (backlinks edit)
{{tltt|Hatnote}}	{{Hatnote}}
{{tetl|Hatnote}}	{{Hatnote}} links talk view
{{tsetl|Hatnote}}	{{subst:Hatnote}}  links talk view
{{ti|Hatnote}}	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
{{tic|Hatnote}}	Template:Hatnote (talk links edit)
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	{{Hatnote}} (talk)
{{ttl|Hatnote}}	Template:Main other{{Hatnote}} (t/l)
{{twlh|Hatnote}}	Template:Hatnote (links, talk)