الگو:Tlp/توضیحات
This is the {{Tlp}} or template link with parameters 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:
{{Tlp|name|parameters}}
= {{name|parameters}}
Features of {{Tlp}}:
- 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.
- It uses normal text style. (While for instance {{tlx}} uses teletype 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
ویرایشCode | Result | Comment |
---|---|---|
{{tlp}} | {{tlp|...}} | Shows its own syntax. |
{{tlp|name}} | {{name}} | |
{{tlp|name|one}} | {{name|one}} | |
{{tlp|name|one|two}} | {{name|one|two}} | |
{{tlp|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. |
{{tlp|name|||three|four}} | {{name|||three|four}} | Also shows empty parameters. |
{{tlp|name|||three||}} | {{name|||three||}} | Even shows empty parameters that come in the end. |
{{tlp|name|one=a|two=b}} | {{name}} | Equal signs is a problem, but there is a fix. |
{{tlp|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:
{{tlp|name|<nowiki>one=a|two=b</nowiki>}}
= {{name|one=a|two=b}}{{tlp|name|one=a|two=b}}
= {{name|one=a|two=b}}
See also
ویرایشGeneral-purpose formatting
ویرایشLink style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 → | N/A |
|
|
|
|
Normal | N/A | {{tlg}}1, 2 {{tl}} {{tlp}}2 |
{{tlf}}2 | {{tls}} {{tlsp}} |
{{tn}} | {{tla}} |
Code
|
or
|
{{tlx}} | {{tlc}}2 {{tld}}2 {{tnull}} |
{{tlxs}} | N/A | |
Bold |
|
{{tlb}} | N/A | |||
Bold code
|
|
{{tlxb}} |
- 1 {{tlg}} is the most general, allowing any combination of text style and/or link style options.
- 2 Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>
tags. - 3 Uses monospace font but not
<code>...</code>
. - 4 Allows links to templates in any namespace.