ଛାଞ୍ଚ:Template link with subst

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

This template is used on approximately ୫୧,୦୦୦ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Shortcuts

{{tls}}
{{tlsp}}

This template uses Lua:

Module:Template link general

This template, often abbreviated as {{tls}}, is used to provide stylized formatting to template displays without actually using the template itself.

Parameters ସମ୍ପାଦନା

With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options.

Parameter	Action	Use with {{example}}	Default active
brace	Include braces as part of the template link	{{example}}	{{tlw}}/{{tn}}
braceinside	Include innermost braces as part of the template link	{{example}}
bold	Renders the template link/name in bold	{{example}}	{{tlb}}, {{tlxb}}
code	Display output using HTML `<code>...</code>` tags (monospaced font)	`{{example}}`	{{tlc}}, {{Template link expanded}}, etc.
italic	Display any parameters accompanying the template link/name in italics	{{example\|param}}	{{tlxi}}
kbd	Display output using HTML `<kbd>...</kbd>` tags (monospaced font)	`{{example}}`
nolink	Don't render the template name as a link	{{example}}	{{tlf}}, {{tlc}}, {{tnull}}
nowrap	Prevent the insertion of line breaks (word wrap) in the output	{{example}}
nowrapname	Prevent word wrapping in the output of template name/link (parameters will wrap if needed)	{{example}}
plaincode	Uses `<code style="border:none; background:transparent;">...</code>`	`{{example}}`	{{tltss}}
subst	Include a subst: prefix before the template link/name	{{subst:example}}	{{tls}}, {{tlxs}}, etc
`\|alttext=[text]`	Use [text] as the label for the template link	{{Other}}	{{tla}}

Unnamed (Positional) ସମ୍ପାଦନା

This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples ସମ୍ପାଦନା

Note: On the source sister projects, en.wikipedia and Meta, 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	Output	Remarks
`{{tls\|Banner}}`	{{subst:Banner}}	Banner template does not exist. Be aware with linking to non-existing templates, although desired.
`{{tls\|ok}}`	{{subst:ok}}	ok template does exist
`{{tls\|convert\|<nowiki>14\|m\|ftin\|abbr=out\|sp=us</nowiki>}}`	{{subst:convert\|14\|m\|ftin\|abbr=out\|sp=us}}	Unlimited parameters as one `<nowiki>...</nowiki>` string
`{{tls\|Abc}}`	{{subst:Abc}}
`{{tls\|abC}}`	{{subst:abC}}	template names are case-sensitive
`{{tls\|abc}}`	{{subst:abc}}	first letter is case-insensitive though
`{{tls\|abc\|{{spaces}}tls{{spaces}}}}`	{{subst:abc\| tls }}	Using {{spaces}} before and after {{{1}}} parameter.
`{{tls\|x0}}`	{{subst:x0}}
`{{tls\|x0\|code=on}}`	`{{subst:x0}}`	<code> style
`{{tls\|x0\|plaincode=on}}`	`{{subst:x0}}`	plaincode style
`{{tls\|x0\|kbd=on}}`	`{{subst:x0}}`	<kbd> style
`{{tls\|x0\|bold=on}}`	{{subst:x0}}	bold link/name
`{{tls\|x1\|one\|italic=on}}`	{{subst:x1\|one}}	parameter/s in italics
`{{tls\|x0\|nolink=on}}`	{{x0}}
`{{tls\|x0\|subst=on}}`	{{subst:x0}}
`{{tls\|x0\|brace=on}}`	{{subst:x0}}	all braces in link
`{{tls\|x0\|braceinside=on}}`	{{subst:x0}}	inside braces in link
`{{tls\|x0\|alttext=x0 link}}`	{{subst:x0 link}}
`{{tls\|x0\|bold=on\|code=on\|brace=on}}`	`{{subst:x0}}`	No reason you can't combine multiple parameter settings
`{{tls\|x1\|one}}`	{{subst:x1\|one}}
`{{tls\|x2\|one\|two}}`	{{subst:x2\|one\|two}}
`{{tls\|x2\|bold=on\|code=on\|one\|two}}`	`{{subst:x2\|one\|two}}`	Can combine named and anonymous parameters …
`{{tls\|x2\|one\|two\|bold=on\|code=on}}`	`{{subst:x2\|one\|two}}`	… in any order …
`{{tls\|x2\|one\|code=on\|two\|bold=on\|three}}`	`{{subst:x2\|one\|two\|three}}`	… even intermixed …
`{{tls\|x2\|one\|code=on\|two\|bold=on\|three\|italic=on}}`	`{{subst:x2\|one\|two\|three}}`	… with many different configurations.
`{{tls\|x3\|1\|2\|3\|4\|5\|6\|7\|8\|9\|10}}`	{{subst:x3\|1\|2\|3\|4\|5\|6\|7\|8\|9\|10}}
`{{tls}}`	tls	with no arguments, the current page name is substituted
`{{tls\|x1\|x=u}}`	{{subst:x1}}	= won't work
`{{tls\|x1\|x=u}}`	{{subst:x1\|x=u}}	`=` is okay
`{{tls\|x1\|x{{=}}u}}`	{{subst:x1\|x=u}}	`{{=}}` is okay (see template equal sign)
`{{tls\|x1\|x<nowiki>=</nowiki>u}}`	{{subst:x1\|x=u}}	sticky nowiki is okay
`{{tls\|x2\|\|two\|\|}}`	{{subst:x2\|two}}	empty parameters work too, even at the end
`{{tls\|x2\|3=two\|2=one}}`	{{subst:x2\|one\|two}}	right to left okay

Wrapping of long names (default)
Code	Output
`{{tls\|long template name that would wrap to new line\|this is a long value for the 1st parameter that would wrap}}`	{{subst:long template name that would wrap to new line\|this is a long value for the 1st parameter that would wrap}}

Wrapping of long names (`nowrap=on`)
Code	Output
`{{tls\|nowrap=on\|long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}`	{{subst:long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}

Wrapping of long names (`nowrapname=on`)
Code	Output
`{{tls\|nowrapname=on\|long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}`	{{subst:long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}

See also ସମ୍ପାଦନା

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}}` options¹ →	DEFAULT	`nolink=yes`	`subst=yes`	`braceinside=yes`	`alttext=Foo` `2=Foo`
normal	DEFAULT	`{{tlg}}`¹ `{{tl}}` `{{tlp}}`² `{{tlu}}`³	`{{tlf}}`²	`{{tls}}` `{{tlsp}}` `{{tlsu}}`³	`{{tn}}`	`{{tla}}`
`code`	`code=yes`	`{{tl2}}` `{{tlx}}` `{{tlxu}}`³	`{{tlc}}`² `{{tld}}`² `{{tnull}}`	`{{tlxs}}`	N/A
monospace `kbd`	`plaincode=yes`⁴ `kbd=yes`⁵	`{{tltt}}`⁵ `{{tltt2}}`⁵	N/A	`{{tltss}}`⁶	N/A
bold	`bold=yes`	`{{tlb}}`	N/A
`bold+code`	`bold=yes\|code=yes`	`{{tlxb}}`
`italic+code`	`italic=yes\|code=yes`	`{{tlxi}}`
¹ `{{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=yes}}` uses `<code style="border:none; background-color:transparent;">...</code>`. ⁵ Displays monospaced font using `<kbd>...</kbd>` tags (changed from `<tt>...</tt>` for HTML 5 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>}}`	{{hatnote\|lang=fr\|Some text}} Some text \|\| Shows code and example
`{{xpd\|Hatnote\|Some hatnote text}}`	`"{{hatnote\|Some hatnote text}}"` gives " Some hatnote text " [୧] \|\| 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\|Example\|hello}}`	Module:Example (talk · edit · hist · links · doc · subpages · tests (results))	Counterpart to {{tl}} for linking to Lua modules
`{{mlx\|Example\|hello}}`	`{{#invoke:Example\|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}}
`{{pf\|if}}` `{{pf\|if\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	Parser function equivalent 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)
`{{tltt\|Hatnote}}`	`{{Hatnote}}`
`{{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 ଛାଞ୍ଚ:Tlg/doc.
Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template.