.svg)
Template:Parameter names example/doc: Difference between revisions
(Created page with "{{Documentation subpage}} <!----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 template documentation by producing a generic instance of the template that u...") |
CleanupBot (talk | contribs) m (clean up) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!----Categories where indicated at the bottom of this page, please; interwikis at | <!----Categories where indicated at the bottom of this page, please; interwikis at Bharatdata (see [[Bharatpedia:Bharatdata]])----> | ||
{{Lua|Module:Parameter names example}} | {{Lua|Module:Parameter names example}} | ||
{{Template redirect|Generic template demo|Pnex}} | {{Template redirect|Generic template demo|Pnex}} | ||
{{tl|Parameter names example}} – or, alternatively, {{tl|Generic template demo}} – is intended to assist [[ | {{tl|Parameter names example}} – or, alternatively, {{tl|Generic template demo}} – is intended to assist [[Bharatpedia:Template documentation|template documentation]] by producing a generic instance of the template that uses [[Help:Templates#Parameters|parameters' names]] as those parameters' values. | ||
{{clear}} | {{clear}} | ||
| Line 40: | Line 40: | ||
== See also == | == See also == | ||
* [[ | * [[Bharatpedia:Template documentation]] | ||
* [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template | * [[Template:Parameters]] and [[Module:Parameters]] – generates a list of parameter names for a given template | ||
<includeonly>{{Sandbox other| | <includeonly>{{Sandbox other| | ||
| <!----Categories below this line, please; interwikis at | | <!----Categories below this line, please; interwikis at Bharatdata----> | ||
[[Category: | [[Category:Bharatpedia utility templates]] | ||
[[Category:Template namespace templates]] | [[Category:Template namespace templates]] | ||
[[Category:Documentation assistance templates]] | [[Category:Documentation assistance templates]] | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 10:26, 5 December 2023
 | This is a documentation subpage for Template:Parameter names example. It contains usage information, categories and other content that is not part of the original template page. |
 | This template uses Lua: |
Error: no shortcuts were specified and the |msg= parameter was not set.
{{Parameter names example}} – or, alternatively, {{Generic template demo}} – is intended to assist template documentation by producing a generic instance of the template that uses parameters' names as those parameters' values.
Example
The example opposite for {{Infobox}}, for instance, was produced by:
| {{{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
- Bharatpedia:Template documentation
- Template:Parameters and Module:Parameters – generates a list of parameter names for a given template