Template:Tlx/doc: Difference between revisions
More actions
m moved Template:Tlp/doc to Template:Tlx/doc |
tlp -> tlx / commonfy |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
This is the {{tl| | This is the {{tl|tlx}} or '''t'''emplate '''l'''ink e'''x'''panded template. | ||
It can be used in documentation and talk page discussions to show how a template name would be used in code. | It can be used in documentation and talk page discussions to show how a template name would be used in code. | ||
| Line 9: | Line 7: | ||
Here is how this template looks. Code to the left and actual rendering to the right: | Here is how this template looks. Code to the left and actual rendering to the right: | ||
:{{tlc| | :{{tlc|tlx|name|parameters}} = {{tlx|name|parameters}} | ||
Features of {{ | Features of {{tl|tlx}}: | ||
* It shows a template name with a link to that template. | * It shows a template name with a link to that template. | ||
* It shows up to eight parameters. | * It shows up to eight parameters. | ||
* It also shows empty parameters. (See examples below.) | * It also shows empty parameters. (See examples below.) | ||
* It prevents | * It prevents line wraps in its output. | ||
This template belongs to a whole family of similar templates. See the [[#See also|see also]] section below for some of them. For instance, when writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability. Then on the first occurrence of a template name use {{tl|tl}}, | This template belongs to a whole family of similar templates. See the [[#See also|see also]] section below for some of them. For instance, when writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability. Then on the first occurrence of a template name use {{tl|tl}}, or {{tlx|tlx}}, and then use {{tlf|tlf}}, {{tld|tld}} or {{tlc|tlc}}. | ||
=== Examples === | === Examples === | ||
<table class="wikitable"> | <table class="wikitable"> | ||
<tr><th>Code<th>Result<th>Comment | <tr><th>Code<th>Result<th>Comment | ||
<tr><td>{{tlc| | <tr><td>{{tlc|tlx}} <td>{{tlx}} <td>Shows its own syntax. | ||
<tr><td>{{tlc| | <tr><td>{{tlc|tlx|name}} <td>{{tlx|name}} <td> | ||
<tr><td>{{tlc| | <tr><td>{{tlc|tlx|name|one}} <td>{{tlx|name|one}} <td> | ||
<tr><td>{{tlc| | <tr><td>{{tlc|tlx|name|one|two}} <td>{{tlx|name|one|two}} <td> | ||
<tr><td><code><nowiki>{{ | <tr><td><code><nowiki>{{tlx|name|a|b|c|d|e|f|g|h|i|j}}</nowiki></code> <td>{{tlx|name|a|b|c|d|e|f|g|h|i}} <td>Shows up to eight parameters. The rest are dropped. | ||
<tr><td>{{tlc| | <tr><td>{{tlc|tlx|name|||three|four}} <td>{{tlx|name|||three|four}} <td>Also shows empty parameters. | ||
<tr><td>{{tlc| | <tr><td>{{tlc|tlx|name|||three||}} <td>{{tlx|name|||three||}} <td>Even shows empty parameters that come in the end. | ||
<tr><td>{{tlc| | <tr><td>{{tlc|tlx|name|3=one=a|4=two=b}} <td>{{tlx|name|one=a|two=b}} <td>Equal signs are a problem, but there is a fix. | ||
<tr><td>{{tlc| | <tr><td>{{tlc|tlx|name|3=2=one=a|4=3=two=b}} <td>{{tlx|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> | ||
If you have equal signs in your template parameters then some find it simpler to code it using <code><nowiki></code> tags. Here's how to do that. Code to the left and actual rendering to the right: | If you have equal signs in your template parameters then some find it simpler to code it using <code><nowiki></code> tags. Here's how to do that. Code to the left and actual rendering to the right: | ||
:<code><nowiki>{{ | :<code><nowiki>{{tlx|name|<nowiki>one=a|two=b</nowiki>}}</nowiki></code> = {{tlx|name|<nowiki>one=a|two=b</nowiki>}} | ||
<includeonly> | <includeonly> | ||
[[Category:Typing-aid templates|{{PAGENAME}}]] | |||
[[Category:Typing-aid templates]] | [[Category:Internal link templates|{{PAGENAME}}]] | ||
[[Category:Internal link templates | |||
</includeonly> | </includeonly> | ||
Revision as of 23:45, 30 July 2009
This is the {{Tlx}} or template link expanded template.
It can be used in documentation and talk page discussions to show how a template name would be used in code.
Here is how this template looks. Code to the left and actual rendering to the right:
{{tlx|name|parameters}}= {{name|parameters}}
Features of {{Tlx}}:
- It shows a template name with a link to that template.
- It shows up to eight parameters.
- It also shows empty parameters. (See examples below.)
- It prevents line wraps in its output.
This template belongs to a whole family of similar templates. See the see also section below for some of them. For instance, when writing documentation you might want to avoid a lot of unnecessary links, since it decreases readability. Then on the first occurrence of a template name use {{Tl}}, or {{tlx}}, and then use {{tlf}}, {{tld}} or {{tlc}}.
Examples
| Code | Result | Comment |
|---|---|---|
{{tlx}} | {{Tlx}} | Shows its own syntax. |
{{tlx|name}} | {{name}} | |
{{tlx|name|one}} | {{name|one}} | |
{{tlx|name|one|two}} | {{name|one|two}} | |
{{tlx|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. |
{{tlx|name|||three|four}} | {{name|three|four}} | Also shows empty parameters. |
{{tlx|name|||three||}} | {{name|three}} | Even shows empty parameters that come in the end. |
{{tlx|name|one=a|two=b}} | {{name}} | Equal signs are a problem, but there is a fix. |
{{tlx|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 some find it simpler to code it using <nowiki> tags. Here's how to do that. Code to the left and actual rendering to the right:
{{tlx|name|<nowiki>one=a|two=b</nowiki>}}= {{name|one=a|two=b}}