Template:Tlx/doc: Difference between revisions
More actions
tlp -> tlx / commonfy |
mNo edit summary |
||
| Line 15: | Line 15: | ||
* It prevents line wraps in its output. | * It prevents line wraps in its output. | ||
This template belongs to a | This template belongs to a family of similar templates. 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 === | ||
Revision as of 23:53, 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 family of similar templates. 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}}