Template:TemplateData: Difference between revisions
(Display `format` parameter value) |
(Show raw JSON output when `debug = 1`) |
||
| Line 38: | Line 38: | ||
-->{{#if:{{#var:templateData-params}}<!-- | -->{{#if:{{#var:templateData-params}}<!-- | ||
-->|<nowiki/> | -->|<nowiki/> | ||
<div class="{{#ifeq:{{WsBool|{{{debug|}}}}}|0|wds-is-hidden|mw-collapsible" style="display: flow-root;}}"><!-- | <div class="{{#ifeq:{{WsBool|{{{debug|}}}}}|0|wds-is-hidden|mw-collapsible mw-collapsed" style="display: flow-root;}}"><!-- | ||
-->{{# | -->'''Test of raw TemplateData output''':<!-- | ||
--><div class="mw-collapsible-content"><!-- | |||
-->{{#vardefine:templateData-JSON| | |||
{{(}} | {{(}} | ||
{{#if:{{{desc|}}}|"description": {{#invoke:Json|encode|{{{desc}}}}}}}<!-- | {{#if:{{{desc|}}}|"description": {{#invoke:Json|encode|{{{desc}}}}}}}<!-- | ||
| Line 49: | Line 51: | ||
{{)}}|{{(}}{{)}}}} | {{)}}|{{(}}{{)}}}} | ||
{{)}} | {{)}} | ||
}}</div><!-- | }}<!-- | ||
-->{{#tag:templatedata|<!-- | |||
-->{{#var:templateData-JSON}}<!-- | |||
-->}}<!-- | |||
--></div><!-- | |||
--></div><!-- | |||
-->{{#ifeq:{{WsBool|{{{debug|}}}}}|1|<!-- | |||
--><div class="mw-collapsible mw-collapsed" style="display: flow-root;"><!-- | |||
-->'''Test of raw TemplateData JSON''':<!-- | |||
--><div class="mw-collapsible-content"><!-- | |||
-->{{#tag:syntaxhighlight|<!-- | |||
-->{{#var:templateData-JSON}}<!-- | |||
-->| lang = "json"<!-- | |||
-->}}<!-- | |||
--></div><!-- | |||
--></div><!-- | |||
-->}}<!-- | |||
-->{{#vardefine:templateData-params}}<!-- | -->{{#vardefine:templateData-params}}<!-- | ||
-->}}<!-- | -->}}<!-- | ||
| Line 55: | Line 73: | ||
-->}}<!-- | -->}}<!-- | ||
-->}}<!-- | -->}}<!-- | ||
-->{{#vardefine:templateData-JSON}}<!-- | |||
-->{{#vardefine:templateData-convert}}<!-- | -->{{#vardefine:templateData-convert}}<!-- | ||
--></includeonly></onlyinclude> | --></includeonly></onlyinclude> | ||
Revision as of 18:22, 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}}