Template:Tlc/doc

From statwiki
Jump to: navigation, search


This is the Template:tlc template.

This page also provides the full documentation for the templates Template:tlx and Template: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 Template:tlc, Template:tlc, or Template:tlc templates.

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

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

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

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

Template:tlc{{Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

Template:tlc{{Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

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

CodeResultComment
Template:tlc Template:tlc Shows its own syntax.
Template:tlc Template:tlc
Template:tlc Template:tlc
Template:tlc Template:tlc
{{tlc|name|a|b|c|d|e|f|g|h|i|j}} Template:tlc Shows up to eight parameters. The rest are dropped.
Template:tlc Template:tlc Also shows empty parameters.
Template:tlc Template:tlc Even shows empty parameters that come in the end.
Template:tlc Template:tlc The use of equals signs is a problem, but there is a fix; see next row.
Template:tlc Template:tlc Use numbered parameters to fix the problem with equals signs. Remember to start from 2, since the "name" is number 1.
  • Exceptions: If the intended template lists numerous/keyword parameters, then perhaps this template should really not be used, and just hardcode the usage with <code><nowiki>, for example: <code><nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki></code>. 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>.

If you have equals signs in your template parameters then it probably is simpler and clearer to code it using <nowiki> tags, etc. Here are the codes to emulate Template:tlc, Template:tlc and Template:tlc respectively. Code is to the left and actual rendering to the right:

<nowiki>{{name|one=a|two=b}}</nowiki> = {{name|one=a|two=b}}
<tt><nowiki>{{name|one=a|two=b}}</nowiki></tt> = {{name|one=a|two=b}}
<code><nowiki>{{name|one=a|two=b}}</nowiki></code> = {{name|one=a|two=b}}

See also

  • Template:tl – Not linked, several parameters and text in <code></code> style.
  • Template:tl – Not linked, several parameters and teletype text style.
  • Template:tl – Not linked, several parameters and normal text style.
  • Template:tl – Template link, no parameters and normal text style.
  • Template:tl – Template link, several parameters and interwiki links, teletype text style.
  • Template:tl – Same as Template:tlf, but shows the braces as part of the link.