View source for Template:Tlsc/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

This is the '''{{tlc|tlsc}}''' template.

This page also provides the full documentation for the templates '''{{tlx|tlsd}}''' and '''{{tlx|tlsf}}''', 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 <code>&lt;nowiki&gt;&lt;/nowiki&gt;</code> tags you can write it more simply and concisely by using the {{tlc|tlsc}}, {{tlc|tlsd}}, or {{tlc|tlsf}} templates.

These templates work similarly to {{tlc|tls}} and {{tlc|tlsp}}, 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|tls}} or {{tlx|tlsp}}, and then use {{tlc|tlsc}}, {{tlc|tlsd}} or {{tlc|tlsf}} thereafter.
 
{| class="wikitable"
|-
! Template
! style="width:15em;"|[[Wikt:mnemonic|Mnemonic]]
! Format differentiation
|-
| {{tlc|tlsc}}
| '''T'''emplate '''l'''ink '''s'''ubstitution '''c'''ode
| Uses the <code><nowiki><code>...</code></nowiki></code> tags meant for showing programming code.
|-
| {{tlc|tlsd}}
| '''T'''emplate '''l'''ink '''s'''ubstitution '''d'''ialup-host
| Uses the <code><nowiki><tt>...</tt></nowiki></code> tags sometimes used for showing programming code. Essentially the non-linking equivalent of {{tlx|tlsx}}.
|-
| {{tlc|tlsf}}
| '''T'''emplate '''l'''ink '''s'''ubstitution '''f'''ormat-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|tlsp}}.
|}

The three names were based on {{tlx|tls}} '''t'''emplate '''s'''ubstitution '''l'''ink', despite the fact that, unlike the actual {{tlc|tls}} template, these three don't include an actual link. The mnemonics for {{tlc|tlsd}} and {{tlc|tlsf}} were invented after the fact, since the template creator used the single letters still available rather than the preferred {{tlc|tlt}} (using <nowiki><tt></nowiki>) and {{tlc|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|tlsc|name|parameters}} = {{tlsc|name|parameters}}
:{{tlc|tlsd|name|parameters}} = {{tlsd|name|parameters}}
:{{tlc|tlsf|name|parameters}} = {{tlsf|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 [[Wikipedia:Protection policy|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 [[WP:Talk page|Discussion page]]. An editor requesting a change to a semi-protected page, for example, would add the {{tl|editsemiprotected}} template, followed by their request, to the Talk page. The {{tlc|editsemiprotected}} template expands to a texty notice which includes the instruction, "Replace the {{tlc|editsemiprotected}} template with {{tlc|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 {{tlc|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 {{tlc|tlf}} template means that the template should appear in a normal, proportional font-face, as in "{{tlf|editsemiprotected}}".

==Documentation==

===Functional details===

* This template takes another ''template-name'' and some associated [[Help:Pipe trick|pipe-tricked]] [[m:Parameter#Parameters|(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??? <!-- Coding details, other parameters (SUBST?), other notes? Cf. [[Template:Tlx]] -->
*Features of {{tlc|tlsc}}, {{tlc|tlsd}} and {{tlc|tlsf}}:
** They show the "subst:" needed in order to substitute a template.
** They show a template name and up to eight parameters.
** They also show empty parameters. (See examples below.)
** They prevent [[line wrap]]s in their output.

===Usage===

{{tlc|Tlc|Template|first_parameter|second|third|fourth|...|eighth}} → {{Tlc|Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

{{tlc|Tld|Template|first_parameter|second|third|fourth|...|eighth}} → {{Tld|Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

{{tlc|Tlf|Template|first_parameter|second|third|fourth|...|eighth}} → {{Tlf|Template|first_parameter|second|third|fourth|fifth|sixth|seventh|eighth}}

=== Examples ===

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

<table class="wikitable">
<tr><th>Code<th>Result<th>Comment
<tr><td>{{tlc|tlsc}} <td>{{tlsc}} <td>Shows its own syntax.
<tr><td>{{tlc|tlsc|name}} <td>{{tlsc|name}} <td>
<tr><td>{{tlc|tlsc|name|one}} <td>{{tlsc|name|one}} <td>
<tr><td>{{tlc|tlsc|name|one|two}} <td>{{tlsc|name|one|two}} <td>
<tr><td><code><nowiki>{{tlsc|name|a|b|c|d|e|f|g|h|i|j}}</nowiki></code> <td>{{tlsc|name|a|b|c|d|e|f|g|h|i}} <td>Shows up to eight parameters. The rest are dropped.
<tr><td>{{tlc|tlsc|name|||three|four}} <td>{{tlsc|name|||three|four}} <td>Also shows empty parameters.
<tr><td>{{tlc|tlsc|name|||three||}} <td>{{tlsc|name|||three||}} <td>Even shows empty parameters that come in the end.

<tr><td>{{tlc|tlsc|name|3=one=a|4=two=b}} <td>{{tlsc|name|one=a|two=b}} <td>The use of equals signs is a problem, but there is a fix; see next row.
<tr><td>{{tlc|tlsc|name|3=2=one=a|4=3=two=b}} <td>{{tlsc|name|2=one=a|3=two=b}} <td>Use numbered parameters to fix the problem with equals signs. Remember to start from 2, since the "name" is number 1.

</table>
* '''''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>&lt;code&gt;&lt;nowiki&gt;</nowiki></code>, for example: <code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{Anytemplate|arg1=23|size=250px|</nowiki><var>other parameters...</var><nowiki>}}&lt;/nowiki&gt;&lt;/code&gt;</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 <code><nowiki><pre>...</pre></nowiki></code>.

If you have equals signs in your template parameters then it probably is simpler and clearer to code it using <code>&lt;nowiki&gt;</code> tags, etc. Here are the codes to emulate {{tlc|tlf}}, {{tlc|tld}} and {{tlc|tlc}} respectively. Code is to the left and actual rendering to the right:

:<code><nowiki>&lt;nowiki&gt;{{subst:name|one=a|two=b}}&lt;/nowiki&gt;</nowiki></code> = <nowiki>{{subst:name|one=a|two=b}}</nowiki>

:<code><nowiki>&lt;tt&gt;&lt;nowiki&gt;{{subst:name|one=a|two=b}}&lt;/nowiki&gt;&lt;/tt&gt;</nowiki></code> = <tt><nowiki>{{subst:name|one=a|two=b}}</nowiki></tt>

:<code><nowiki>&lt;code&gt;&lt;nowiki&gt;{{subst:name|one=a|two=b}}&lt;/nowiki&gt;&lt;/code&gt;</nowiki></code> = <code><nowiki>{{subst:name|one=a|two=b}}</nowiki></code>

=== See also ===

* {{tl|tlsc}} – Not linked, several parameters and text in <code>&lt;code&gt;&lt;/code&gt;</code> style.
* {{tl|tlsd}} – Not linked, several parameters and <tt>teletype</tt> text style.
* {{tl|tlsf}} – Not linked, several parameters and normal text style.

* {{tl|tls}} –  Template link, no parameters and normal text style.
* {{tl|tlsp}} – Template link, several parameters and interwiki links.
* {{tl|tlsx}} – Template link, several parameters and interwiki links, <tt>teletype</tt> text style.
<includeonly>
<!-- JUST CATEGORIES HERE, INTERWIKIS SHOULD BE ADDED IN WIKIDATA -->
[[Category:Templates]]
</includeonly>