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

Revision as of 06:05, 2 July 2014

Revision as of 01:37, 23 July 2014

Line 3:

{{high-risk| 190,000+ }}

This is the {{Tltl|Tlptlp}} 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.

Line 9:

Here is how this template looks. Code to the left and actual rendering to the right:

: {{Tlctlc|Tlptlp|name|parameters}} = {{Tlptlp|name|parameters}}

Features of {{Tlptlp|Tlptlp}}:

* 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 wrap]]s in its output.

* It uses normal text style. (While for instance {{Tlxtlx|Tlxtlx}}, 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. – Theni.e. on the first occurrence of a template name, use {{Tltl|Tltl}}, {{Tlptlp|Tlptlp}} or {{Tlx|Tlx}}, and thenthereafter use {{Tlftlf|Tlftlf}}, {{Tldtlc|Tldtlc}} or {{Tlctld|Tlctld}}.

=== Examples ===

{{Aligned table |cols=3 |class="wikitable"

| '''Code''' | '''Output''' | '''Comments'''

{| class="wikitable"

| {{tlc|tlp}} | {{tlp}} | Shows its own syntax.

|-

| {{tlc|tlp|name|first}} | | {{tlp|name|first}} | |

!Code !! Result !! Comment

| {{tlc|tlp|name|||three|fourfirst}} | | {{tlp|name|||three|fourfirst}} || Also shows empty parameters. |

|-

| {{tlc|tlp|name|first|last}} | | {{tlp|name|first|last}} || Shows its own syntax.|

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

|-

| {{tlc|tlp|name||three|four}} || {{tlp|name||three|four}} || Also shows empty parameters.

| {{tlc|tlp|name|||three||}} | | {{tlp|name|||three||}} || Even shows empty parameters that come at the end.

|-

| {{tlc|tlp|name|first}} || {{tlp|name|first}} ||

|- stylerow9style="color: red;"

|-

| {{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|a|b|c|d|e|<nowiki>f|g|h|i|</nowiki>j}} || {{tlp|name|a|b|c|d|e|f|g|h|i|j}} || Shows up to ''eight'' parameters. The rest are dropped.

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

|-

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

| {{tlc|tlp|name|||three|four}} || {{tlp|name|||three|four}} || Also shows empty parameters.

| {{tlc|tlp|name|3=2=first=a|4=3=last=b}} || {{tlp|name|2=first=a|3=last=b}} | | 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.

|-

| {{tlc|tlp|name|||three||}} || {{tlp|name|||three||}} ||Even shows empty parameters that come at the end.

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

|- style="color: red;"

| {{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=first<nowiki>{{=}}</nowiki>a|4=last<nowiki>{{=}}</nowiki>b}} || {{tlp|name|first{{=}}a|last{{=}}b}} | | Or, simply use, "<nowiki>{{=}}</nowiki>", the equal-sign template, to "escape" the symbol.

|-

| {{tlc|tlp|name|3=2=first=a|4=3=last=b}} || {{tlp|name|2=first=a|3=last=b}} || 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.

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

|-

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

| {{tlc|tlp|name|3=first<nowiki>{{=}}</nowiki>a|4=last<nowiki>{{=}}</nowiki>b}} || {{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}} || {{tlp|name|2=1=a|3=2=b}} | | Both techniques also work with numbered positional parameters (e.g.: "{{para|1}}", "{{para|2}}").

|-

| {{tlc|tlp|name|3=2=1=a|4=3=2=b}} || {{tlp|name|2=1=a|3=2=b}} || Both techniques also work with numbered positional parameters (e.g.: "{{para|1}}", "{{para|2}}").

|- stylerow13style="color: red;"

| {{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}} |
| {{tlp|name|2=1=a|3=last=b}} |
| ... but that's easy to fix, by adding the position number ("{{para|3}}") to the last parameter.

|}}

=== See also ===

{{Template-linking templates}}

=== See also ===

{{Tl-nav}}

<includeonly>

{{#ifeq:{{SUBPAGENAME}}|sandbox | |

<!-- CATEGORIES ANDBELOW INTERWIKISTHIS HERELINE, THANKSPLEASE: -->

[[Category:Internal template-link templates]]

[[Category:Typing-aid templates]]

}}

[[Category:Internal link templates]]

</includeonly>