Module:Unsubst/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
m
20 revisions imported
No edit summary |
m (20 revisions imported) |
||
| (22 intermediate revisions by 16 users not shown) | |||
Line 1:
<!-- Categories where indicated at the bottom of this page, please. -->
{{High-risk| 3841439 |all-pages = yes}}
{{Module rating|protected}}
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.
Infoboxes should use [[Module:Unsubst-infobox]], as should any other templates with parameters listed in block format by default.
=== Usage ===
Line 11 ⟶ 13:
To turn a template into a self-substituting template, wrap the existing template code with:
<pre>
{{
[ ... existing template code ... ]
Line 18 ⟶ 20:
</pre>
The wikitext to display when not substed must be given as "$B".
Some templates have a
==== Advanced ====
<pre>
{{SAFESUBST:<noinclude />#invoke:Unsubst||$params=[ parameters ]|$aliases=[ aliases ]|$flags=[ flags ]|$B=
[ ... existing template code ... ]
}}
</pre>
Due to Lua limitations, parameters are normally ordered randomly when the template is substituted. {{para|$params}} can be used in #invoke:Unsubst to list template parameters in order, comma-separated (e.g. <code>egg,bacon,sausage,cheese,spam</code>). Numbered parameters should be before others in the list. Any remaining parameters are tacked onto the end of the generated invocation.
Parameter aliases can be listed in {{para|$aliases}} (and shouldn't be listed in {{para|$params}}), and will be replaced automatically. Each alias and its replacement should be formatted as <code>alias>replacement</code>, and each of those pairs should be comma-separated (e.g. <code>œuf>egg,melt>cheese</code>). Note that this parameter can function with or without {{para|$params}}.
Parameter {{para|$flags}} can be used to modify other facets of the module's behaviour; entries are comma-separated. Valid flags are <code>override</code> (allows parameters in the #invoke: to take precedence over parameters in the original template invocation); <code>keep-whitespace</code> (prevents whitespace from being trimmed from unnamed parameters); and <code>remove-empty</code> (removes empty parameters).
These parameters can be manipulated using parser functions to provide more complicated options (note that in the parameters any parser function, or template or module invocation, should also have <code><nowiki>SAFESUBST:<noinclude /></nowiki></code>).
Parameter {{para|$template-name}} will override the subst'd templates name with the template name assigned to this parameter.
▲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>
{{
[ ... Template code goes here ... ]
Line 37 ⟶ 57:
! Original !! Result
|-
|
|-
|
|-
|
|-
|
|}
<includeonly>{{
| <!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia metatemplates]]
| |||
