Template:Issubst/doc

This is a documentation subpage for Template:Issubst.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on many 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.

Usage

Meta template that returns "yes" if evaluated during substitution, and the empty string if evaluated during transclusion.
Note that this template must be used in safesubst mode to work properly:

{{ safesubst:<noinclude/>issubst}}

Examples

"{{issubst}}" → ""
"{{subst:issubst}}" → "yes"

Related templates

{{require subst}}: Prints an error unless substituted.
- {{subst check top}}, {{subst check bottom}}: Same purpose but used as a pair.
- {{subst only}}: For the doc of the above templates; prints a message asking for it be substituted.
- {{nosubst}}: The reverse of {{subst only}}. For the doc of templates which should not be substituted; prints a message asking for it not to be substituted.
- {{substitution}}: Allows free-fill description of whether the template should be substituted and under what conditions.
{{issubst}}: Returns "yes" if substituted.
{{ifsubst}}: Forks if substituted or not.