Template:Substitution
This template should {{{1}}} be substituted. |
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.
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
| 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
| String | optional |
Examples
[edit]With middle text but no additional text at the end
[edit]{{Substitution|not}}
produces:
This template should not be substituted. |
With both middle text and additional text at the end
[edit]{{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. |
With no middle text but some additional text at the end
[edit]{{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. |
See also
[edit]- {{Nosubst}}
- {{Subst only}}
- {{Transclusionless}}