Template:Ifsubst/doc

From Black Cat Studios
< Template:Ifsubst
Revision as of 16:14, 19 June 2023 by Blackcat (talk | contribs) (Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE, and INTERWIKIS IN WIKIDATA --> {{high-risk}} == Usage == Meta template that returns the first parameter if evaluated during substitution, and the second parameter if evaluated during transclusion.<br />Note that this template must be used in safesubst mode to work properly: : <code><nowiki>{{ safesubst:<noinclude/>ifsubst| yes | no }}</nowi...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Usage

Meta template that returns the first parameter if evaluated during substitution, and the second parameter if evaluated during transclusion.
Note that this template must be used in safesubst mode to work properly:

{{ safesubst:<noinclude/>ifsubst| yes | no }}

The |demo= parameter can be used for testing the template. Set |demo=yes to always display the yes text, |demo=no to always display the no text, or |demo={{{demo|}}} to pass through the value from the parent template.

List of subst helper templates

  • {{require substitution}} – Prints an error unless substituted.
    • {{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.
  • Module:Unsubst – Prevents substitution.
  • Module:Unsubst-infobox – Prevents substitution for infoboxes, cleans up parameters.