Module:Unsubst/doc
This is the documentation page for Module:Unsubst
This Lua module is used on 5,050,000+ pages, or roughly 3257% of all pages. To avoid major disruption and server load, any changes should be tested in the You may want to test changes and make sure they are approved by site staff before submitting them.The tested changes can be added to this page in a single edit. Consider discussing changes on the talk 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||$B= [ ... existing template code ... ] }}
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 Category:Calls to Module:Unsubst that use $N (0).
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=October 2024}} |
{{subst:example|foo=X}} | {{Example|foo=X|date=October 2024}} |
{{subst:example|baz=X}} | {{Example|foo=bar|baz=X|date=October 2024}} |
{{subst:example|date=January 2001}} | {{Example|foo=bar|date=January 2001}} |