Plantilya:Tc/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 (template link cleared). 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.

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

Code	Result	Comment
{{tlc}}	{{tlc|...}}	Shows its own syntax.
{{tld}}	{{Tc/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{{=Plantilya:))a|two{{=Plantilya:))b}}	{{name|one=a|two=b}}	Use {{=}} in place of an equal sign, so that it gets rendered properly.
{{tld|name|one{{=[[:Plantilya:))]]a|two{{=[[:Plantilya:))]]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 #.

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
{{tlg}} options to achieve link style	N/A	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}} {{tl}} Plantilya:Tlp Plantilya:Tlu	{{tlf}} <template link>	{{subst:tls}} Plantilya:Tlsu	{{tlsf}} <template link>	{{tn}}	{{tla}}
code	code=yes	Plantilya:Tl2 {{tlx}} Plantilya:Tlxu	{{tlc}} <template link> {{tnull}}<template link>	{{subst:tlxs}}	Plantilya:Tlsc <template link>	N/A
monospace	plaincode=yes	N/A		{{subst:tltss}}	N/A
kbd	kbd=yes
bold	bold=yes	{{tlb}}	N/A
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	Plantilya:Tl2	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	Plantilya:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Plantilya:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Plantilya:Xpd	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Plantilya:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Plantilya:Elc Plantilya:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	Plantilya:Ml	Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}}	Plantilya:Mlx	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}}	Plantilya:Sclx	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> Plantilya:Xtag	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Plantilya:Dtl	Wikidata counterpart to {{tl}}
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	Plantilya:Pf Plantilya:Pf	Parser function equivalent to {{tl}}
{{magic word|uc:}}	Plantilya:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	Plantilya:Lt
{{lts|Hatnote}}	Plantilya:Lts
{{t links|Hatnote}}	Plantilya:T links
{{tfd links|Hatnote}}	Plantilya:Tfd links
{{tetl|Hatnote}}	Plantilya:Tetl
{{tsetl|Hatnote}}	Plantilya:Tsetl
{{ti|Hatnote}}	Plantilya:Ti
{{tic|Hatnote}}	Plantilya:Tic
{{tim|Hatnote}}	Plantilya:Tim
{{tiw|Hatnote}}	Plantilya:Tiw
{{tlt|Hatnote}}	Plantilya:Tlt
{{ttl|Hatnote}}	Plantilya:Ttl
{{twlh|Hatnote}}	Plantilya:Twlh