Template:Tlx

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

Note: This documentation for {{tlx}} is also transcluded by its derivatives {{tlxb}}, {{tlxc}}, {{tlxw}} (edit · master page).

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.)

{{tlx|Template|first parameter|second parameter|third|...|tenth}} produces: {{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}} produces: {{Template|first=something|second|third=something|...|tenth}}

For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki> thus:

{{tlx|Template|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} produces: {{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 the only parameter supplied is {{{1}}}, 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:
  • {{tl|tl}} produces: {{tl}}
  • {{tlx|tl}} produces: {{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, {{tlx|Welcome|subst=Y}} produces: {{subst:Welcome}}. This is similar to the action of the {{tlxs}} template: {{tlxs|Welcome}} produces: {{subst:welcome}}.

|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 " { ", " | ", " } " 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.

Code	Result	Remarks
{{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|11}}	up to 10 parameters...
{{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}}	{{x5|1|2|3|4|5|6|7|8|9|10|11}}	...| for more
{{tlx|x1|x=u}}	{{x1}}	the straightforward equals-sign won't work...
{{tlx|x1|x=u}}	{{x1|x=u}}	...but = is okay
{{tlx|x1|x{{=}}u}}	{{x1|x=u}}	...and {{=}} is okay
{{tlx|x1|<nowiki>x=u</nowiki>}}	{{x1|x=u}}	sticky nowiki also okay
{{tlx|x2| |two}}	{{x2|two}}	empty won't work...
{{tlx|x2|&#32;|two}}	{{x2| |two}}	...but &#32; is okay
{{tlx|x2|&nbsp;|two}}	{{x2| |two}}	...&nbsp; is also okay
{{tlx|x2|<nowiki />|two}}	{{x2||two}}	<nowiki /> handles the space
{{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" overrides "2=one"
{{tlx|x2|3=two|2=one}}	{{x2|one|two}}	irregular parameter order is okay

Unlimited parameters as one <nowiki>...</nowiki> string

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

See also

• {{tlxb}}, a version of {{tlx}} where the template name is shown in bold.

  {{tlb}}, a version of {{tl}} where the template name is shown in bold.

• {{temt}}, a version of {{tlx}} 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

General-purpose formatting

Comparison of template-linking templates according to their style

	Link style →	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text style ↓	↓ {{tlg}} options1 →	DEFAULT	nolink=yes	subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}}1 {{tl}} {{tlp}}2 {{tlu}}3	{{tlf}}2	{{tls}} {{tlsp}} {{tlus}}3	{{tn}}	{{tla}}
code	code=yes	{{tl2}} {{tlx}} {{tlxu}}3	{{tlc}}2 {{tld}}2 {{tnull}}	{{tlxs}}	N/A
monospace kbd	plaincode=yes4 kbd=yes5	{{tltt}}5 {{tltt2}}5	N/A	{{tltts}}5 {{tltts3}}5 {{tltss}}6
bold	bold=yes	{{tlb}}	N/A
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}
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. 3  Allows links to templates in any namespace. 4  {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>. 5  Displays monospaced font using <kbd>...</kbd> tags (changed from <tt>...</tt> for HTML 5 compliance). 6  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>}}	{{hatnote|lang=fr|Some text}} Some text	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	"{{hatnote|Some hatnote text}}" gives " Some hatnote text " [1]	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Hatnote	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix
{{ml|Bananas|hello}}	{{#invoke:Bananas|hello}}	Counterpart to {{tl}} for linking to Lua modules
{{mlx|Bananas|hello}}	{{#invoke:Bananas|hello}}	Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values
{{sclx|LASTING}}	[[WP:LASTING]]	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}} {{xtag|templatedata}}	<ref>...</ref> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	{{d:Ping project}}	Wikidata counterpart to {{tl}}

With utility links

Code example	Effect
{{lt|Hatnote}}	Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}}	Template:Hatnote(edit talk links history)
{{t links|Hatnote}}	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}}	Template:Hatnote (edit · talk · history · links · transclusions · 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}}	{{Hatnote}} (t/l)
{{twlh|Hatnote}}	Template:Hatnote (links, talk)

Template data

Show example template usage without expanding the template itself. Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status Template name 1 Name of the template to link Example Tlx Template required 1st parameter 2 no description String optional 2nd parameter 3 no description String optional 3rd parameter 4 no description String optional 4th parameter 5 no description String optional 5th parameter 6 no description String optional 6th parameter 7 no description String optional 7th parameter 8 no description String optional 8th parameter 9 no description String optional 9th parameter 10 no description String optional 10th parameter 11 no description String optional 12 12 no description Unknown optional subst subst Set to any value to show "subst:" before the template name Example true Boolean optional Language LANG For a link to Wikipedias in other languages Example de: String optional SISTER SISTER For an interwiki link to other sister projects Example M: String optional

The above documentation is transcluded from Template:Tlx/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.