Jump to content

Template:May be substituted/doc: Difference between revisions

From BattleIntelligence
imported>Deadfire
Created page with "{{Documentation subpage}} {{tsh|May subst}} {{never substitute}} ==Usage== <code><nowiki>{{May be substituted}}</nowiki></code> This template should be placed on the <big>B..."
 
m Text replacement - "BattleTechWiki" to "BattleIntelligence"
 
Line 5: Line 5:
<code><nowiki>{{May be substituted}}</nowiki></code>
<code><nowiki>{{May be substituted}}</nowiki></code>


This template should be placed on the <big>[[BattleTechWiki:Template documentation|documentation]] [[BattleTechWiki:Subpage|subpage]]</big> (not the template page itself) of any template that may be substituted (but may also be [[BattleTechWiki:Transclusion|transcluded]]).
This template should be placed on the <big>[[BattleIntelligence:Template documentation|documentation]] [[BattleIntelligence:Subpage|subpage]]</big> (not the template page itself) of any template that may be substituted (but may also be [[BattleIntelligence:Transclusion|transcluded]]).


'''Parameters'''
'''Parameters'''

Latest revision as of 00:11, 1 May 2025

Usage

{{May be substituted}}

This template should be placed on the documentation subpage (not the template page itself) of any template that may be substituted (but may also be transcluded).

Parameters

  • This template accepts one optional parameter, which can be used to give a more detailed description of why the template in question should not be substituted. For example, {{May be substituted|Example text.}} produces:

List of subst helper templates

  • {{require substitution}} – Prints an error unless substituted.
    • {{always substitute}} – For the Template documentation 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.