Template:May be substituted

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

Usage

{{May be substituted}}

This template should be placed on the documentation subpage (not the template page itself) of any template that may be substituted (but may also be transcluded).

Parameters

• This template accepts one optional parameter, which can be used to give a more detailed description of why the template in question should not be substituted. For example, {{May be substituted|Example text.}} produces:

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.
  • {{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.
• Module:Unsubst – Prevents substitution.
• Module:Unsubst-infobox – Prevents substitution for infoboxes, cleans up parameters.

The above documentation is transcluded from Template:May be substituted/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.