Module:Unsubst/doc - Revision history

Casiope at 16:35, 21 July 2020

2020-07-21T16:35:50Z

← Older revision		Revision as of 16:35, 21 July 2020
Line 26:		Line 26:
	</pre>		</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.		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 on 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 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).		Parameter {{para\|$flags}} can be used to modify other facets of the module’s behaviour; entries are comma‐separated. Valid flags are {{code\|override}} (allows parameters in the #invoke: to take precedence over parameters in the original template invocation); {{code\|keep-whitespace}} (prevents whitespace from being trimmed from unnamed parameters); and {{code\|remove-empty}} (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>).		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>).
Line 49:		Line 49:
	! Result		! Result
	\|-		\|-
	\| {{~~tlc~~\|subst\|example}}		\| {{tlg\|code=yes\|nolink=yes\|subst\|example}}
	\| {{~~tlc~~\|Example\|foo=bar\|date{{=}}{{#time:F Y}}}}		\| {{tlg\|code=yes\|nolink=yes\|Example\|foo{{=}}bar\|date{{=}}{{#time:F Y}}}}
	\|-		\|-
	\| {{~~tlc~~\|subst\|example\|foo=X}}		\| {{tlg\|code=yes\|nolink=yes\|subst\|example\|foo{{=}}X}}
	\| {{~~tlc~~\|Example\|foo{{=}}X\|date{{=}}{{#time:F Y}}}}		\| {{tlg\|code=yes\|nolink=yes\|Example\|foo{{=}}X\|date{{=}}{{#time:F Y}}}}
	\|-		\|-
	\| {{~~tlc~~\|subst\|example\|baz=X}}		\| {{tlg\|code=yes\|nolink=yes\|subst\|example\|baz{{=}}X}}
	\| {{~~tlc~~\|Example\|foo=bar\|baz{{=}}X\|date{{=}}{{#time:F Y}}}}		\| {{tlg\|code=yes\|nolink=yes\|Example\|foo=bar\|baz{{=}}X\|date{{=}}{{#time:F Y}}}}
	\|-		\|-
	\| {{~~tlc~~\|subst\|example\|date=January 2001}}		\| {{tlg\|code=yes\|nolink=yes\|subst\|example\|date{{=}}January 2001}}
	\| {{~~tlc~~\|Example\|foo{{=}}bar\|date{{=}}January 2001}}		\| {{tlg\|code=yes\|nolink=yes\|Example\|foo{{=}}bar\|date{{=}}January 2001}}
	\|}		\|}

	[[Category:Modules]][[Category:Modules documentation]]		[[Category:Modules]][[Category:Modules documentation]]

Casiope: /* Example */

2020-07-20T17:15:45Z

Example

← Older revision		Revision as of 17:15, 20 July 2020
Line 49:		Line 49:
	! Result		! Result
	\|-		\|-
	\| ~~<code><nowiki>~~{{subst\|example}}~~</nowiki></code>~~		\| {{tlc\|subst\|example}}
	\| {{tlc\|Example\|foo=bar\|date{{=}}{{#time:F Y}}}}		\| {{tlc\|Example\|foo=bar\|date{{=}}{{#time:F Y}}}}
	\|-		\|-
	\| ~~<code><nowiki>~~{{subst\|example\|foo=X}}~~</nowiki></code>~~		\| {{tlc\|subst\|example\|foo=X}}
	\| {{tlc\|Example\|foo{{=}}X\|date{{=}}{{#time:F Y}}}}		\| {{tlc\|Example\|foo{{=}}X\|date{{=}}{{#time:F Y}}}}
	\|-		\|-
	\| ~~<code><nowiki>~~{{subst\|example\|baz=X}}~~</nowiki></code>~~		\| {{tlc\|subst\|example\|baz=X}}
	\| {{tlc\|Example\|foo=bar\|baz{{=}}X\|date{{=}}{{#time:F Y}}}}		\| {{tlc\|Example\|foo=bar\|baz{{=}}X\|date{{=}}{{#time:F Y}}}}
	\|-		\|-
	\| ~~<code><nowiki>~~{{subst\|example\|date=January 2001}}~~</nowiki></code>~~		\| {{tlc\|subst\|example\|date=January 2001}}
	\| {{tlc\|Example\|foo{{=}}bar\|date{{=}}January 2001}}		\| {{tlc\|Example\|foo{{=}}bar\|date{{=}}January 2001}}
	\|}		\|}

	[[Category:Modules]][[Category:Modules documentation]]		[[Category:Modules]][[Category:Modules documentation]]

Casiope at 16:28, 11 July 2020

2020-07-11T16:28:38Z

← Older revision		Revision as of 16:28, 11 July 2020
Line 62:		Line 62:
	\|}		\|}

	[[Category:Modules]]		[[Category:Modules]][[Category:Modules documentation]]
	[[Category:Modules documentation]]

Casiope at 00:59, 11 July 2020

2020-07-11T00:59:01Z

← Older revision		Revision as of 00:59, 11 July 2020
Line 3:		Line 3:
	== Usage ==		== Usage ==

	To turn a template into a ~~self-substituting~~ template, wrap the existing template code with:		To turn a template into a self‐substituting template, wrap the existing template code with:
	<pre>		<pre>
	{{SAFESUBST:<noinclude />#invoke:Unsubst\|\|$B=		{{SAFESUBST:<noinclude />#invoke:Unsubst\|\|$B=
Line 28:		Line 28:
	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.		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 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).		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>).		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>).
Line 63:		Line 63:

	[[Category:Modules]]		[[Category:Modules]]
			[[Category:Modules documentation]]

Casiope at 15:07, 27 July 2019

2019-07-27T15:07:12Z

← Older revision		Revision as of 15:07, 27 July 2019
Line 1:		Line 1:
	Helper module to facilitate a substituted template transform into a template transclusion.		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 ==		== Usage ==

Casiope: Created page with "Helper module to facilitate a substituted template transform into a template transclusion. Maintenance templates, such as {{tl|Citation needed}} or {{tl|Refimprove}}, should..."

2019-07-03T12:40:39Z

Created page with "Helper module to facilitate a substituted template transform into a template transclusion. Maintenance templates, such as {{tl|Citation needed}} or {{tl|Refimprove}}, should..."

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:<noinclude />#invoke:Unsubst||$B=

[ ... existing template code ... ]

}}
</pre>

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 <code>__DATE__</code>, that value in the generated template invocation will be the current month and year.

Some templates have a {{tag|noinclude|o}} but no matching {{tag|noinclude|c}} at the end of the template. In such cases the missing {{tag|noinclude|c}} must be added before the ending <code><nowiki>}}</nowiki></code>.

=== 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>).

=== Example ===

Consider a template Template:Example containing the following code:
<pre>
{{SAFESUBST:<noinclude />#invoke:Unsubst||foo=bar |date=__DATE__ |$B=

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

}}
</pre>

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

[[Category:Modules]]