Template:Substitute/doc: Difference between revisions

(13 intermediate revisions by the same user not shown)

Line 1:

{{dochead}}{{wikipedia|Template:Always substitute|Template:Never substitute|Template:May be substituted}}

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

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 ===

{{~~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 ''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}} }}

~~Pages~~ that ~~include~~ <~~code~~>{{~~<nowiki />~~substitute|always}}</~~code~~> ~~are added to [[:Category:Substituted templates]].~~

==== Templates that ''must'' be substituted ====

Equivalent to Wikipedia's {{w|Template:Always substitute}}.

<pre>{{substitute|always}}</pre>

{{{{ROOTPAGENAMEE}}|always}}

==== ~~Parameters~~ ====

==== Templates that ''must not'' be substituted ====

; <~~code~~>{{~~{<nowiki />1}~~}}</~~code~~> ~~(required)~~

Equivalent to Wikipedia's {{w|Template:Never substitute}}.

~~: 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>maybe</code> if the template can be either substituted or transcluded.~~

<pre>{{substitute|no}}</pre>

{{{{ROOTPAGENAMEE}}|no}}

@@ Line 1: / Line 1: @@
-{{dochead}}
+{{dochead}}{{wikipedia|Template:Always substitute|Template:Never substitute|Template:May be substituted}}
-This template is used as a header to show whether a template should be substituted or not.
+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 ===
-{{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 ''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}} }}
-Pages that include <code>{{<nowiki />substitute|always}}</code> are added to [[:Category:Substituted templates]].
+==== Templates that ''must'' be substituted ====
+Equivalent to Wikipedia's {{w|Template:Always substitute}}.
+<pre>{{substitute|always}}</pre>
+{{{{ROOTPAGENAMEE}}|always}}
-==== Parameters ====
+==== Templates that ''must not'' be substituted ====
-; <code>{{{<nowiki />1}}}</code> (required)
+Equivalent to Wikipedia's {{w|Template:Never substitute}}.
-: 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>maybe</code> if the template can be either substituted or transcluded.
+<pre>{{substitute|no}}</pre>
+{{{{ROOTPAGENAMEE}}|no}}