User:BoldLuis/tlx

{{[[Template:|]]}}

Documentation[view] [edit] [history] [purge]

Usage Tests

{{tl|image requested}}

{{image requested}}

{{tl2|sister=m:|image requested}}

{{image requested}}

Usage

This template is a {{tl}}-style template-link tag that boldfaces the template name, and accepts parameters. It's the same as {{tlx}} except that it boldfaces the name of the template (or you can think of it as the same as {{tlb}} except that it uses <code>...</code> to provide a non-proportional, monospaced font instead of normal text). Its main use is in highlighting to distinguish between multiple templates with similar names, in documentation, talk page discussions, etc.

Examples

Code	Result	Remark
{{tlxb|abc}}	{{abc}}
{{tlxb|abc|parameter1|parameter2}}	{{abc|parameter1|parameter2}}
{{tlxb|abc|parm1|parm2{{=}}foo}}	{{abc|parm1|parm2=foo}}	Equal signs need to be escaped using {{=}}.
{{tlxb}}	{{User:BoldLuis/tlx}}	This actually substitutes the current page name. Useful as a self-reference; won't be linked.

The rest of the documentation is for {{tlx}}, which works the same way.

---

Note: This documentation for {{tlx}} is also transcluded by its derivatives {{tlxb}}, {{tlxc}} (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 parameter|...|tenth parameter}} produces: {{Template|first parameter|second parameter|third parameter|...|tenth parameter}}

When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use {{=}}, like so:

{{tlx|Template|first{{=}}first value|second|third{{=}}third value}} produces: {{Template|first=first value|second|third=third value}}

For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in <nowiki>...</nowiki> tags. When you do, you don't need to replace equals-signs. For instance:

{{tlx|Template|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}} produces: {{Template|first|second|third=value|...|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 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

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

TemplateData

TemplateData documentation used by VisualEditor and other tools

See a monthly parameter usage report for Template:BoldLuis in articles based on its TemplateData. TemplateData for BoldLuis Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template. Template parameters[Edit template data] 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 11th parameter 12 no description String optional 12th parameter 13 no description String optional 13th parameter 14 no description String optional 14th parameter 15 no description String optional 15th parameter 16 no description String optional 16th parameter 17 no description String optional 17th parameter 18 no description String optional 18th parameter 19 no description String optional 19th parameter 20 no description String optional 20th parameter 21 no description String optional Show subst: subst Set to any value to show "subst:" before the template name Example true Boolean optional Language LANG The prefix for a link to Wikipedias in other languages. Example de: Line optional Sister project SISTER The prefix for an interwiki link to other sister projects Example M: Line optional

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=).
• {{tnull}}, like {{tlx}} without linking the template.

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
{{tlg}} options to achieve link style	—	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}}	{{tlf}} <template link>	{{subst:tls}} {{subst:Template:tlsu}}	{{subst:tlsf}} <template link>	{{tn}}	{{tla}}
code	code=yes	{{tl2}} {{tlx}} {{Template:tlxu}}	{{tlc}} <template link> {{tnull}}<template link>	{{subst:tlxs}}	{{subst:tlsc}} <template link>	—
monospace	plaincode=yes	—		{{subst:tltss}}	—
kbd	kbd=yes
bold	bold=yes	{{tlb}}	—
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}}	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote | Some text | selfref = yes | category = no | lang = fr }} </syntaxhighlight>	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Same as above
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}}	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight>	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Same as above
{{tl2|Hatnote|lang=fr}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	{{hatnote|lang=fr|Some text}} Some text	Shows code and example
{{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|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tl}} for linking to Lua modules
{{mfl|Example|hello}}	{{#invoke:Example|hello}}	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example|hello}}	require('Module:Example')	Link to Lua modules and built-in libraries, showing Lua code.
{{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}}
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}
{{magic word|uc:}}	{{uc:}}	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

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 (talk · history · transclusions · logs · subpages)
{{tetl|Hatnote}}	{{Hatnote}} links talk edit
{{tsetl|Hatnote}}	{{subst:Hatnote}}  links talk edit
{{ti|Hatnote}}	Template:Hatnote (talk · links · edit)
{{tic|Hatnote}}	Template:Hatnote (talk links edit)
{{tim|Hatnote}}	m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	{{Hatnote}} (talk)
{{ttl|Hatnote}}	{{Hatnote}} (t/l)
{{twlh|Hatnote}}	Template:Hatnote (links, talk)

The above documentation is transcluded from User:BoldLuis/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 page.