Template:Substitution/doc

This template should NOT be substituted.

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 Default Example never Auto value	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 Auto value	String	optional

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:

See also

• {{Nosubst}}
• {{Subst only}}
• {{Transclusionless}}