Template:Template link with parameters/doc: Difference between revisions

Revision as of 09:04, 19 February 2009

Latest revision as of 10:13, 2 March 2024

(27 intermediate revisions by 24 users not shown)

Line 1:

{{Documentation subpage}}

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

{{high-use| 30,000+69435 }}

{{template shortcut|tlp}}

This is the '''template link with parameters''' (or {{tltlp|tlp}}) 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:

: {{tlc|tlp|name|parameters}} = {{tlp|name|parameters}}

Features of {{tlp|tlp}}:

* It shows a template name andwith upa link to eightthat parameterstemplate.

* It shows up to eight parameters.

* It also shows empty parameters. (See examples below.)

* It prevents [[line wrap]]s in its output.

* It uses normal text style. ({{tlx|tlx}}, for instance, uses {{tag|code}} text style.)

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&nbsp;– i.e. on the first occurrence of a template name, use {{tl|tl}}, {{tlp|tlp}} or {{Tlx|Tlx}} and thereafter use {{tlf|tlf}}, {{tlc|tlc}} or {{tld|tld}}.

=== Examples ===

{{Aligned table |cols=3 |class=wikitable |row1header=y

| Code | Output | Comments

<tr><td> | {{tlc|tlp}} <td> | {{tlp}} <td> | Shows its own syntax.

<tr><td> | {{tlc|tlp|name}} <td> | {{tlp|name}} <td> |

<tr><td> | {{tlc|tlp|name|onefirst}} <td> | {{tlp|name|onefirst}} <td> |

<tr><td> | {{tlc|tlp|name|onefirst|twolast}} <td> | {{tlp|name|onefirst|twolast}} <td> |

<tr><td><code><nowiki> | {{tlc|tlp|name|a|b|c|d|e|<nowiki>f|g|h|i|j}}</nowiki></code>j}} | <td>{{tlp|name|a|b|c|d|e|f|g|h|i|j}} <td>| Shows up to ''eight'' parameters. The rest are dropped.

<tr><td> | {{tlc|tlp|name|||three|four}} <td>| {{tlp|name|||three|four}} <td>| Also shows empty parameters.

<tr><td> | {{tlc|tlp|name|||three||}} <td> | {{tlp|name|||three||}} <td> | Even shows empty parameters that come inat the end.

|row9style=color:red;

=== Examples ===

| {{tlc|tlp|name|3=first=a|4=last=b}}

| {{tlp|name|first=a|last=b}}

| Equal signs are a problem, but there are a couple ways to fix:

| {{tlc|tlp|name|3=2=first=a|4=3=last=b}}

<table class="wikitable">

| {{tlp|name|2=first=a|3=last=b}}

<tr><th>Code<th>Result<th>Comment

| Use numbered parameters to fix it. Here, parameter "{{para|2}}" is assigned the string "first{{=}}a". Start with #2, since "name" is already in the "{{para|1}}" slot. Note that ''all'' subsequent parameters after a numbered parameter ''must also'' be numbered.

<tr><td>{{tlc|tlp}} <td>{{tlp}} <td>Shows its own syntax.

<tr><td>{{tlc|tlp|name}} <td>{{tlp|name}} <td>

<tr><td>{{tlc|tlp|name|one}} <td>{{tlp|name|one}} <td>

<tr><td>{{tlc|tlp|name|one|two}} <td>{{tlp|name|one|two}} <td>

<tr><td><code><nowiki>{{tlp|name|a|b|c|d|e|f|g|h|i|j}}</nowiki></code> <td>{{tlp|name|a|b|c|d|e|f|g|h|i}} <td>Shows up to eight parameters. The rest are dropped.

<tr><td>{{tlc|tlp|name|||three|four}} <td>{{tlp|name|||three|four}} <td>Also shows empty parameters.

<tr><td>{{tlc|tlp|name|||three||}} <td>{{tlp|name|||three||}} <td>Even shows empty parameters that come in the end.

<tr><td>{{tlc|tlp|name|2=one=a|3=two=b}} <td>{{tlp|name|one=a|two=b}} <td>Equal signs is a problem, but there is a fix.

<tr><td>{{tlc|tlp|name|3=2=one=a|4=3=two=b}} <td>{{tlp|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>

| {{tlc|tlp|name|3=first<nowiki>{{=}}</nowiki>a|4=last<nowiki>{{=}}</nowiki>b}}

If you have equal signs in your template parameters then some find it simpler to code it using <code>&lt;nowiki></code> tags. Here's how to do that. Code to the left and actual rendering to the right:

| {{tlp|name|first{{=}}a|last{{=}}b}}

| Or, simply use, "<nowiki>{{=}}</nowiki>", the equal-sign template, to "escape" the symbol.

| {{tlc|tlp|name|3=2=1=a|4=3=2=b}}

:<code><nowiki>{{tlp|name|&lt;nowiki>one=a|two=b&lt;/nowiki>}}</nowiki></code> = {{tlp|name|<nowiki>one=a|two=b</nowiki>}}

| {{tlp|name|2=1=a|3=2=b}}

| Both techniques also work with numbered positional parameters (e.g.: "{{para|1}}", "{{para|2}}").

|row13style=color:red;

=== See also ===

| {{tlc|tlp|name|3=2=1=a|4=last<nowiki>{{=}}</nowiki>b}}

| {{tlp|name|<!--2=1=a|-->last{{=}}b}}

| The named parameter ("{{para|last}}") clobbered the prior one ("{{para|2}}"). Again, '''all''' subsequent parameters after a numbered parameter ''must also'' be numbered...

| {{tlc|tlp|name|3=2=1=a|4=3=last=b}}

* {{tl|tlc}} – Not linked, several parameters and text in <code>&lt;code>&lt;/code></code> style.

| {{tlp|name|2=1=a|3=last=b}}

* {{tl|tld}} – Not linked, several parameters and <tt>teletype</tt> text style.

| ... but that's easy to fix, by adding the position number ("{{para|3}}") to the last parameter.

* {{tl|tlf}} – Not linked, several parameters and normal text style.

}}

=== See also ===

* {{tl|tl}} – Template link, no parameters and normal text style.

* {{tl|tl7}}

* {{tl|tlp}} – Template link, several parameters and normal text style.

{{Template-linking templates}}

* {{tl|tlx}} – Template link, several parameters and interwiki links, <tt>teletype</tt> text style.

* {{tl|tn}} – Same as {{tlf|tl}}, but shows the braces as part of the link.

<includeonly>{{Sandbox other||

<!-- Categories below this line, please; interwikis at Wikidata -->

<includeonly>

[[Category:Internal template-link templates]]

<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->

[[Category:Typing-aid templates]]

}}</includeonly>

[[Category:Internal link templates]]

</includeonly>