Template:TemplateData/entry/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. This template creates a single entry for the Required template Template:TemplateData.

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
Parameter title	name	Specify a title for a parameter of the template documentation Default: NULL Example: no example	String	Required
Parameter name	param	Specify a name for a parameter of the template documentation Default: NULL Example: no example	String	Required
Parameter alias1	alias1	Specify a alias for a parameter of the template documentation Default: NULL Example: no example	String	Optional
Parameter alias2	alias2	Specify a alias for a parameter of the template documentation Default: NULL Example: no example	String	Optional
Parameter alias3	alias3	Specify a alias for a parameter of the template documentation Default: NULL Example: no example	String	Optional
Parameter Description	desc	Specify a description for a parameter of the template documentation Default: no description Example: no example	String	Recommended
Parameter Example	example	Specify an example for a parameter of the template documentation Default: no example Example: no example	String	Recommended
Parameter type	type	Specify a type for a parameter of the template documentation: String, Number, Boolean, a Template or the modified BNF notation which is used in Data dictionaries (Data Dictionary Notation) Default: NULL Example: no example	String	Required
Parameter status	status	Specify a status for a parameter of the template documentation (Required, Recommended, Optional) Default: NULL Example: no example	String	Required

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:

No description.

Template parameters

Parameter		Description	Type	Status
Parameter title	name	Specify a title for a parameter of the template documentation	String	required
Parameter name	param	Specify a name for a parameter of the template documentation	String	required
Parameter alias1	alias1	Specify a alias for a parameter of the template documentation	String	optional
Parameter alias2	alias2	Specify a alias for a parameter of the template documentation	String	optional
Parameter alias3	alias3	Specify a alias for a parameter of the template documentation	String	optional
Parameter Description	desc	Specify a description for a parameter of the template documentation Default no description	String	suggested
Parameter Example	example	Specify an example for a parameter of the template documentation Default no example	String	suggested
Parameter type	type	Specify a type for a parameter of the template documentation: String, Number, Boolean, a Template or the modified [https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form BNF notation] which is used in Data dictionaries (Data Dictionary Notation)	String	required
Parameter status	status	Specify a status for a parameter of the template documentation (Required, Recommended, Optional)	String	required

Examples

Complete example:

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
Example name	example param Example alias 1 Example alias 2 Example alias 3	example description Default: NULL Example: xyz	String	Required

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:

No description.

Template parameters

Parameter		Description	Type	Status
Example name	example param Example alias 1 Example alias 2 Example alias 3	example description Example xyz	String	required

{{TemplateData|
{{TemplateData/entry|name=Example name|alias1=Example alias 1|alias2=Example alias 2|alias3=Example alias 3|param=example param|desc=example description|def=NULL|example=xyz|type=String|status=Required}}
}}

Data Dictionary Notation (DDN) for custom types

Type	Notation	Description
Sequence	+	Sequence of definition
Alternative	[...|...]	Only one element out of this list
Repetition	{...}	Repetition of the definition
Repetition	2 {...}	Repetition of the definition with the minimum of two
Repetition	{...} 5	Repetition of the definition with the maximum of five
Repetition	1 {...} 6	Repetition of the definition with the minimum of one and the maximum of six
Option	()	Optional definition
Specific value	"..."	fix definition

Predefined

• String
• Number
• Boolean
• All parameter names of the current template

Examples

• String + Number + {param}

(param is in this example an other parameter of the template)

• String + " = " + 1 {String} 2
• String + (Number)

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