Template:Always substitute/sandbox
Jump to navigation
Jump to search
 | This template should always be substituted – use {{subst:Always substitute}}. |
 | This is the template sandbox page for Template:Always substitute (diff). See also the companion subpage for test cases. |
 | This template uses Lua: |
| This template should not be substituted. |
 | This template is used on approximately 9,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{Always substitute}} produces the following notice:
This template should always be substituted – use {{subst:foo}}.
(but {{Always substitute}} itself should not be substituted.)
Usage
[edit source]{{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
[edit source]|auto=- If set as "yes", the template to which the notice refers will be subst:ed automatically unless the
|demo=yesparameter 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.
List of subst helper templates
[edit source]- {{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.