Template:TemplateData: Difference between revisions
(Add `params` alias for `1`) |
(Display `format` parameter value) |
||
| Line 3: | Line 3: | ||
-->{{#vardefine:templateData-convert|{{#expr:not{{WsBool|{{{noConvert|}}}}}}}}}<!-- | -->{{#vardefine:templateData-convert|{{#expr:not{{WsBool|{{{noConvert|}}}}}}}}}<!-- | ||
-->{{#ifexpr:{{#if:{{{1|}}}|1|not{{WsBool|{{#var:templateData-continue}}}}or{{WsBool|{{{noConvert|}}}}}}}|<!-- | -->{{#ifexpr:{{#if:{{{1|}}}|1|not{{WsBool|{{#var:templateData-continue}}}}or{{WsBool|{{{noConvert|}}}}}}}|<!-- | ||
--><p>Do not use named parameter for <code>1</code> ... <code>x</code>. The first Parameter will be automatically marked as <code>1</code>, the second as <code>2</code> and so on.</p> | --><p>Do not use named parameter for <code>1</code> ... <code>x</code>. The first Parameter will be automatically marked as <code>1</code>, the second as <code>2</code> and so on.</p><!-- | ||
--> | |||
{{(!}} class="wikitable sortable" style="width: 100%;" | {{(!}} class="wikitable sortable" style="width: 100%;" | ||
{{!}}- | {{!}}- | ||
| Line 13: | Line 14: | ||
{{#if:{{{params|}}}|{{{params}}}|{{{1}}}}} | {{#if:{{{params|}}}|{{{params}}}|{{{1}}}}} | ||
{{!)}} | {{!)}} | ||
<p>See [[Template:TemplateData]] and [[Template:TemplateData/entry]] for more information about the parameter list and [[Template:TemplateData/entry#Data Dictionary Notation (DDN) for types|DDNCode]] for more information about types and the DDN Notation</p><!-- | <!-- | ||
-->{{#if:{{{format|}}}|<!-- | |||
--><dl><!-- | |||
--><dt style="float: left; margin-right: 0.5em;">Format:</dt><!-- | |||
--><dd><!-- | |||
-->{{#switch:{{{format}}}<!-- | |||
-->| block | inline =<!-- | |||
--><span class="oo-ui-iconWidget oo-ui-iconElement-icon oo-ui-icon-template-format-{{{format}}}" style="margin-right: 0.25em; background-color: transparent;"></span><!-- | |||
-->''{{ucfirst:{{{format}}}}}''<!-- | |||
-->| #default =<!-- | |||
--><span class="oo-ui-iconWidget oo-ui-iconElement-icon oo-ui-icon-settings" style="margin-right: 0.5em;"></span><!-- | |||
-->{{#if:{{#pos:{{{format}}}|<nowiki/> | |||
<nowiki/>}}|{{#tag:pre|{{{format}}}}}|<code>{{#tag:nowiki|{{{format}}}}}</code>}}<!-- | |||
-->}}<!-- | |||
--></dd><!-- | |||
--></dl><!-- | |||
-->}}<!-- | |||
--><p>See [[Template:TemplateData]] and [[Template:TemplateData/entry]] for more information about the parameter list and [[Template:TemplateData/entry#Data Dictionary Notation (DDN) for types|DDNCode]] for more information about types and the DDN Notation</p><!-- | |||
-->}}<!-- | -->}}<!-- | ||
-->{{#ifeq:{{#var:templateData-convert}}|1<!-- | -->{{#ifeq:{{#var:templateData-convert}}|1<!-- | ||
Revision as of 16:23, 23 May 2021
Template for creating a unified parameter format for templates
About
Creates a list that displays Template parameter in a unified format.
Parameter
Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Description | desc
|
The MediaWiki TemplateData description property, ignored if
|
Plaintext | Recommended |
| Format | format
|
The MediaWiki TemplateData format string, ignored if
|
FormatString | Recommended |
| Entries | 1params
|
Parameter list
|
1 {Template:TemplateData/entry} | Required |
| Partial? | partial
|
Whether this TemplateData block is not the last, ignored if
|
Boolean | Optional |
| No Conversion | noConvert
|
If set, other than to 0, prevents MediaWiki TemplateData from being produced. Potentially useful if there are multiple instances of this template on a page but only one should be active. To clarify, this means that this template will not be understood by the VisualEditor.
|
Boolean | Optional |
- Format:
{{_ | ______ = _ }}
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
Creates a table that displays Template parameters in a unified format and emits the equivalent MediaWiki TemplateData.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Description | desc | The [[mw:Help:TemplateData#Description|MediaWiki TemplateData description property]], ignored if <code>noConvert</code> or <code>partial</code> is <code>1</code>. | Content | suggested |
| Format | format | The [[mw:Help:TemplateData#Format|MediaWiki TemplateData format string]], ignored if <code>noConvert</code> or <code>partial</code> is <code>1</code>. | Content | suggested |
| Entries | 1 params | Parameter list | Content | required |
| Partial? | partial | Whether this TemplateData block is not the last, ignored if <code>noConvert</code> is <code>1</code>.
| Boolean | optional |
| No Conversion | noConvert | If set, other than to 0, prevents [[mw:Help:TemplateData|MediaWiki TemplateData]] from being produced. Potentially useful if there are multiple instances of this template on a page but only one should be active. To clarify, this means that this template will ''not'' be understood by the VisualEditor.
| Boolean | optional |
Examples
{{#lsth:Template:TemplateData/entry/doc|Examples}}