Template:Always substitute/doc

This is a documentation subpage for Template:Always substitute.
It contains usage information, categories and other content that is not part of the original Template page.

This template should not be substituted.

This template is used on many pages.

To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit.

Please consider discussing any changes on the talk page before implementing them.

{{Always substitute}} produces the following notice:

This template should always be substituted (i.e., use {{subst:foo}}).

(but {{Always substitute}} itself should not be substituted.)

Usage

{{Always substitute}}

{{Always 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).

Pages that include {{Always substitute}} are added to Category:Wikipedia substituted templates.

Parameters

|auto=: If set as "yes", the template to which the notice refers will be subst:ed automatically unless the |demo=yes parameter is set. The notice is amended to state this. Default is "no". Setting this parameter to "yes" places the template in Category:Wikipedia templates to be automatically substituted; see User:AnomieBOT/docs/TemplateSubster for more information.
|alt=: Use to set an alternate and transcludable name for the template.
|nocat=true: Suppress automatic categorization.

Redirects

{{Substed }}
{{Substitute }}
{{Substituted }}
{{Substonly }}
{{Subst only }}

List of subst helper templates

{{Require substitution }} – Prints an error unless substituted.
{{Substituted or transcluded }} – if-then-else metatemplate that checks if a template is currently being substituted or transcluded
- {{Always substitute }} – For the doc of the above templates; prints a message asking for it be substituted.
- {{Never substitute }} – The reverse of {{always substitute}}. For the doc of templates which should not be substituted; prints a message asking for it not to be substituted.
- {{May be substituted }} – For the doc of templates whose substitution is optional.
- {{Substitution }} – Allows free-fill description of whether the template should be substituted and under what conditions.
{{Ifsubst }} – Forks if substituted or not.
{{Issubst }} – Returns "yes" if substituted.
{{HTML comment }} – To sign substitutions with comments that contain wikitext expansions
Module:Unsubst – Prevents substitution.
Module:Unsubst-infobox – Prevents substitution for infoboxes, cleans up parameters.