Difference between revisions of "Module:Unsubst/doc"
blackwiki>Anomie (Remove now-unused $N from doc, except for a mention that it is no longer needed and may be removed from templates.) |
blackwiki>Sardanaphalus (sandbox non-categorization) |
||
| Line 1: | Line 1: | ||
| − | <!-- Categories | + | <!-- Categories where indicated at the bottom of this page, please. --> |
Helper module to facilitate a substituted template transform into a template transclusion. | Helper module to facilitate a substituted template transform into a template transclusion. | ||
| Line 44: | Line 44: | ||
|} | |} | ||
| − | + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
| − | <includeonly> | + | | <!-- Categories below this line, please; interwikis at Wikidata --> |
| − | <!-- Categories | + | [[Category:Wikipedia metatemplates]] |
| − | [[Category:Wikipedia metatemplates | + | }}</includeonly> |
| − | |||
| − | </includeonly> | ||
Revision as of 21:50, 16 December 2014
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.
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=January 2026}} |
| {{subst:example|foo=X}} | {{Example|foo=X|date=January 2026}} |
| {{subst:example|baz=X}} | {{Example|foo=bar|baz=X|date=January 2026}} |
| {{subst:example|date=January 2001}} | {{Example|foo=bar|date=January 2001}} |