Template:Substitution

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

Not to be confused with Template:Subst or Template:Substituted.

Examples

With middle text but no additional text at the end

{{Substitution|not}}

produces:

With both middle text and additional text at the end

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

produces:

With no middle text but some additional text at the end

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

produces:

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this 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

Parameter		Description	Type	Status
1	first parameter	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	second parameter	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 Default Example unless older versions cannot be found	String	optional

See also

• {{Transclusionless}}

List of subst helper templates

• {{require substitution}} – Prints an error unless substituted.
  • {{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.
  • {{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.
• Module:Unsubst – Prevents substitution.
• Module:Unsubst-infobox – Prevents substitution for infoboxes, cleans up parameters.

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