Template:Tlc/doc: Difference between revisions
More actions
m 16 revisions from en:Template:Tlc/doc |
commons fixes |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
This is the {{tlc|tlc}} template. | This is the {{tlc|tlc}} template. | ||
| Line 19: | Line 17: | ||
* They show a template name and up to eight parameters. | * They show a template name and up to eight parameters. | ||
* They also show empty parameters. (See examples below.) | * They also show empty parameters. (See examples below.) | ||
* They prevent | * They prevent line wraps in their output. | ||
=== Examples === | === Examples === | ||
Wikitables make the <code><code></code></code> tags transparent, that's why the "<code>code colouring</code>" is missing in these examples. | Wikitables make the <code><code></code></code> tags transparent, that's why the "<code>code colouring</code>" is missing in these examples. | ||
| Line 37: | Line 34: | ||
<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|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. | <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> | </table> | ||
| Line 49: | Line 45: | ||
=== See also === | === See also === | ||
* {{tl|tlc}} – Not linked, several parameters and text in <code><code></code></code> style. | * {{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|tld}} – Not linked, several parameters and <tt>teletype</tt> text style. | ||
| Line 56: | Line 51: | ||
* {{tl|tl}} – Template link, no parameters and normal text style. | * {{tl|tl}} – Template link, no parameters and normal text style. | ||
* {{tl|tlx}} – Template link, several parameters and interwiki links, <tt>teletype</tt> text style. | * {{tl|tlx}} – Template link, several parameters and interwiki links, <tt>teletype</tt> text style. | ||
* {{tl| | * {{tl|tlp}} - Template link, with one or two parameters. | ||
<includeonly> | <includeonly> | ||
[[Category:Typing-aid templates|{{PAGENAME}}]] | [[Category:Typing-aid templates|{{PAGENAME}}]] | ||
</includeonly> | </includeonly> | ||
Revision as of 08:58, 19 June 2008
This is the {{tlc}} template.
This page is also the documentation for {{Tld}} and {{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 <nowiki></nowiki> 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|name|parameters}}={{name|parameters}}{{tld|name|parameters}}= {{name|parameters}}{{tlf|name|parameters}}= {{name|parameters}}
These templates work similarly to {{Tl}} and {{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}} or {{tlx}}, and then use {{tlc}}, {{tld}} or {{tlf}}.
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.
Examples
Wikitables make the <code></code> tags transparent, that's why the "code colouring" is missing in these examples.
| Code | Result | Comment |
|---|---|---|
{{tlc}} | {{{{{1}}}}} | 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|one=a|two=b}} | {{name}} | Equal signs is a problem, but there is a fix. |
{{tlc|name|2=one=a|3=two=b}} | {{name|one=a|two=b}} | Use numbered parameters to fix it. Remember to start from 2, since the "name" is number 1. |
If you have equal 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 {{tlf}}, {{tld}} and {{tlc}} respectively. Code 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
- {{Tlc}} – Not linked, several parameters and text in
<code></code>style. - {{Tld}} – Not linked, several parameters and teletype text style.
- {{Tlf}} – Not linked, several parameters and normal text style.
- {{Tl}} – Template link, no parameters and normal text style.
- {{Tlx}} – Template link, several parameters and interwiki links, teletype text style.
- {{Tlp}} - Template link, with one or two parameters.