Template:Substitution/doc
Jump to navigation
Jump to search
This is a documentation subpage for Template:Substitution. It contains usage information, categories and other content or metadata that is not part of the original template. |
This template should not be substituted. |
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
{{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
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for Substitution
{
"description": "Use this template to add a message box to a template's documentation subpage indicating if and how that template should be substituted.",
"params": {
"first parameter": {
"label": "1",
"description": "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",
"type": "string",
"example": "never",
"required": true
},
"second parameter": {
"label": "2",
"description": "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",
"type": "string",
"example": "unless older versions cannot be found",
"default": "",
"required": false
}
}
}
See also
- {{Transclusionless}}