Template:Substitution/doc: Difference between revisions
meta>Hyacinth |
m 35 revisions imported |
||
(27 intermediate revisions by 17 users not shown) | |||
Line 1: | Line 1: | ||
{{Distinguish|Template:Subst}} | {{Distinguish|Template:Subst|Template:Substituted}} | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{nosubst}} | |||
==Examples== | |||
=== With middle text but no additional text at the end === | |||
<code><nowiki>{{Substitution|not}}</nowiki></code> | |||
produces: | |||
{{Substitution|not}} | {{Substitution|not}} | ||
== | === With both middle text and additional text at the end=== | ||
<code><nowiki>{{Substitution|only (at least as of </nowiki>{{CURRENTYEAR}}<nowiki>)|if temperatures fall and it starts to snow}}</nowiki></code> | |||
produces: | |||
{{Substitution|only (at least as of {{CURRENTYEAR}})|if temperatures fall and it starts to snow}} | |||
=== With no middle text but some additional text at the end=== | |||
<code><nowiki>{{Substitution| |if you wish to ensure your emoji's image remains the same even if its template's image is changed}}</nowiki></code> | |||
<code><nowiki>{{Substitution| | |||
produces: | produces: | ||
{{Substitution| | {{Substitution| |if you wish to ensure your emoji image remains the same even if its template image is changed}} | ||
< | == TemplateData == | ||
{{TemplateDataHeader}} | |||
<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", | |||
"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 | |||
} | |||
} | |||
}</templatedata> | |||
==See also== | |||
* {{tl|Nosubst}} | |||
* {{tl|Subst only}} | |||
* {{tl|Transclusionless}} | |||
</includeonly> | <includeonly>{{sandbox other|| | ||
[[Category:Documentation header templates]] | |||
}}</includeonly> |
Latest revision as of 13:55, 3 September 2020
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
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
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 | 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 |
See also
- {{Nosubst}}
- {{Subst only}}
- {{Transclusionless}}