Template:Substitution/doc
![]() | This is a documentation subpage for Template:Substitution. It may contain usage information, categories and other content that is not part of the original template page. |
![]() | This template should not be substituted. |
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. |
TemplateData
[edit]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.
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
| 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
| String | optional |
See also
[edit]- {{Transclusionless}}
List of subst helper templates
[edit]- {{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.