Template:Substitution/doc: Difference between revisions
meta>Favonian m Reverted edits by 95.49.252.10 (talk) to last version by Minimac |
meta>KDS4444 Adding JSON parameter descriptions |
||
Line 2: | Line 2: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Substitution|not}} | {{Substitution|not}} | ||
<templatedata>{ | |||
"description": "Use this template to add a message box to a '''template's''' documentation subpage indicating if and how that template should be [[Wikipedia:Substitution|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== | ==Examples== |
Revision as of 10:20, 20 November 2016
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. |
Use this template to add a message box to a '''template's''' documentation subpage indicating if and how that template should be [[Wikipedia:Substitution|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
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. |
See also
- {{Nosubst}}
- {{Subst only}}
- {{Transclusionless}}