Difference between revisions of "Module:Unsubst/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Adem20
blackwiki>Jc86035
m (→‎Usage: rm $N)
Line 19: Line 19:
 
</pre>
 
</pre>
  
The wikitext to display when not substed must be given as "$B". A parameter "$N" may also be seen in some templates; this was required in an older version of the module, but is no longer necessary and may be removed. Such templates are automatically placed in {{clc|Calls to Module:Unsubst that use $N}}.
+
The wikitext to display when not substed must be given as "$B". All other parameters passed to the #invoke will be copied to the generated template invocation as default values. If the value of any of these default parameters is "__DATE__", that value in the generated template invocation will be the current month and year.
  
All other parameters passed to the #invoke will be copied to the generated template invocation as default values. If the value of any of these default parameters is "__DATE__", that value in the generated template invocation will be the current month and year.
+
Some templates have a &lt;noinclude&gt; but no matching &lt;/noinclude&gt; at the end of the template. In such cases the missing &lt;/noinclude&gt; must be added before the ending <code>{{))}}</code>.
 
 
Some templates have a <nowiki><noinclude></nowiki> but no matching <nowiki></noinclude></nowiki> at the end of the template. In such cases the missing <nowiki></noinclude></nowiki> must be added before the ending <code><nowiki>}}</nowiki></code>.
 
  
 
=== Example ===
 
=== Example ===

Revision as of 11:38, 6 June 2017


  1. REDIRECT Template:High-use

Helper module to facilitate a substituted template transform into a template transclusion.

Maintenance templates, such as {{Citation needed}} or {{Refimprove}}, should never be substituted. A trick to avoid that is to make a template substitute to its transcluded form.

Usage

To turn a template into a self-substituting template, wrap the existing template code with:

{{ {{{|safesubst:}}}#invoke:Unsubst||$B=

 [ ... existing template code ... ]

}}

The wikitext to display when not substed must be given as "$B". All other parameters passed to the #invoke will be copied to the generated template invocation as default values. If the value of any of these default parameters is "__DATE__", that value in the generated template invocation will be the current month and year.

Some templates have a <noinclude> but no matching </noinclude> at the end of the template. In such cases the missing </noinclude> must be added before the ending }}.

Example

Consider a template Template:Example containing the following code:

{{ {{{|safesubst:}}}#invoke:Unsubst||foo=bar |date=__DATE__ |$B=

 [ ... Template code goes here ... ]

}}
Original Result
{{subst:example}} {{Example|foo=bar|date=January 2026}}
{{subst:example|foo=X}} {{Example|foo=X|date=January 2026}}
{{subst:example|baz=X}} {{Example|foo=bar|baz=X|date=January 2026}}
{{subst:example|date=January 2001}} {{Example|foo=bar|date=January 2001}}