Template:Tlc/doc

This page provides documentation for {{tlc}} (tc), {{tld}} and {{tlf}} (tnf).

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 Template:tlc (talk links edit), Template:tld (talk links edit), or Template:tlf (talk links edit) templates.

These templates work similarly to Template:tl (talk links edit) and Template:tlx (talk links edit), 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 Template:tlc (talk links edit), Template:tld (talk links edit) or Template:tlf (talk links edit) thereafter.

Template	Mnemonic	Format differentiation
Template:tlc (talk links edit)	Template link code	Uses the <code>...</code> tags meant for showing programming code. Essentially the non-linking equivalent of {{tlx}}.
Template:tld (talk links edit)	Template link dialup-host
Template:tlf (talk links edit)	Template link format-normal	Uses proportional-spaced font as is normal for regular text rather than a monospace font as typically used with programming code. Essentially the non-linking equivalent of {{tlp}}.

The three names were based on {{tl}} template link, despite the fact that, unlike the actual Template:tl (talk links edit) template, these three don't include an actual link. The mnemonics for Template:tld (talk links edit) and Template:tlf (talk links edit) were invented after the fact, since the template creator used the single letters still available rather than the preferred Template:tlt (talk links edit) (using <tt>) and Template:tln (talk links edit) (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:

Template:tlc (talk links edit) = Template:name (talk links edit)

Template:tld (talk links edit) = {{name|parameters}}

Template:tlf (talk links edit) = {{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 Template:editsemiprotected (talk links edit) template expands to a texty notice which includes the instruction "Replace the Template:editsemiprotected (talk links edit) template with Template:tlf (talk links edit) 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 Template:editsemiprotected (talk links edit) 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 Template:tlf (talk links edit) 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 Template:tlc (talk links edit), Template:tld (talk links edit) and Template:tlf (talk links edit):
  • They show a template name and up to eight parameters.
  • They also show empty parameters. (See examples hereafter.)
  • They prevent line wraps in their output.

Usage

Template:Tlc (talk links edit) → Template:Template (talk links edit)

Template:Tld (talk links edit) → {{Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

Template:Tlf (talk links edit) → {{Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

Examples

Note: Wikitables make the <code></code> tags transparent, unfortunately, so the "code colouring" is missing in these examples.

Code	Result	Comment
Template:tlc (talk links edit)	[[Template:{{{1}}}]] ([[Template talk:{{{1}}}|talk]] links edit)	Shows its own syntax.
Template:tlc (talk links edit)	Template:name (talk links edit)
Template:tlc (talk links edit)	Template:name (talk links edit)
Template:tlc (talk links edit)	Template:name (talk links edit)
{{tlc|name|a|b|c|d|e|f|g|h|i|j}}	Template:name (talk links edit)	Shows up to eight parameters. The rest are dropped.
Template:tlc (talk links edit)	Template:name (talk links edit)	Also shows empty parameters.
Template:tlc (talk links edit)	Template:name (talk links edit)	Even shows empty parameters that come in the end.
Template:tlc (talk links edit)	Template:name (talk links edit)	The use of equal signs is a problem, but there is a fix; see next row.
Template:tlc (talk links edit)	Template:name (talk links edit)	Use {{=}} in place of an equal sign, so that it gets rendered properly.
Template:tlc (talk links edit)	Template:tlc (talk links edit)	Nested template calls also cause problems ...
{{tlc|name|{{tlf|IPA|/tʃ/}}|two}}	Template:tlc (talk links edit)	... but there are ways to get around this issue, also.
{{tlc|name|{{((}}IPA{{!}}/tʃ/{{))}}|two}}	Template:tlc (talk links edit)	... 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 Template:tlf (talk links edit), Template:tld (talk links edit) and Template:tlc (talk links edit) using <nowiki>:

Using templates:	Using <nowiki>:	Rendered result:
{{tlf|name|one{{=}}a|two{{=}}b}}	<nowiki>{{name|one=a|two=b}}</nowiki>	{{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}}
{{tlc|name|one{{=}}a|two{{=}}b}}	<code><nowiki>{{name|one=a|two=b}}</nowiki></code>	{{name|one=a|two=b}}

General-purpose formatting

Comparison of template-linking templates according to their style

	Link style →	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text style ↓	↓ {{tlg}} options1 →	DEFAULT	nolink=yes	subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}}1 {{tl}} {{tlp}}2 {{tlu}}3 {{tln}}	{{tlf}}2	{{tls}} {{tlsp}}	{{tn}}	{{tla}}
code	code=yes	{{tl2}} {{tlx}} {{tlxu}}3	{{tlc}}2 {{tld}}2 {{tnull}}	{{tlxs}}	N/A
monospace kbd	plaincode=yes4 kbd=yes5	{{tltt}}5 {{tltt2}}5	N/A	{{tltts}}5 {{tltts3}}5 {{tltss}}6
bold	bold=yes	{{tlb}}	N/A
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}
1  {{tlg}} is the most general, allowing any combination of text style and/or link style options. 2  Prevents wrapping of text by placing it inside <span class="nowrap">…</span> tags. 3  Allows links to templates in any namespace. 4  {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">…</code>. 5  Displays monospaced font using <kbd>…</kbd> tags (changed from <tt>…</tt> for HTML 5 compliance). 6  Displays monospaced font using <span style="font-family:monospace;">…</span>.

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}}	Template:Tlu	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	Template:Demo	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	Template:Elc Template:Elc	Formats wikilink, with optional piped link text and blended suffix
{{mlx|Bananas|hello}}	Template: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}}	Template: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> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	Template:Dtl	Wikidata counterpart to {{tl}}

With utility links

Code example	Effect
{{lt|Hatnote}}	Template:Lt
{{lts|Hatnote}}	Template:Hatnote (edit talk links history)
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tiw|Hatnote}}	Template:hatnote (backlinks edit)
{{tltt|Hatnote}}	Template:Tltt
{{tetl|Hatnote}}	Template:Tetl
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	{{Hatnote}}
{{tic|Hatnote}}	Template:Tic
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh