Misplaced Pages

Module:Unsubst/doc

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.
< Module:Unsubst

This is an old revision of this page, as edited by Anomie (talk | contribs) at 03:30, 1 November 2013 (Doc page for new module). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Revision as of 03:30, 1 November 2013 by Anomie (talk | contribs) (Doc page for new module)(diff) ← Previous revision | Latest revision (diff) | Newer revision → (diff)
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=
}}

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=
}}
Original Result
{{subst:example}} {{Example|foo=bar|date=January 2025}}
{{subst:example|foo=X}} {{Example|foo=X|date=January 2025}}
{{subst:example|baz=X}} {{Example|foo=bar|baz=X|date=January 2025}}
{{subst:example|date=January 2001}} {{Example|foo=bar|date=January 2001}}