Module:Unsubst/doc
![]() | This is a documentation subpage for Module:Unsubst. It may contain usage information, categories and other content that is not part of the original module page. |
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||$N=TEMPLATENAME |$B= [ ... existing template code ... ] }}
The name of the template must be given as "$N", and 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.
Example
Consider a template Template:Example containing the following code:
{{ {{{|safesubst:}}}#invoke:Unsubst||$N=Example |foo=bar |date=__DATE__ |$B= [ ... Template code goes here ... ] }}
Original | Result |
---|---|
{{subst:example}} | {{Example|foo=bar|date=September 2024}} |
{{subst:example|foo=X}} | {{Example|foo=X|date=September 2024}} |
{{subst:example|baz=X}} | {{Example|foo=bar|baz=X|date=September 2024}} |
{{subst:example|date=January 2001}} | {{Example|foo=bar|date=January 2001}} |