Template:Substitution/sandbox

This template should only be substituted (i.e, use {{subst:Substitution}}).

Template documentation[view] [edit] [history] [purge]

Examples

{{Substitution|not}}

produces:

This template should not be substituted.

{{Substitution|only (at least as of 2024)|if temperatures fall and it starts to snow}}

produces:

This template should only (at least as of 2024) be substituted if temperatures fall and it starts to snow.

{{Substitution| |if you wish to ensure your emoji's image remains the same even if its template's image is changed}}

produces:

This template should be substituted if you wish to ensure your emoji image remains the same even if its template image is changed.

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Substitution in articles based on its TemplateData.

TemplateData for Substitution

Use this template to add a message box to a template's documentation subpage indicating if and how that template should be substituted.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
1	`1`	Inserts any helpful or instructive text in bold font such as 'always' or 'never' between the words 'should' and 'be' in the resulting message box; if no such instruction is desired, this parameter should be entered as a single blank typed space (in this sense, the parameter is required: it must be an instructive word OR it must be a blank typed space—it must NOT be left with no entry Example never	String	required
2	`2`	This parameter takes any text you add to it and places it at the end of the sentence that the message box generates; it should NOT end in a period Example unless older versions cannot be found	String	optional

{{require substitution}} – Prints an error unless substituted.
{{substituted or transcluded}} – if-then-else metatemplate that checks if a template is currently being substituted or transcluded
- {{always substitute}} – For the doc of the above templates; prints a message asking for it be substituted.
- {{never substitute}} – The reverse of {{always substitute}}. For the doc of templates which should not be substituted; prints a message asking for it not to be substituted.
- {{may be substituted}} – For the doc of templates whose substitution is optional.
- {{substitution}} – Allows free-fill description of whether the template should be substituted and under what conditions.
{{ifsubst}} – Forks if substituted or not.
{{issubst}} – Returns "yes" if substituted.
{{HTML comment}} – To sign substitutions with comments that contain wikitext expansions
Module:Unsubst – Prevents substitution.
Module:Unsubst-infobox – Prevents substitution for infoboxes, cleans up parameters.

The above documentation is transcluded from Template:Substitution/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.