Template:Utlp/doc
This is a documentation subpage for Template:Utlp. It may contain usage information, categories and other content that is not part of the original template page. |
This is the {{utlp}} or user template link with parameters template.
It is based on the {{tlp}} template, but does not link to template namespace.
It can be used in documentation and talk page discussions to show how a user-space template name would be used in code.
Here is how this template looks. Code to the left and actual rendering to the right:
{{utlp|name|parameters}}
= {{name|parameters}}
Features of {{utlp}}:
- It shows a transcluded page name with a link to that page.
- It shows up to eight parameters.
- It also shows empty parameters. (See examples below.)
- It prevents line wraps in its output.
- It uses normal text style. (While for instance
{{tlx}}
usesteletype
text style.)
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}}, {{tlp}} or {{tlx}}
, and then use {{tlf}}, {{tld}}
or {{tlc}}
.
Examples
[edit]Code | Result | Comment |
---|---|---|
{{utlp}} |
{{tlp|...}} | Shows its own syntax. |
{{utlp|name}} |
{{name}} | |
{{utlp|name|one}} |
{{name|one}} | |
{{utlp|name|one|two}} |
{{name|one|two}} | |
{{utlp|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. |
{{utlp|name|three|four}} |
{{name|||three|four}} | Also shows empty parameters. |
{{utlp|name|three}} |
{{name|||three||}} | Even shows empty parameters that come in the end. |
{{utlp|name|one=a|two=b}} |
{{name}} | Equal signs is a problem, but there is a fix. |
{{utlp|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, or the =
or =
character references. Here's how to do that. Code to the left and actual rendering to the right:
{{utlp|name|<nowiki>one=a|two=b</nowiki>}}
= {{name|one=a|two=b}}{{utlp|name|one=a|two=b}}
= {{name|one=a|two=b}}
See also
[edit]- {{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.
- {{tlp}} – Template link, several parameters and normal text style.
- {{tlx}} – Template link, several parameters and interwiki links,
teletype
text style. - {{tn}} – Same as {{tl}}, but shows the braces as part of the link.
- {{User:utn}} – Also for non-template namespace; same as {{tl}}, but shows the braces as part of the link.