Template:Substitution/doc

Not to be confused with Template:Subst or Template:Substituted.

<templatedata>{

 "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",
     "default": "",
     "autovalue": "",
     "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": "",
     "autovalue":"",
     "required": false
   }
 }

}</templatedata>

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}}