檢視模块:Unsubst/doc 的原始碼

<!-- Categories and interwikis go at the bottom of this 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||$N=TEMPLATENAME |$B=

 [ ... existing template code ... ]

}}
</pre>

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.

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||$N=Example |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:Y年n月}}}}
|-
| <nowiki>{{subst:example|foo=X}}</nowiki> || <nowiki>{{Example|foo=X|date=</nowiki>{{#time:Y年n月}}}}
|-
| <nowiki>{{subst:example|baz=X}}</nowiki> || <nowiki>{{Example|foo=bar|baz=X|date=</nowiki>{{#time:Y年n月}}}}
|-
| <nowiki>{{subst:example|date=January 2001}}</nowiki> || <nowiki>{{Example|foo=bar|date=January 2001}}</nowiki>
|}


<includeonly>
<!-- Categories and interwikis go here: -->
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]

</includeonly>