Template:Tl/doc

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

The template link template is a simple macro template used to display a template name as a link surrounded by braces, thus showing the template name as code rather than actually invoking it. Its primary use is in instruction and documentation where it is used to refer to a template by name without invoking it. Note that this template may be used under the name "tee-el" (tl) as well as "tee-one" (t1)— both function the same way and produce the same results (this is not true for all such visually confusing templates containing a possible 1/l mix-up: {{Tla}} and {{T1a}} are not interchangeable). A short example of its use is:

{{tl|Example}}

which generates

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Tl

This template displays 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.

Template parameters
Parameter		Description	Type	Status
template name	`1`	the template name without the namespace prefix “Template:”, which is added automatically	Line	required

More complex variations are described below.

Examples

Code	Result	Notes
`{{tl\|Void}}`	{{Void}}	Standard usage
`{{tls\|Example}}`	{{subst:Example}}	For templates that should be substituted
`{{tl2\|X1}}`	`{{X1}}`	This formats the link to show how it would look in code (i.e., monospace font)
`{{tl2\|sister=M:\|3x}}`	`{{3x}}`	Same as above, for templates on another Wikimedia project (in this example, Meta)
`{{tl2\|sister=wikibooks\|lang=de:\|WP}}`	`{{WP}}`	For templates on another language project
`{{tl\|1==)}}`	{{=)}}	Use the format `{{tl\|1=templatename}}` if the template contains template coding characters such as {{=)}} or {{!}}

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
`{{elc\|Template:Hatnote}}` `{{elc\|Template:Hatnote\|Hatnote}}`	`[[Template:Hatnote]]` `[[Template:Hatnote\|Hatnote]]`	Formats wikilink, with optional piped link text and blended suffix
`{{mli\|Bananas\|hello}}` `{{mlix\|BananasArgs\|hello\|Fred}}`	‹See TfM›{{#invoke:Bananas\|hello}} ‹See TfM›`{{#invoke:BananasArgs\|hello\|Fred}}`	Counterparts to {{tl}} and {{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 · 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)

	Link style →	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text style ↓	↓ `{{tlg}}` options¹ →	N/A	`nolink=yes`	`subst=yes`	`braceinside=yes`	`alttext=Foo` `2=Foo`
normal	DEFAULT	`{{tlg}}`¹ `{{tl}}` `{{tlp}}`² `{{tlu}}`³ `{{tln}}`	`{{tlf}}`²	`{{tls}}` `{{tlsp}}`	`{{tn}}`	`{{tla}}`
`code`	`code=yes`	`{{tl2}}` `{{tlx}}` `{{tlxu}}`³	`{{tlc}}`² `{{tld}}`² `{{tnull}}`	`{{tlxs}}`	N/A	N/A
monospace `kbd`	`plaincode=yes`⁴ `kbd=yes`⁵	`{{tltt}}`⁵ `{{tltt2}}`⁵	N/A	`{{tltts}}`⁵ `{{tltts3}}`⁵ `{{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>`.

Template:Tl/doc

Contents

TemplateData

Examples

See also

General-purpose formatting

Other formatting templates

With utility links