Misplaced Pages

Template:Template link with parameters: Difference between revisions

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.
Browse history interactively← Previous editNext edit →Content deleted Content addedVisualWikitext
Revision as of 02:08, 12 February 2009 view sourceDavidgothberg (talk | contribs)Extended confirmed users16,964 edits Giving this template a separate /doc page, since reusing Template:Tl/doc here caused a number of problems.← Previous edit Revision as of 08:35, 19 February 2009 view source Davidgothberg (talk | contribs)Extended confirmed users16,964 edits Updating to work like {{tlf}}: Now takes 0-8 parameters, shows empty but defined parameters, and prevents line wraps. Tested in /sandbox. See also talk page.Next edit →
Line 1: Line 1:
<span style="white-space:nowrap;">&#123;&#123;{{#if:{{{1|}}}
{{]&#124;{{{2}}}}}<noinclude> | ] | tlp&#124;... }}<!--
-->{{#ifeq:{{{2|x}}}|{{{2|}}}| &#124;{{{2}}} }}<!--
-->{{#ifeq:{{{3|x}}}|{{{3|}}}| &#124;{{{3}}} }}<!--
-->{{#ifeq:{{{4|x}}}|{{{4|}}}| &#124;{{{4}}} }}<!--
-->{{#ifeq:{{{5|x}}}|{{{5|}}}| &#124;{{{5}}} }}<!--
-->{{#ifeq:{{{6|x}}}|{{{6|}}}| &#124;{{{6}}} }}<!--
-->{{#ifeq:{{{7|x}}}|{{{7|}}}| &#124;{{{7}}} }}<!--
-->{{#ifeq:{{{8|x}}}|{{{8|}}}| &#124;{{{8}}} }}<!--
-->{{#ifeq:{{{9|x}}}|{{{9|}}}| &#124;{{{9}}} }}<!--
-->&#125;&#125;</span><noinclude>


{{pp-template|small=yes}} {{pp-template|small=yes}}

Revision as of 08:35, 19 February 2009

{{tlp|...}}

Template documentation[view] [edit] [history] [purge]
WarningThis template is used on approximately 69,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Shortcut

This is the template link with parameters (or {{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:

{{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. ({{tlx}}, for instance, uses <code>...</code> 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 – i.e. on the first occurrence of a template name, use {{tl}}, {{tlp}} or {{Tlx}} and thereafter use {{tlf}}, {{tlc}} or {{tld}}.

Examples

Code Output Comments
{{tlp}} {{tlp|...}} Shows its own syntax.
{{tlp|name}} {{name}}
{{tlp|name|first}} {{name|first}}
{{tlp|name|first|last}} {{name|first|last}}
{{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 at the end.
{{tlp|name|first=a|last=b}} {{name}} Equal signs are a problem, but there are a couple ways to fix:
{{tlp|name|2=first=a|3=last=b}} {{name|first=a|last=b}} Use numbered parameters to fix it. Here, parameter "|2=" is assigned the string "first=a". Start with #2, since "name" is already in the "|1=" slot. Note that all subsequent parameters after a numbered parameter must also be numbered.
{{tlp|name|first{{=}}a|last{{=}}b}} {{name|first=a|last=b}} Or, simply use, "{{=}}", the equal-sign template, to "escape" the symbol.
{{tlp|name|2=1=a|3=2=b}} {{name|1=a|2=b}} Both techniques also work with numbered positional parameters (e.g.: "|1=", "|2=").
{{tlp|name|2=1=a|last{{=}}b}} {{name|last=b}} The named parameter ("|last=") clobbered the prior one ("|2="). Again, all subsequent parameters after a numbered parameter must also be numbered...
{{tlp|name|2=1=a|3=last=b}} {{name|1=a|last=b}} ... but that's easy to fix, by adding the position number ("|3=") to the last parameter.

See also

These tables:

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} options
to achieve text style 		Link style
Linked Unlinked Linked with subst Unlinked with subst Linked including braces Linked with alternative text
{{tlg}} options
to achieve link style 		— DEFAULT nolink=yes subst=yes nolink=yes|subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}
{{tl}}
{{tlp|1|2|...}}
{{Template:tlu}} 		{{tlf}}
 {{subst:tls}}
{{subst:Template:tlsu}} 		{{subst:tlsf}}
 {{tn}} {{tla}}
code code=yes {{tl2}}
{{tlx}}
{{Template:tlxu}} 		{{tlc}}

{{tnull}} 		{{subst:tlxs}} {{subst:tlsc}}
 —
monospace plaincode=yes — {{subst:tltss}} —
kbd kbd=yes
bold bold=yes {{tlb}} —
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}
  1. ^ {{tlg}} is the most general template, 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. ^ Allows links to templates in any namespace.
  4. {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. ^ Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}} {{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}}		 Supports colors, placeholder texts, named and unnamed parameters 
<syntaxhighlight lang="wikitext">
{{Hatnote
   | Some text
   | selfref = yes
   | category = no
   | lang = fr
}}
</syntaxhighlight>

{{Hatnote
    | Some text
    | selfref = yes
    | category = no
    | lang = fr
}}
Same as above
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}} {{Hatnote|Some text|selfref=yes|category=no|lang=fr}} Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight> {{Hatnote|Some text|selfref=yes|category=no|lang=fr}} Same as above
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} 
{{hatnote|lang=fr|Some text}}
Some text		 Shows code and example
{{tln|Hatnote}} Template:Hatnote Produces a normal link to the template
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}} 		]
]		 Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mfl|Example|hello}} {{#invoke:Example|hello}} Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example}} require('Module:Example') Link to Lua modules and built-in libraries, showing Lua code.
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values
{{sclx|LASTING}} ] Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}}
{{xtag|templatedata}} 		<ref>...</ref>
<templatedata>		 Formats HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}} {{d:Ping project}} Wikidata counterpart to {{tl}}
{{pf|if}}
{{pf|if|{{{1}}}|true|false}} 		{{#if}}
{{#if:{{{1}}}|true|false}}		 Parser function equivalent to {{tl}}
{{magic word|uc:}} {{uc:}} Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}} Template:Hatnote(edit talk links history)
{{t links|Hatnote}} {{Hatnote}} (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}} Template:Hatnote (talk · history · transclusions · logs · subpages)
{{tetl|Hatnote}} {{Hatnote}}
links talk edit
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk edit
{{ti|Hatnote}} Template:Hatnote (talk · links · edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tim|Hatnote}} m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} Template:Hatnote (links, talk)
{{twlh|Hatnote}} Template:Hatnote (links, talk)
The above documentation is transcluded from Template:Template link with parameters/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template. Categories: