ઢાંચો:Template link with parameters/doc
Appearance
(ઢાંચો:Tlp/doc થી અહીં વાળેલું)
This is a documentation subpage for ઢાંચો:Template link with parameters. It may contain usage information, categories and other content that is not part of the original ઢાંચો page. |
This template is used on approximately ૬૯,૦૦૦ 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. |
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}} | {{ઢાંચો:Template link with parameters/doc}} | 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|i|j}} | 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
[ફેરફાર કરો]- {{tl7}}
General-purpose formatting
[ફેરફાર કરો]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 |
N/A | DEFAULT | nolink=yes
|
subst=yes
|
nolink=yes
|
braceinside=yes
|
alttext=Foo 2=Foo
|
normal | DEFAULT | {{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}} |
{{tlf}} <template link> |
{{subst:tls}} {{subst:Template:tlsu}} |
{{tlsf}} <template link> |
{{tn}} | {{tla}} |
code
|
code=yes
|
{{tl2}} {{tlx}} {{Template:tlxu}} |
{{tlc}} <template link> {{tnull}} <template link>
|
{{subst:tlxs}}
|
{{subst:tlsc}} <template link> |
N/A | |
monospace | plaincode=yes |
N/A | {{subst:tltss}} |
N/A | |||
kbd | kbd=yes | ||||||
bold | bold=yes
|
{{tlb}} | N/A | ||||
bold+code
|
bold=yes
|
{{tlxb}}
| |||||
italic+code
|
italic=yes
|
{{tlxi}}
|
- ↑ ૧.૦ ૧.૧ ૧.૨
{{tlg}}
is the most general template, allowing any combination of text style and/or link style options. - ↑ ૨.૦ ૨.૧ ૨.૨ ૨.૩ ૨.૪ Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>
tags. - ↑ ૩.૦ ૩.૧ ૩.૨ Allows links to templates in any namespace.
- ↑
{{tlg|plaincode=yes}}
uses<code style="border:none; background-color:transparent;">...</code>
. - ↑ ૫.૦ ૫.૧ Displays monospaced font using
<span style="font-family:monospace;">...</span>
.
Other formatting templates
[ફેરફાર કરો]Code example | Effect | Notes |
---|---|---|
{{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}} |
Shows code and example |
{{tln|Hatnote}}
|
Template:Hatnote | Produces a normal link to the template |
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}
|
[[Template:Hatnote]] [[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 |
{{mlx|Example|hello}}
|
{{#invoke:Example|hello}} |
Counterpart to {{tlx}} for linking to Lua modules |
{{ml-lua|Module:Example|hello}}
|
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}}
|
[[WP: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 [X]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
[ફેરફાર કરો]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 · delete) |
{{tetl|Hatnote}}
|
{{Hatnote}} |
{{tsetl|Hatnote}}
|
{{subst:Hatnote}} |
{{ti|Hatnote}}
|
Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽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}}
|
{{Hatnote}} (t/l) |
{{twlh|Hatnote}}
|
Template:Hatnote (links, talk) |