Template:Substitution/doc: Difference between revisions
meta>Geekdiva m →Parameters: no word between → no additional word between |
meta>Geekdiva Clarified subheads, such as : With no word and additional text → With no middle text but some additional text at the end. Improved the text in Parameters. |
||
| Line 7: | Line 7: | ||
===Parameters=== | ===Parameters=== | ||
Add the ''first parameter'' by adding a pipe (<code><nowiki>|</nowiki></code>) 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." | |||
The second parameter is optional. | 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 (<code><nowiki>|</nowiki></code>) 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== | ==Examples== | ||
=== With | === With middle text but and no additional text at the end === | ||
<code><nowiki>{{Substitution|not}}</nowiki></code> | <code><nowiki>{{Substitution|not}}</nowiki></code> | ||
| Line 19: | Line 21: | ||
{{Substitution|not}} | {{Substitution|not}} | ||
=== With | === With both middle text and additional text at the end=== | ||
<code><nowiki>{{Substitution|only|if temperatures fall and it starts to snow}}</nowiki></code> | <code><nowiki>{{Substitution|only (at least as of 2016)|if temperatures fall and it starts to snow}}</nowiki></code> | ||
produces: | produces: | ||
{{Substitution|only|if temperatures fall and it starts to snow}} | {{Substitution|only (at least as of 2016)|if temperatures fall and it starts to snow}} | ||
=== With no | === With no middle text but some additional text at the end=== | ||
Note the space in the first parameter. | Note the space in the first parameter. | ||
| Line 34: | Line 35: | ||
produces: | produces: | ||
{{Substitution| |if you wish to ensure your | {{Substitution| |if you wish to ensure your emoji image remains the same even if its template image is changed}} | ||
==See also== | ==See also== | ||
Revision as of 07:44, 8 February 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. |
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 and 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 2016)|if temperatures fall and it starts to snow}}
produces:
| This template should only (at least as of 2016) 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}}
