साँचा:Tlc/doc

{{

 साँचा:namespace detect

| type = notice | image = | imageright = | class = | style = margin-bottom:1.0em; | textstyle = | text = साँचा:strong for साँचा:terminate sentence
It contains usage information, categories and other content that is not part of the original साँचा page. | small = | smallimage = | smallimageright = | smalltext = | subst = | date = | name = }}

This is the साँचा:tlc template.

This page also provides the full documentation for the templates साँचा:tlx and साँचा:tlx, which work almost exactly identically.

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, साँचा:tlc, or साँचा:tlc templates.

These templates work similarly to साँचा:tlc and साँचा:tlc, 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 साँचा:tlx or साँचा:tlx, and then use साँचा:tlc, साँचा:tlc or साँचा:tlc thereafter.

Template	Mnemonic	Format differentiation
साँचा:tlc	Template link code	Uses the <code>...</code> tags meant for showing programming code.
साँचा:tlc	Template link dialup-host	Uses the <tt>...</tt> tags sometimes used for showing programming code. Essentially the non-linking equivalent of साँचा:tlx.
साँचा:tlc	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 साँचा:tlx.

The three names were based on साँचा:tlx template link', despite the fact that, unlike the actual साँचा:tlc template, these three don't include an actual link. The mnemonics for साँचा:tlc and साँचा:tlc were invented after the fact, since the template creator used the single letters still available rather than the preferred साँचा:tlc (using <tt>) and साँचा:tlc (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 = साँचा:tlc

साँचा:tlc = साँचा:tld

साँचा:tlc = साँचा:tlf

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 साँचा:tl template, followed by their request, to the Talk page. The साँचा:tlc template expands to a texty notice which includes the instruction, "Replace the साँचा:tlc template with साँचा:tlc 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 साँचा:tlc 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 साँचा:tlc template means that the template should appear in a normal, proportional font-face, as in "साँचा:tlf".

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, साँचा:tlc and साँचा:tlc:
  • They show a template name and up to eight parameters.
  • They also show empty parameters. (See examples below.)
  • They prevent line wraps in their output.

Usage

साँचा:tlc → {{Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

साँचा:tlc → {{Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

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