Template:Tl/doc: Difference between revisions

Latest revision as of 20:30, 13 September 2023

This is a documentation subpage for Template:Tl.
It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

This template is used on 1,900,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in the template's /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added in one single edit to the template. Please consider discussing any changes on the talk page before implementing them.

The template link template is a simple macro template used to display a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation. A short example is that the code:

{{Tl|Example}}

generates

More complex variations are described below.

Example

Code	Result
`{{Tl\|Void}}`	{{Void}}
`{{Tl2\|X1}}`	`{{X1}}`
`{{Tl2\|SISTER=M:\|3x}}`	`{{3x}}`
`{{Tl2\|SISTER=wikibooks\|LANG=de:\|WP}}`	`{{WP}}`
`{{Tl\|1==)}}`	{{=)}}

	Link style	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text style	`{{tlg}}` option	—	`<syntaxhighlight lang="text" enclose="none">nolink=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">subst=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">braceinside=yes</syntaxhighlight>`	`<syntaxhighlight lang="text" enclose="none">alttext=FOO</syntaxhighlight>`
Normal	—	`{{tl}}` · `{{tlp}}` · `{{tlg}}`	`{{tlf}}`	`{{tls}}` · `{{tlsp}}`	`{{tn}}`	`{{tla}}`
`Teletype`	`<syntaxhighlight lang="text" enclose="none">tt=yes</syntaxhighlight>`	`{{tlx}}`	`{{tld}}` · `{{tnull}}`	`{{tlxs}}`
Bold	`<syntaxhighlight lang="text" enclose="none">bold=yes</syntaxhighlight>`	`{{tlb}}`
`Bold teletype`	`<syntaxhighlight lang="text" enclose="none">bold=yes\|tt=yes</syntaxhighlight>`	`{{tlxb}}`
`Italic teletype`	`<syntaxhighlight lang="text" enclose="none">italic=yes\|tt=yes</syntaxhighlight>`	`{{tlxi}}`
`Code`	`<syntaxhighlight lang="text" enclose="none">code=yes</syntaxhighlight>`		`{{tlc}}`

NOTE: {{tlg}} is the most general, allowing any combination of the above options.

Style comparison

{{tlf|Milford Haven Line|弘安源氏論議}} ...renders... {{Milford Haven Line|弘安源氏論議}}
{{tld|Milford Haven Line|弘安源氏論議}} ...renders... {{Milford Haven Line|弘安源氏論議}}
{{tlc|Milford Haven Line|弘安源氏論議}} ...renders... {{Milford Haven Line|弘安源氏論議}}

For parameter description

{{para|<var>name</var>|value}} ...renders... |name=value
{{tlx|Milford Haven Line|first parameter{{=}}first value}} ...renders... {{Milford Haven Line|first parameter=first value}}

Template:Para

@@ Line 4: / Line 4: @@
 __NOTOC__
-The '''template link''' template is a simple [[w:Macro (computer science)|macro]] [[m:Help:template|template]] used to display a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation. A short example is that the code:
+The {{b|template link}} template is a simple [[w:Macro (computer science)|macro]] [[m:Help:template|template]] used to display a template name as a link surrounded by braces, thus showing how the template name would be used in code. Its primary use is in instruction and documentation. A short example is that the code:
 ::<code><nowiki>{{Tl|Example}}</nowiki></code>

Latest revision as of 20:30, 13 September 2023

Example

See also