Template:Template link/doc: Difference between revisions
More actions
No edit summary |
No edit summary Tag: Reverted |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Categories | {{High-use}} | ||
{{ | <!----Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])----> | ||
{{Lua|Module:Parameter names example}} | |||
{{Template redirect|Generic template demo|Pnex}} | |||
{{tl|Parameter names example}} – or, alternatively, {{tl|Generic template demo}} – is intended to assist [[Wikipedia:Template documentation|template documentation]] by producing a generic instance of the template that uses [[Help:Templates#Parameters|parameters' names]] as those parameters' values. | |||
{{clear}} | |||
== | ==Example== | ||
An example wikitext to produce a demo for {{tl|Infobox}} (on the right): | |||
{{Parameter names example |_template=Infobox |title |above |subheader |subheader2 |image |caption |header1 |label2 |data2 |label3 |data3 |header4 |data5 |data6 |below}} | |||
<pre style="overflow:auto;"> | |||
{{Parameter names example | |||
|_template=Infobox | |||
|title |above |subheader |subheader2 |image |caption | |||
|header1 |label2 |data2 |label3 |data3 |header4 | |||
|data5 |data6 |below | |||
}} | |||
</pre> | |||
==Usage notes== | |||
When {{tlf|Parameter names example}} is used on an immediate subpage of its target template – e.g. on the target template's /doc page – its own {{para|_template}} parameter identifying the target template may be omitted. In other words, the code above, if used on Template:Infobox/''page'' (where ''page'' could be "doc", "testcases", etc.), would become: | |||
= | <pre style="overflow:auto;"> | ||
{{ | {{Parameter names example | ||
< | |title |above |subheader |subheader2 |image |caption | ||
|header1 |label2 |data2 |label3 |data3 |header4 | |||
|data5 |data6 |below | |||
}} | |||
</pre> | |||
One exception to this is the "sandbox" subpage. If the module is called from a page ending in "/sandbox", it uses that page to generate the template output, not the base page. To override this behaviour you can specify the {{para|_template}} parameter explicitly. | |||
The formatting of the parameter names can be changed with the {{para|_display}} parameter. By default, the parameter names are shown in triple braces (the [[m:Help:Templates#Parameters|parameter standard]], e.g. {{{name}}}{{thin space}}), but if {{para|_display|italics}} or {{para|_display|italic}} is set, they are shown in italics. | |||
A custom value for a parameter may be supplied by using {{para|[parameter name]|[value]}} in place of <code>|[parameter name]</code>. Any formatting for such a value – including, for instance, italics – must be supplied as part of the value (e.g. {{para|parameter|<nowiki>''value''<br/></nowiki>}}). Custom values cannot be used for parameters whose names begin with an underscore ("_"). | |||
}</ | |||
== See also == | == See also == | ||
* | * [[Wikipedia:Template documentation]] | ||
* [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template | |||
* | |||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other| | ||
<!-- Categories | | <!----Categories below this line, please; interwikis at Wikidata----> | ||
[[Category: | [[Category:Wikipedia formatting templates]] | ||
[[Category:Template namespace templates]] | |||
[[Category:Documentation assistance templates]] | |||
}}</includeonly> | }}</includeonly> |
Revision as of 07:48, 17 February 2025
This is a documentation subpage for Template:Template link. It may contain usage information, categories and other content that is not part of the original template page. |
Uses Lua: |
{{Parameter names example}} – or, alternatively, {{Template:Parameter names example}} – is intended to assist template documentation by producing a generic instance of the template that uses parameters' names as those parameters' values.
Example
An example wikitext to produce a demo for {{Infobox}} (on the right):
{{{above}}} | |
---|---|
{{{subheader}}} | |
{{{subheader2}}} | |
{{{image}}} {{{caption}}} | |
{{{header1}}} | |
{{{label2}}} | {{{data2}}} |
{{{label3}}} | {{{data3}}} |
{{{header4}}} | |
{{{data5}}} | |
{{{data6}}} | |
{{{below}}} |
{{Parameter names example |_template=Infobox |title |above |subheader |subheader2 |image |caption |header1 |label2 |data2 |label3 |data3 |header4 |data5 |data6 |below }}
Usage notes
When {{Parameter names example}} is used on an immediate subpage of its target template – e.g. on the target template's /doc page – its own |_template=
parameter identifying the target template may be omitted. In other words, the code above, if used on Template:Infobox/page (where page could be "doc", "testcases", etc.), would become:
{{Parameter names example |title |above |subheader |subheader2 |image |caption |header1 |label2 |data2 |label3 |data3 |header4 |data5 |data6 |below }}
One exception to this is the "sandbox" subpage. If the module is called from a page ending in "/sandbox", it uses that page to generate the template output, not the base page. To override this behaviour you can specify the |_template=
parameter explicitly.
The formatting of the parameter names can be changed with the |_display=
parameter. By default, the parameter names are shown in triple braces (the parameter standard, e.g. {{{name}}} ), but if |_display=italics
or |_display=italic
is set, they are shown in italics.
A custom value for a parameter may be supplied by using |[parameter name]=[value]
in place of |[parameter name]
. Any formatting for such a value – including, for instance, italics – must be supplied as part of the value (e.g. |parameter=''value''<br/>
). Custom values cannot be used for parameters whose names begin with an underscore ("_").
See also
- Wikipedia:Template documentation
- Template:Parameters and Module:Parameters – generates a list of parameter names for a given template