Shawndouglas: Created as needed.

2016-08-18T20:11:07Z

Created as needed.

New page

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

Maintenance templates, such as {{tl|Citation needed}} or {{tl|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:
<pre>
{{ {{{|safesubst:}}}#invoke:Unsubst||$B=

[ ... existing template code ... ]

}}
</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 [[: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 <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 ===
Consider a template Template:Example containing the following code:
<pre>
{{ {{{|safesubst:}}}#invoke:Unsubst||foo=bar |date=__DATE__ |$B=

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

}}
</pre>

{| class="wikitable"
! Original !! Result
|-
| <nowiki>{{subst:example}}</nowiki> || <nowiki>{{Example|foo=bar|date=</nowiki>{{#time:F Y}}}}
|-
| <nowiki>{{subst:example|foo=X}}</nowiki> || <nowiki>{{Example|foo=X|date=</nowiki>{{#time:F Y}}}}
|-
| <nowiki>{{subst:example|baz=X}}</nowiki> || <nowiki>{{Example|foo=bar|baz=X|date=</nowiki>{{#time:F Y}}}}
|-
| <nowiki>{{subst:example|date=January 2001}}</nowiki> || <nowiki>{{Example|foo=bar|date=January 2001}}</nowiki>
|}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| 
[[Category:LIMSwiki metatemplates]]
[[Category:Modules that add a tracking category]]
}}</includeonly>

Module:Unsubst/doc - Revision history

Shawndouglas: Created as needed.