Template:Tlc/doc

From Project: Gorgon Wiki
Jump to: navigation, search

Description

This is the {{tlc}} template.

This page also provides the full documentation for the templates {{tld}} and {{tlf}}, 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 does not 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}}, {{tld}}, or {{tlf}} templates.

These templates work similarly to {{tl}} and {{tlx}}, but do not 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}}, {{tld}} or {{tlf}} thereafter.

Template Mnemonic Format differentiation
{{tlc}} Template link code Uses the <code></code> tags meant for showing programming code.
{{tld}} Template link dialup-host Uses the <tt></tt> tags sometimes used for showing programming code. Essentially the non-linking equivalent of {{tlx}}.
{{tlf}} Template link format-normal Uses proportional-spaced font, normal for regular text, rather than a monospace font 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 {{tl}} template, these three do not 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}}
{{tlf|name|parameters}}{{name|parameters}}

Use with editprotected templates

Most Admin Tools Wiki users will have little or no need for use (or knowledge) of these templates. You will find them of more use if you are a creator, editor, and/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 cannot 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.
  • Features of {{tlc}}, {{tld}} and {{tlf}}:
    • 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 name|first_parameter|second|third|fourth|...|eighth}}
{{Template name|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}
  • {{Tld|Template name|first_parameter|second|third|fourth|...|eighth}}
{{Template name|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}
  • {{Tlf|Template name|first_parameter|second|third|fourth|...|eighth}}
{{Template name|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|name}} {{name}}
{{tlc|name|one}} {{name|one}}
{{tlc|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.
{{tlc|name|||three|four}} {{name|||three|four}} Also shows empty parameters.
{{tlc|name|||three||}} {{name|||three||}} Even shows empty parameters that come in the end.
{{tlc|name|one=a|two=b}} {{name}} The use of equals signs is a problem, but there is a fix; see next row.
{{tlc|name|2=one=a|3=two=b}} {{name|one=a|two=b}} 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> tags.
  • If you have equals signs in your template parameters then it probably is simpler and clearer to code it using <nowiki></nowiki> tags, etc.
    Here are the codes to emulate {{tlf}}, {{tld}} and {{tlc}} respectively.
    Code is to the left and actual rendering to the right:
  • {{tlf}} → <nowiki>{{name|one=a|two=b}}</nowiki> … produces … {{name|one=a|two=b}}
  • {{tld}}<tt><nowiki>{{name|one=a|two=b}}</nowiki></tt> … produces … {{name|one=a|two=b}}
  • {{tlc}}<code><nowiki>{{name|one=a|two=b}}</nowiki></code> … produces … {{name|one=a|two=b}}

See also

Template:Tl-nav