Template:TemplateData/doc

File:Template-info.svg Template Documentation

[purge]

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 noConvert or partial is 1. Example: no example	Plaintext	Recommended
Format	format	The MediaWiki TemplateData format string, ignored if noConvert or partial is 1. Example: no example	FormatString	Recommended
Entries	1 params	Parameter list Example: no example	1 {Template:TemplateData/entry}	Required
Partial?	partial	Whether this TemplateData block is not the last, ignored if noConvert is 1. Default: 0 Example: no example	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. Default: 0 Example: no example	Boolean	Optional

Format:

Custom:

{{_
| ______ = _
}}

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

Test of raw TemplateData output:

Creates a table that displays Template parameters in a unified format and emits the equivalent MediaWiki TemplateData.

Template parameters

This template has custom formatting.

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>. Default 0	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. Default 0	Boolean	optional

Examples

{{#lsth:Template:TemplateData/entry/doc|Examples}}

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.