Kwickert: Protected "Template:Tlc/doc" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite))

2012-09-06T19:03:31Z

Protected "Template:Tlc/doc" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite))

Kwickert: Created page with "{{Documentation subpage}} This is the {{tlc|tlc}} template. This page is also the documentation for {{tl|tld}} and {{tl|tlf}} that work almost exactly the same. When showing..."

2012-09-06T19:03:22Z

Created page with "{{Documentation subpage}} This is the {{tlc|tlc}} template. This page is also the documentation for {{tl|tld}} and {{tl|tlf}} that work almost exactly the same. When showing..."

New page

{{Documentation subpage}}
This is the {{tlc|tlc}} template.

This page is also the documentation for {{tl|tld}} and {{tl|tlf}} that work almost exactly the same.

When showing a template name with brackets in documentation you have to escape the brackets in some way so it doesn't become a call to the template. Instead of using <code><nowiki></nowiki></code> tags you can write it simpler and shorter by using these templates.

Here is how these templates look. Code to the left and actual rendering to the right:

:{{tlc|tlc|name|parameters}} = {{tlc|name|parameters}}
:{{tlc|tld|name|parameters}} = {{tld|name|parameters}}
:{{tlc|tlf|name|parameters}} = {{tlf|name|parameters}}

These templates work similarly to {{tl|tl}} and {{tlx|tlx}}, but they don't make the template name into a link. When writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability. So on the first occurrence of a template name use {{tl|tl}} or {{tlx|tlx}}, and then use {{tlc|tlc}}, {{tld|tld}} or {{tlf|tlf}}.

Features of {{tlc|tlc}}, {{tld|tld}} and {{tlf|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.

=== Examples ===
Wikitables make the <code><code></code></code> tags transparent, that's why the "<code>code colouring</code>" is missing in these examples.

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

<tr><td>{{tlc|tlc|name|2=one=a|3=two=b}} <td>{{tlc|name|one=a|two=b}} <td>Equal signs is a problem, but there is a fix.
<tr><td>{{tlc|tlc|name|3=2=one=a|4=3=two=b}} <td>{{tlc|name|2=one=a|3=two=b}} <td>Use numbered parameters to fix it. Remember to start from 2, since the "name" is number 1.
</table>

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

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

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

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

=== See also ===
* {{tl|tlc}} – Not linked, several parameters and text in <code><code></code></code> style.
* {{tl|tld}} – Not linked, several parameters and <tt>teletype</tt> text style.
* {{tl|tlf}} – Not linked, several parameters and normal text style.

* {{tl|tl}} – Template link, no parameters and normal text style.
* {{tl|tlx}} – Template link, several parameters and normal text style.
* {{tl|tlp}} - Template link, several non-blank parameters and normal text style.

<includeonly>
[[Category:Typing-aid templates|{{PAGENAME}}]]
</includeonly>

Template:Tlc/doc - Revision history

Kwickert: Protected "Template:Tlc/doc" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite))

Kwickert: Created page with "{{Documentation subpage}} This is the {{tlc|tlc}} template. This page is also the documentation for {{tl|tld}} and {{tl|tlf}} that work almost exactly the same. When showing..."