Template:Error:must be substituted

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Error:must be substituted/doc.

Error message for when a template needing substitution is not substituted.

The template automatically sets the following categories:

• Category:Templates needing substitution (intentionally left red)

Usage

{{Error:must be substituted |1= }}

Or use the shorthand

• {{Error:not substituted}}

Use in the false branch of {{ifsubst}}.

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

---

Wikipedia's help about TemplateData • Commons-specific information

Use in the false branch of {{ifsubst}} to produce a standardised error message when the template is not substituted.

Template parameters

Parameter		Description	Type	Status
Don’t Categorise?	nocat	Whether to not add the transcluding page to “Category:Templates needing substitution”. Default 0 Auto value 1	Boolean	optional
Template Name	1	The name of the template that must be substituted. Auto value {{subst:#switch:{{subst:NAMESPACE}}|{{subst:ns:10}}=|{{subst:ns:0}}=:|#default={{subst:NAMESPACE}}:}}{{subst:PAGENAME}}	Template	required

Edit parameter translations

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

Example

{{Error:must be substituted|Example}}

renders as:

See also

• {{Error}}
• {{must be substituted}}

Localization

This template is localized using Module:TNT. These translations are stored in Data:I18n/Error:must be substituted.tab.