Template:Substitution/doc
This is a documentation subpage for Template:Substitution. It contains usage information, categories and other content that is not part of the original template page. |
This template should not be substituted. |
Usage
Add this message box to a template's documentation to briefly explain the rules of substitution for the template.
Parameters
Add the first parameter by adding a pipe (|
) followed by the text you wish to display bolded and in a larger font. This parameter inserts your chosen text, such as "always" or "never," in the middle of "should" and "be."
To have no text in the middle of "should" and "be," add a space after the first pipe.
The second parameter is optional. To use it, add a second pipe (|
) followed by the text you wish to add to the end of the sentence. Note that you should not include ending punctuation at the end of the text you put in this parameter. The template will always include a full stop (a period) at the end for you.
Examples
With middle text but no additional text at the end
{{Substitution|not}}
produces:
This template should not be substituted. |
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:
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
Note the space in the first parameter.
{{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
- {{Nosubst}}
- {{Subst only}}
- {{Transclusionless}}