Template:Substitute/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
mNo edit summary
ArrowHead294 (talk | contribs)
mNo edit summary
Line 1: Line 1:
{{dochead}}{{{{ROOTPAGENAMEE}}|no}}
{{dochead}}{{{{ROOTPAGENAMEE}}|no}}{{wikipedia|Template:Always substitute|Template:May be substituted|Template:Never substitute}}
This template is used as a header to show whether a template should be substituted or not.
This template is used as a header to show whether a template should be substituted or not.


Line 11: Line 11:


=== Usage ===
=== Usage ===
==== Templates that ''must'' be substituted ====
Equivalent to Wikipedia's {{w|Template:Always substitute}}
<pre>{{substitute|always}}</pre>
<pre>{{substitute|always}}</pre>
{{{{ROOTPAGENAMEE}}|always}}
{{{{ROOTPAGENAMEE}}|always|tname=[Template name]}}
 


==== Templates that ''must not'' be substituted ====
Equivalent to Wikipedia's {{w|Template:Never substitute}}.
<pre>{{substitute|no}}</pre>
<pre>{{substitute|no}}</pre>
{{{{ROOTPAGENAMEE}}|no}}
{{{{ROOTPAGENAMEE}}|no}}


 
==== Templates that can be substituted or transcluded ====
Equivalent to Wikipedia's {{w|Template:May be substituted}}.
<pre>{{substitute|both}}</pre>
<pre>{{substitute|both}}</pre>
{{{{ROOTPAGENAMEE}}|both}}
{{{{ROOTPAGENAMEE}}|both}}

Revision as of 12:24, 21 May 2025

This template should not be substituted.

This template is used as a header to show whether a template should be substituted or not.

{{substitute}} should be placed on the documentation subpage of any template that requires substitution rather than transclusion (i.e. not on the template's own page itself).

Templates that should always be substituted must be added to Category:Substituted templates.

Parameters

{{{1}}} (required)
Set this to always if the template should always be substituted, no if the template should not be substituted, or both if the template can be either substituted or transcluded.

Usage

Templates that must be substituted

Equivalent to Wikipedia's Template:Always substitute

{{substitute|always}}
This template should always be substituted (i.e. use {{subst:[Template name]}}).

Templates that must not be substituted

Equivalent to Wikipedia's Template:Never substitute.

{{substitute|no}}
This template should not be substituted.

Templates that can be substituted or transcluded

Equivalent to Wikipedia's Template:May be substituted.

{{substitute|both}}
This template may be substituted.