Template:Substitute/doc: Difference between revisions
Jump to navigation
Jump to search
ArrowHead294 (talk | contribs) mNo edit summary |
ArrowHead294 (talk | contribs) mNo edit summary |
||
(12 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{dochead}} | {{dochead}}{{wikipedia|Template:Always substitute|Template:Never substitute|Template:May be substituted}} | ||
This template is used | This template is used to indicate that a template can be substituted. '''This template itself, however, should never be substituted.''' | ||
{{tlx|substitute}} should be placed on the {{w|Wikipedia:Template documentation|documentation}} {{w|subpage|s=wp}} of any template that can be used with {{w|substitution|s=mw:help}} rather than {{w|transclusion|s=mw:help}} (i.e. not on the template's own page itself). | |||
Templates that should always be substituted are automatically added to [[:Category:Substituted templates]]. | |||
=== Parameters === | |||
; <code>{{{<nowiki />1}}}</code> (required) | |||
: Set this to <code>always</code> if the template ''should always'' be substituted or <code>no</code> if the template ''should not'' be substituted. Leave it blank if the template can be either substituted or transcluded. | |||
=== Usage === | === Usage === | ||
{{ | ==== Templates that ''can'' be substituted ==== | ||
Equivalent to Wikipedia's {{w|Template:May be substituted}}. This is the default option, indicating that a template works either way. | |||
<pre>{{substitute}}</pre> | |||
{{ {{ROOTPAGENAMEE}} }} | |||
Templates that | ==== Templates that ''must'' be substituted ==== | ||
Equivalent to Wikipedia's {{w|Template:Always substitute}}. | |||
<pre>{{substitute|always}}</pre> | |||
{{{{ROOTPAGENAMEE}}|always}} | |||
==== | ==== Templates that ''must not'' be substituted ==== | ||
Equivalent to Wikipedia's {{w|Template:Never substitute}}. | |||
<pre>{{substitute|no}}</pre> | |||
{{{{ROOTPAGENAMEE}}|no}} |
Latest revision as of 16:54, 27 May 2025
This template is used to indicate that a template can be substituted. This template itself, however, should never be substituted.
{{substitute}}
should be placed on the documentation subpage of any template that can be used with substitution rather than transclusion (i.e. not on the template's own page itself).
Templates that should always be substituted are automatically added to Category:Substituted templates.
Parameters
{{{1}}}
(required)- Set this to
always
if the template should always be substituted orno
if the template should not be substituted. Leave it blank if the template can be either substituted or transcluded.
Usage
Templates that can be substituted
Equivalent to Wikipedia's Template:May be substituted. This is the default option, indicating that a template works either way.
{{substitute}}
![]() |
This template may be substituted. |
Templates that must be substituted
Equivalent to Wikipedia's Template:Always substitute.
{{substitute|always}}
![]() |
This template should always be substituted (i.e. use {{subst:Substitute}} ).
|
Templates that must not be substituted
Equivalent to Wikipedia's Template:Never substitute.
{{substitute|no}}
![]() |
This template should not be substituted. |