Template:Tlm/doc

Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

This template provides a convenient way to refer to a template in regular text (say, in template documentation, on a help page, or on a talk page). It should not be used in articles (in the main namespace).

The displayed template name is enclosed in {{double-braces}}, linked to the template page, and rendered using a monospace font. Other similar templates that differ in terms of formatting or linking are listed below.

The name of this template refers to the fact that it shows a template name with a link, displayed as monospace text.

Parameters

Parameter name	Required?	Default value	Description
Anonymous parameter 1	Yes	(n/a)	Name of the template being linked to.

Usage

{{Tlm|Template name}}

See the template's testcases:

Correct

One anonymous parameter matching a template name

Wiki code

{{Tlm|RootCmd}}

Main version

{{RootCmd}}

Sandbox version

Incorrect

No parameter (error message)

Wiki code

{{Tlm}}

Main version

{{Tlm template error}}

Parameter 1 not defined. For correct usage see Tlm template's documentation on the 1 parameter.

Sandbox version

Multiple anonymous parameters (not supported yet)

Wiki code

{{Tlm|RootCmd|umount /mnt/gentoo}}

Main version

{{RootCmd}}

Sandbox version

One anonymous parameter containing a pipe character (makes a piped link instead)

Wiki code

{{Tlm|RootCmd{{!}}umount /mnt/gentoo}}

Main version

umount /mnt/gentoo

Sandbox version

↑ Unlike {{Tnm}}, which doesn't create a link, this template cannot (currently) illustrate a template call containing parameters.

One anonymous parameter containing a pipe and equals sign (makes a piped link instead)

Wiki code

{{Tlm|RootCmd{{!}}umount /mnt/gentoo{{!}}prompt{{=}}#}}

Main version

umount /mnt/gentoo

Sandbox version

↑ Unlike {{Tnm}}, which doesn't create a link, this template cannot (currently) illustrate a template call containing parameters.

See also

Here is the complete family of templates like this one, along with examples of their output (refer to each template's documentation for usage details and more examples):

• {{Tl}} – show template name with double-braces, linked to template page → {{C}}
• {{Tlc}} – show template name with double-braces, linked to template page, using <code> element → {{C}}
• {{Tlm}} – show template name with double-braces, linked to template page, using monospace font → {{C}}
• {{Tn}} – show template name with double-braces, not linked to template page → {{C}}
• {{Tnc}} – show template name with double-braces, not linked to template page, using <code> element → {{C}}
• {{Tnm}} – show template name with double-braces, not linked to template page, using monospace font → {{C}}

Alternative ways of referencing and/or linking to templates without using other templates include:

• Using a plain page link: [[Template:C]] → Template:C
• Using single-braces: {C} / [[Template:C|{C}]] → {C} / {{C}}
• Using double-braces around a link: {{[[Template:C|C]]}} → {{C}}
• Using a nowiki element: <nowiki>{{C}}</nowiki> → {{C}}