Template:Substitute/doc: Difference between revisions

ArrowHead294 (talk | contribs)
mNo edit summary
ArrowHead294 (talk | contribs)
mNo edit summary
Line 2: Line 2:
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.


=== Usage ===
{{tlx|substitute}} should be placed on the {{w|Wikipedia:Template documentation|documentation}} {{w|subpage|s=wp}} of any template that requires [[mw:help:substitution|substitution]] rather than [[mw:help:transclusion|transclusion]] (i.e. not on the template's own page itself).
{{tlx|substitute}} should be placed on the {{w|Wikipedia:Template documentation|documentation}} {{w|subpage|s=wp}} of any template that requires [[mw:help:substitution|substitution]] rather than [[mw:help:transclusion|transclusion]] (i.e. not on the template's own page itself).


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


==== Parameters ====
=== Parameters ===
; <code>{{{<nowiki />1}}}</code> (required)
; <code>{{{<nowiki />1}}}</code> (required)
: Set this to <code>always</code> if the template ''should always'' be substituted, <code>no</code> if the template ''should not'' be substituted, or <code>both</code> if the template can be either substituted or transcluded.
: Set this to <code>always</code> if the template ''should always'' be substituted, <code>no</code> if the template ''should not'' be substituted, or <code>both</code> if the template can be either substituted or transcluded.
=== Usage ===
<pre>{{substitute|always}}</pre>
{{{{ROOTPAGENAMEE}}|always}}
<pre>{{substitute|no}}</pre>
{{{{ROOTPAGENAMEE}}|no}}
<pre>{{substitute|both}}</pre>
{{{{ROOTPAGENAMEE}}|both}}