Difference between revisions of "Template:Issubst/doc"

From blackwiki
Jump to navigation Jump to search
imported>PanchoS
(refine categorization; rm redundant interwikilinks)
imported>Pppery
(Fix heading level and remove merged templates)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
  
=== Usage ===
+
== Usage ===
 
Meta template that returns "yes" if evaluated during substitution, and the empty string if evaluated during transclusion.<br />Note that this template must be used in [[meta:Help:Safesubst|safesubst]] mode to work properly:
 
Meta template that returns "yes" if evaluated during substitution, and the empty string if evaluated during transclusion.<br />Note that this template must be used in [[meta:Help:Safesubst|safesubst]] mode to work properly:
  
 
:<code><nowiki>{{ {{{|safesubst:}}}issubst}}</nowiki></code>
 
:<code><nowiki>{{ {{{|safesubst:}}}issubst}}</nowiki></code>
  
=== Examples ===
+
== Examples ==
 
*"<code><nowiki>{{issubst}}</nowiki></code>" → "{{issubst}}"
 
*"<code><nowiki>{{issubst}}</nowiki></code>" → "{{issubst}}"
 
*"<code><nowiki>{{subst:issubst}}</nowiki></code>" → "yes"
 
*"<code><nowiki>{{subst:issubst}}</nowiki></code>" → "yes"
  
=== See also ===
+
{{List of subst helper templates}}
 
 
* [[Template:Ifsubst|Ifsubst]]
 
* [[Template:Require subst|Require subst]]
 
* [[Template:Substchecktop|Substchecktop]]
 
* [[Template:Substcheckbottom|Substcheckbottom]]
 
  
 
<includeonly>
 
<includeonly>
 
[[Category:Boolean, register, and condition testing templates|{{PAGENAME}}]]
 
[[Category:Boolean, register, and condition testing templates|{{PAGENAME}}]]
 
</includeonly>
 
</includeonly>

Revision as of 20:54, 13 September 2016

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:}}}issubst}}

Examples

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

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.
    • {{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.
  • Module:Unsubst: Prevents substitution.
  • Module:Unsubst-infobox: Prevents substitution for infoboxes, cleans up parameters.