Modul:Unsubst/dok

Forklaring om brug af dette modul kommer fra den engelske Wikipedia og er ikke oversat til dansk endnu. Der er tale om et hjælpemodul, som bl.a. bruges af matematiske skabeloner.

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.

Brug

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.

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