සැකිල්ල:ප්රසාරිත සැකිලි සබැඳිය/doc
This is a documentation subpage for සැකිල්ල:ප්රසාරිත සැකිලි සබැඳිය. It may contain usage information, categories and other content that is not part of the original සැකිල්ල page. |
This template is used to show example template usage without expanding the template itself.
Basic use
සංස්කරණය(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)
{{tlx|Template|first parameter|second parameter|third parameter|...|tenth parameter}}
produces:{{Template|first parameter|second parameter|third parameter|...|tenth parameter}}
When you want to indicate setting a value to one or more parameters, you would normally use the equals-sign ("="). This doesn't work here; instead use {{=}}, like so:
{{tlx|Template|first{{=}}first value|second|third{{=}}third value}}
produces:{{Template|first=first value|second|third=third value}}
For more than ten parameters – with or without equals-signs – instead wrap the entire list of parameters and their values in <nowiki>...</nowiki>
tags. When you do, you don't need to replace equals-signs. For instance:
{{tlx|Template|<nowiki>''first''|''second''|''third=value''|...|''999th''</nowiki>}}
produces:{{Template|first|second|third=value|...|999th}}
Purpose and naming
සංස්කරණයMnemonically, template link expanded (after template link).
This template allows an example of calling a template, accompanied by one or more parameters, to be displayed without also causing the template to be called.
Up to 20 of the template's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 20 parameters can be displayed using a coded vertical bar (pipe) symbol, as in |
. A keyword parameter can be used with equals code = or {{=}} or in nowiki-text: "<nowiki>size=10</nowiki>
" or all parameters as a string in "<nowiki>
" tags; see Examples at bottom. For more details, see this talk page. If you use 21 or more parameters, all after the 20th will be replaced with a single |...
at the end of the parameter list.
- Exceptions
If the intended template lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with <code>
<nowiki>
. For example:
<code>
.<nowiki>{{Anytemplate|arg1=23|size=250px|other parameters...}}</nowiki>
</code>
If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with <pre>...</pre>
.
Parameters
සංස්කරණය- If the only parameter supplied is {{{1}}}, i.e. a template's name,
{{tlx}}
's output is the same as{{tl}}
– i.e. a link within braces – but in a monospaced font:
{{tl}}
will also not take nor display additional parameters.
- Named parameters
|subst=
- Setting this parameter to any non-blank value will prefix the string
subst:
linked to Help:Substitution. This is useful to indicate when a template should be substituted. For example,{{tlx|Welcome|subst=Y}}
produces:{{subst:Welcome}}
. This is similar to the action of the{{tlxs}}
template:{{tlxs|Welcome}}
produces:{{subst:welcome}}
.
|SISTER=
- For an interwiki link to other sister projects, such as:
|SISTER=M:
(Meta),|SISTER=Q:
(WikiQuote),|SISTER=S:
(WikiSource), etc, facilitating interwiki template documentation and/or discussion.
|LANG=
- For a link to Wikipedias in other languages, such as:
|LANG=de:
(German),|LANG=sv:
(Swedish), etc, facilitating cross-language template documentation and/or discussion.
Documentation
සංස්කරණය{{Tlx}} is a generalization of {{tl}}, {{tlp}} etc., with output that is arguably more legible. This depends on the browser, but narrow gaps between characters such as " { ", " | ", " } " and links can be hard to read when not monospaced (and hard to click on; for uses like {{!}}
, see {{tlw}}, which makes the click target bigger).
Usage
සංස්කරණය{{tlx|Templatename}}
{{tlx|Templatename|param}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10}}
{{tlx|Templatename|1|2|3|4|5|6|7|8|9|10|more}}
{{tlx|Templatename|param=value}}
There are up to 10 placeholders for parameters of the specified template.
Examples
සංස්කරණය- Note
- At the en.wikipedia and Meta sites, X0, X1, X2, ... X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other sister projects.
Code | Result | Remarks |
{{tlx|x0}} | {{x0}} | |
{{tlx|Abc}} | {{Abc}} | |
{{tlx|ABC}} | {{ABC}} | |
{{tlx|AbC}} | {{AbC}} | |
{{tlx|x1|one}} | {{x1|one}} | |
{{tlx|x2|one|two}} | {{x2|one|two}} | |
{{tlx|x3|1|2|3|4|5|6|7|8|9|10}} | {{x3|1|2|3|4|5|6|7|8|9|10}} | |
{{tlx|x4|1|2|3|4|5|6|7|8|9|10|11}} | {{x4|1|2|3|4|5|6|7|8|9|10|11}} | up to 10 parameters... |
{{tlx|x5|1|2|3|4|5|6|7|8|9|10|11}} | {{x5|1|2|3|4|5|6|7|8|9|10|11}} | ... | for more |
{{tlx|x1|x=u}} | {{x1}} | the straightforward equals-sign won't work... |
{{tlx|x1|x=u}} | {{x1|x=u}} | ...but = is okay |
{{tlx|x1|x{{=}}u}} | {{x1|x=u}} | ...and {{=}} is okay |
{{tlx|x1|<nowiki>x=u</nowiki>}} | {{x1|x=u}} | sticky nowiki also okay |
{{tlx|x2| |two}} | {{x2|two}} | empty won't work... |
{{tlx|x2| |two}} | {{x2| |two}} | ...but   is okay |
{{tlx|x2| |two}} | {{x2| |two}} | ... is also okay |
{{tlx|x2| | {{x2||two}} | <nowiki /> handles the space |
{{tlx|x2|| two}} | {{x2|| two}} | | is okay |
{{tlx|x2|{{!}} two}} | {{x2|| two}} | {{!}} is dubious |
{{tlx|x2|2=|3=two}} | {{x2|two}} | empty really doesn't work |
{{tlx|x2|2=one|two}} | {{x2|two}} | "two" overrides "2=one" |
{{tlx|x2|3=two|2=one}} | {{x2|one|two}} | irregular parameter order is okay |
- Unlimited parameters as one
<nowiki>...</nowiki>
string {{tlx|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}
TemplateData
සංස්කරණයTemplateData documentation used by VisualEditor and other tools
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for ප්රසාරිත සැකිලි සබැඳිය Show example template usage without expanding the template itself. {{tnull}} is similar without linking the template.
|
See also
සංස්කරණය- {{tlxb}}, a version of {{tlx}} where the template name is shown in bold.
- {{tlb}}, a version of {{tl}} where the template name is shown in bold.
- {{temt}}, a version of {{tlx}} that handles templates whose names include "Template:" and pages outside the Template: namespace that are treated as templates.
- {{para}}, for the presentation of template parameters and values (e.g.
|paraname=val
,|another=
). - {{tnull}}, like {{tlx}} without linking the template.
General-purpose formatting
සංස්කරණයLink style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 →
|
අදාළ නොවේ | nolink=yes
|
subst=yes
|
braceinside=yes
|
alttext=Foo 2=Foo
|
normal | DEFAULT | {{tlg}} 1{{tl}} {{tlp}} 2{{tlu}} 3
|
{{tlf}} 2
|
{{tls}} {{tlsp}}
|
{{tn}}
|
{{tla}}
|
code
|
code=yes plaincode=yes 4
|
{{tl2}} {{tlx}}
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}}
|
අදාළ නොවේ | |
kbd monospace |
kbd=yes
|
{{tltt}} 5{{tltt2}} 5
|
අදාළ නොවේ | {{tltts}} 5{{tltts3}} 5{{tltss}} 6
|
අදාළ නොවේ | |
bold | bold=yes
|
{{tlb}}
|
අදාළ නොවේ | |||
bold+code
|
bold=yes|code=yes
|
{{tlxb}}
| ||||
italic+code
|
italic=yes|code=yes
|
{{tlxi}}
|
- 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 Allows links to templates in any namespace.
- 4 {{tlg|plaincode=yes}} uses
<code style="border:none; background:transparent;">...</code>
. - 5 Displays monospaced font using
<kbd>...</kbd>
tags (changed from<tt>...</tt>
for HTML5 compliance). - 6 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) |
{{tlu|User:Ahunt/SSHFS}} |
{{User:Ahunt/SSHFS}} | Supports linking to any namespace |
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} |
{{hatnote|lang=fr|Some text}} |
Shows code and example |
{{xpd|Hatnote|Some hatnote text}} |
"{{hatnote|Some hatnote text}}" gives " " [1] |
Shows code, example and a link to expand the template code |
{{para|title|<var>book title</var>}} |
|title=book title |
Formats template parameters for display, with or without values |
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}} |
[[Template:Hatnote]] [[Template:Hatnote|Hatnote]] |
Formats wikilink, with optional piped link text and blended suffix |
With utility links
සංස්කරණයCode example | Effect |
---|---|
{{lts|Hatnote}} |
|
{{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) |
{{tiw|Hatnote}} |
සැකිල්ල:hatnote (සාකච්ඡාව, backlinks, සාකච්ඡාව) |
{{tltt|Hatnote}} |
{{Hatnote}}
|
{{tetl|Hatnote}} |
{{ Hatnote }} |
{{tsetl|Hatnote}} |
{{subst:Hatnote}} |
{{ti|Hatnote}} |
Template:Hatnote (talk, links, edit) |
{{tic|Hatnote}} |
Template:Hatnote (talk, links, edit) |
{{tiw|Hatnote}} |
සැකිල්ල:Hatnote (සාකච්ඡාව, backlinks, සාකච්ඡාව) |
{{tlt|Hatnote}} |
{{Hatnote}} (doc/talk) |
{{ttl|Hatnote}} |
{{Hatnote}} (t/l) |
{{twlh|Hatnote}} |
Template:Hatnote (links, talk) |