Template:Tlc/doc

This page provides documentation for {{tlc}} and {{tld}}.

Purpose and naming

When a template name with braces is to be shown in documentation, the braces have to be escaped in some way so it doesn't become an actual call to the template. Instead of using <nowiki></nowiki> tags you can write it more simply and concisely by using the {{tlc}} or {{tld}} templates.

These templates work similarly to {{tl}} and {{tlx}}, but don't make the template name into a link. When writing documentation you might want to avoid a lot of unnecessary links, since they can decrease readability. So on the first occurrence of a template name use {{tl}} or {{tlx}}, and then use {{tlc}} or {{tld}} thereafter.

Template	Mnemonic	Format differentiation
{{tlc}}	Template link code	Uses the <code>...</code> tags meant for showing programming code. Essentially the non-linking equivalent of {{tlx}}.
{{tld}}	Template link dialup-host

The names were based on {{tl}} template link, despite the fact that, unlike the actual {{tl}} template, these templates don't include an actual link. The mnemonics for {{tld}} and {{tlf}} were invented after the fact, since the template creator used the single letters still available rather than the preferred {{tlt}} (using <tt>) and {{tln}} (using "normal", non-coded text style) monikers.

Basic operation

Here is how these templates look. Code is to the left; actual rendering to the right:

{{tlc|name|parameters}} = {{name|parameters}}

{{tld|name|parameters}} = {{name|parameters}}

Use with editprotected templates

Most Wikipedia users and even editors will have little or no need for use (or knowledge) of these templates. You will find them of more use if you are a writer or documenter of templates. However, editors may be pointed here when attempting to deal with edit requests on pages which have been protected in some way.

Pages which have been protected can't be edited by every user, but would-be editors can request specific changes on the corresponding Discussion page. An editor requesting a change to a semi-protected page, for example, would add the {{editsemiprotected}} template, followed by their request, to the Talk page. The {{editsemiprotected}} template expands to a texty notice which includes the instruction "Replace the {{editsemiprotected}} template with {{tlf|editsemiprotected}} when the request has been accepted or rejected." An empowered editor acting on the request would then change the template per this instruction.

The desired effect is to replace the {{editsemiprotected}} template (with its big, eye-catching box of information) by the name of the template, merely showing that the template had been there, and acted upon. The use of the {{tlf}} template means that the template should appear in a normal, proportional font-face, as in "{{editsemiprotected}}".

Documentation

Functional details

• This template takes another template-name and some associated pipe-tricked (numbered) parameters (or 'pass parameters'), and displays them as an 'example demonstration' of how the template-name template could be coded, literally. Its primary use is in instruction and documentation.
• Specifics here???
• Features of {{tlc}} and {{tld}}:
  • They show a template name and up to eight parameters (tlc) or ten parameters (tld).
  • They also show empty parameters. (See examples hereafter.)
  • They prevent line wraps in their output.

Usage

{{Tlc|Template|first_parameter|second|third|...|eighth}} → {{Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

{{Tld|Template|first_parameter|second|third|...|tenth}} → {{Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth|ninth|tenth}}

Examples

Note: A different background color was used in the following table to make the "code colouring" visible.

Code	Result	Comment
{{tlc}}	{{tlc|...}}	Shows its own syntax.
{{tld}}	{{Tlc/doc}}
{{tlc|name}}	{{name}}
{{tld|name}}	{{name}}
{{tlc|name|one}}	{{name|one}}
{{tld|name|one}}	{{name|one}}
{{tlc|name|one|two}}	{{name|one|two}}
{{tld|name|one|two}}	{{name|one|two}}
{{tlc|name|a|b|c|d|e|f|g|h|i|j}}	{{name|a|b|c|d|e|f|g|h}}	Shows up to eight parameters. The rest are dropped.
{{tld|name|a|b|c|d|e|f|g|h|i|j|k|l}}	{{name|a|b|c|d|e|f|g|h|i|j|…}}	Shows up to ten parameters. The rest are replaced by an ellipsis.
{{tlc|name|||three|four}}	{{name|||three|four}}	Also shows empty parameters.
{{tld|name|||three|four}}	{{name|||three|four}}
{{tlc|name|||three||}}	{{name|||three||}}	Even shows empty parameters that come in the end.
{{tld|name|||three||}}	{{name|||three||}}
{{tlc|name|one=a|two=b}}	{{name}}	The use of equal signs is a problem, but there is a fix; see next row.
{{tld|name|one=a|two=b}}	{{name}}
{{tlc|name|one{{=}}a|two{{=}}b}}	{{name|one=a|two=b}}	Use {{=}} in place of an equal sign, so that it gets rendered properly.
{{tld|name|one{{=}}a|two{{=}}b}}	{{name|one=a|two=b}}
{{tlc|name|{{IPA|/tʃ/}}|two}}	{{tlc|name|/tʃ/|two}}	Nested template calls also cause problems ...
{{tlc|name|{{tlf|IPA|/tʃ/}}|two}}	{{tlc|name|{{IPA|/tʃ/}}|two}}	... but there are ways to get around this issue, also.
{{tlc|name|{{((}}IPA{{!}}/tʃ/{{))}}|two}}	{{tlc|name|{{IPA|/tʃ/}}|two}}	... another way to do the same thing, using {{((}}, {{!}} and {{))}} to insert literal {{, | and }}, respectively.

An alternative to using constructs such as {{=}} and {{tlf|...}} to prevent characters from getting interpreted syntactically is to use <code><nowiki>...</nowiki></code>, which will prevent all characters from being interpreted. For example, in place of

{{tlc|name|one{{=}}{{tlf|IPA|/tʃ/}}|two}}

you can use

<code><nowiki>{{name|one={{IPA|/tʃ/}}|two}}</nowiki></code>

Both render as

{{name|one={{IPA|/tʃ/}}|two}}

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

Here are the codes to emulate {{tlc}} and {{tld}} using <nowiki>:

Using templates:	Using <nowiki>:	Rendered result:
{{tlc|name|one{{=}}a|two{{=}}b}}	<code><nowiki>{{name|one=a|two=b}}</nowiki></code>	{{name|one=a|two=b}}
{{tld|name|one{{=}}a|two{{=}}b}}	<code><nowiki>{{name|one=a|two=b}}</nowiki></code>	{{name|one=a|two=b}}

Limitations

As documented at Help:Template#Problems and workarounds, template arguments starting with one of the four MediaWiki magic characters : ; * or # are interpreted as if they were at the beginning of a line, and are formatted as HTML lists. To avoid this, references to {{*}} or {{#expr}} must have the first character escaped. You can either use <nowiki /> or an escape like #.

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 " [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)