Template:Tlx/doc
From Wikimedia Commons, the free media repository
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}}.
[edit] 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}}
