Template:Must be substituted/doc: Difference between revisions

Revision as of 22:02, 8 June 2015

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Must be substituted.

message box for templates that must be substituted

Template parameters
Parameter		Description	Type	Status
page	`page`	template page to use for substitution if not the actual template's one	Page name	suggested
VisualEditor	`ve`	if the VisualEditor can be used instead of substitution	Boolean	suggested

@@ Line 1: / Line 1: @@
-{{TemplateBox
+<noinclude>{{documentation subpage}}</noinclude><templatedata>
-|name=Must be substituted
+{
-|desc=This template marks all templates that must be substituted.
+	"params": {
-|namespace=template
+		"page": {
-|usergroup=all
+			"type": "wiki-page-name",
-|usage-notes=
+			"suggested": true,
-This one doesn't need to be subst'd, just the pages it's on.
+			"description": "template page to use for substitution if not the actual template's one"
-*Only use this for templates that ''must'' be substituted because they have a purpose and/or syntax that require them to be. For templates that ''should'' be substituted, use {{tl|should be substituted}}.
+		},
-*Don't forget to enclose this in <nowiki><noinclude></nowiki> tags. (Usually placed above the template itself.)
+		"ve": {
-*This template lowercases the template name by default; to override this, use <nowiki>|name=''name''</nowiki>
+			"label": "VisualEditor",
-|type=
+			"type": "boolean",
-|example=
+			"suggested": true,
-|i18n-method=autotranslate
+			"description": "if the VisualEditor can be used instead of substitution"
-|i18n-desc=
+		}
-|seealso=
+	},
-|setscats=
+	"description": "message box for templates that must be substituted"
-|lines=one
+}
-|shorthand=
+</templatedata>
-|relieson=
-}}