View source for Template:Always substitute/doc

{{doc sub}}
<!--- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --->
{{lua|Module:Unsubst}}
{{Always substitute|yesnomaybe=never}}
{{tsh|subst only|substed|substitute|substituted|substonly|clear=right}}
{{high-use}}
{{tlf|Always substitute|code=on}} produces the following notice:
{{quote|{{Subst only|actualtemplate={{tlg|foo|subst=on}}|nocat=true}}}}
(but the {{tlf|Always substitute}} template itself should {{em|{{strong|never}}}} be [[Help:Substitution|substituted]].)

== Usage ==
<code><nowiki>{{Always substitute}}</nowiki></code>

{{tlf|Always substitute}} should be placed on the {{strong|[[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpage|subpage]]}} of any template that requires [[Help:Substitution|substitution]] rather than [[Wikipedia:Transclusion|transclusion]] ''(not on the template's own page itself)''.

== Parameters ==
All of the parameters for this template are ''optional''. If ''none'' of the parameters are used when transclusing this template onto the documentation subpage of a template, it will default to displaying a notice stating that the template "should ''always'' be substituted", and include a statement with the template syntax that the reader should ''always'' use in order to substitute it onto a page. No additional statements are amended to the notice, and automatic categorization of the template that this notice refers to is allowed.

;{{para|yesnomaybe}}
: Can be set to <code>never</code>, <code>not</code>, <code>can</code>, <code>may</code>, or <code>always</code>.
:* Setting it to <code>never</code> or <code>not</code> will display a notice stating that the template "should ''never'' be substituted" or "should ''not'' be substituted", respectively – and display the template syntax that the reader should ''always'' use in order to transclude it onto a page.
:* Setting it to <code>can</code> or <code>may</code> will display a notice stating that the template "''can'' be substituted" or "''may'' be substituted", respectively – and display the template syntax that the reader can use in order to substitute it onto a page if they so choose.
:* Setting it to <code>always</code> will display a notice stating that the template "should ''always'' be substituted" – and display the template syntax that the reader should ''always'' use in order to substitute it onto a page.

: ''If this parameter is not used, or if it is set to anything not listed above, the template defaults to using <code>always</code>.''
;{{para|auto|yes}}
: Set this parameter to <code>yes</code> if a Wikipedia [[WP:BOT|bot]] automatically searches for accidental transclusions of the template this notice refers to and fixes them to be substitutions, unless the {{para|demo|yes}} parameter is set.
:* When set to <code>yes</code>, the notice will include a statement with this information to the reader, as well as place the template that the notice refers to in {{cl|Wikipedia templates to be automatically substituted}}; see [[User:AnomieBOT/docs/TemplateSubster]] for more information.
:* This parameter is ''ignored'' by the template if {{para|yesnomaybe}} is set to an option other than <code>always</code>, since this would cause the template to show conflicting information to the reader that makes no sense.

: ''If this parameter is not used, or if it is set to anything other than <code>yes</code>,<ref name=autoref>This template uses {{tl|yesno-no}} to sanitize and parse the input so that the result is either <code>yes</code> or <code>no</code>. As a result, setting this parameter to any input that is construed to be affirmative will also return <code>yes</code>. See [[Template:Yesno/doc|template documentation]] for more information.</ref> the template defaults to using <code>no</code>.''
;{{para|alt}}
: Set this parameter to the page title or location of an alternate template that the reader should use for transclusion instead of the template that the notice refers to (e.g. {{para|alt|Template:Example}} or {{para|alt|Example}}).
:* Enter the page title or location using ''plain text'', and do not include quotations, square brackets, or braces.
:* When set to a page title or location, the notice will include a statement instructing the reader to use the alternate template for transclusions, and provide the appropriate template syntax for the reader to use.
:* If the location includes "Template:" or "TM:" at the beginning of the text, it is automatically dropped from being displayed in the template syntax.
:* This parameter is ''ignored'' by the template if {{para|yesnomaybe}} is set to an option other than <code>always</code>, since this would cause the template to show conflicting information to the reader that makes no sense.

: ''If this parameter is not used, or if it is set to no value or to only [[whitespace character]]s, the template will default to not displaying the additional information to the reader.''
; {{para|nocat|true}}
: Set this parameter to <code>true</code> in order to [[Wikipedia:Category suppression|suppress automatic categorization]] of the template that it applies to.

: ''If this parameter is not used, or if it is set to anything other than <code>yes</code>,<ref name=autoref /> the template defaults to allowing automatic categorization.''

== Categorization ==
Pages that include {{tlf|Always substitute}} are added to [[:Category:Wikipedia substituted templates]].

Templates that subst a template name string onto the target page in [[WP:HIDDEN|hidden text]] are added to [[:Category:Templates with matching hidden id]] ''if and '''only if''''' the hidden template name string matches the name of the template. For example: [[Template:Uw-coi]] contains the token <code><nowiki><!-- Template:Uw-coi --></nowiki></code>, and since the token matches the Template name, Template:Uw-coi is a member of the category.

{{List of subst helper templates}}

<includeonly>{{sandbox other||
<!--- CATEGORIES HERE, PLEASE: --->
{{DEFAULTSORT:Substitute, Always}}
[[Category:Documentation header templates]]

}}</includeonly>

== Notes ==
{{reflist}}