View source for Module:Params/testcases

[[File:Gelemental.svg|thumb|Here are some tools for testing {{ml|params|}} and [[Module:Params/sandbox|its sandbox version]].]]

This is the [[Wikipedia:Template sandbox and test cases|testcases]] page for checking the behaviour of [[Module:Params]].

As the module provides most of its functionalities only when called by templates, this page uses helper subtemplates to do its tests. You can find a complete list of these [[Special:PrefixIndex/Module:Params/testcases/|here]]. Several helper subtemplates come in two versions, one that depends on {{ml|params|}} and one that depends on {{ml|params/sandbox|}}. Example templates, used by the documentation page, are available at [[Module:Params/doc/examples|/doc/examples]].

== General tests ==

=== Multi-purpose helper subtemplates ===

==== Helper subtemplate {{[[Module:Params/testcases/tmulti|./tmulti]]}} ====
The {{[[Module:Params/testcases/tmulti|./tmulti]]}} subtemplate allows to simulate in one single call both the incoming parameters and the parameters manually concatenated to <code>{{ml|params|...|''function''|...}}</code>, using a single hyphen (<code>-</code>) as a delimiter between the two groups. This allows to make general experiments directly from the preview window without having to edit separate templates.

For instance, writing

<syntaxhighlight lang="wikitext">{{module:params/testcases/tmulti|
	setting|i/p|<br />|: |list|
	-|hello|world|foo=bar}}</syntaxhighlight>

will simulate a call with {{para|1|hello}}, {{para|2|world}}, and {{para|foo|bar}} to a template whose content is <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|i/p|<br />|: |list}}</syntaxhighlight>, thus producing:

{{module:params/testcases/tmulti|
	setting|i/p|<br />|: |list|
	-|hello|world|foo=bar}}

{{A note}} An identical subtemplate that uses [[Module:Params/sandbox]] instead of [[Module:Params]] is available at  {{[[Module:Params/testcases/tmulti sandbox|./tmulti sandbox]]}}.

=== Single-purpose helper subtemplates ===

==== Helper subtemplate {{[[Module:Params/testcases/tdelimiters|./tdelimiters]]}} ====
The {{[[Module:Params/testcases/tdelimiters|./tdelimiters]]}} subtemplate allows to test the behaviour of delimiter strings between the arguments it was called with, invoking several functions of the module at once. For instance,

<syntaxhighlight lang="wikitext">{{module:params/testcases/tdelimiters|foo|bar|Jupiter|hello=world}}</syntaxhighlight>

generates

{{module:params/testcases/tdelimiters|foo|bar|Jupiter|hello=world}}

{{A note}} An identical subtemplate that uses [[Module:Params/sandbox]] instead of [[Module:Params]] is available at  {{[[Module:Params/testcases/tdelimiters sandbox|./tdelimiters sandbox]]}}.

==== Helper subtemplate {{[[Module:Params/testcases/tnumerical|./tnumerical]]}} ====
The {{[[Module:Params/testcases/tnumerical|./tnumerical]]}} subtemplate allows to test the behaviour of functions that focus on numerical and sequential arguments. As  these require at most two arguments, the template uses the {{para|&#35;first}} and {{para|&#35;second}} special parameters to do its tests. For instance,

<syntaxhighlight lang="wikitext">{{module:params/testcases/tnumerical
	| #first = 2
	| #second = 2
	| -2 = minus two
	| 0 = zero
	| 1 = one
	| 2 = two
	| 3 = three
	| 19 = nineteen
	| 20 = twenty
}}</syntaxhighlight>

generates

{{module:params/testcases/tnumerical
	| #first = 2
	| #second = 2
	| -2 = minus two
	| 0 = zero
	| 1 = one
	| 2 = two
	| 3 = three
	| 19 = nineteen
	| 20 = twenty
}}

{{A note}} An identical subtemplate that uses [[Module:Params/sandbox]] instead of [[Module:Params]] is available at  {{[[Module:Params/testcases/tnumerical sandbox|./tnumerical sandbox]]}}.

==== Helper subtemplate {{[[Module:Params/testcases/tmaps|./tmaps]]}} ====
The {{[[Module:Params/testcases/tmaps|./tmaps]]}} subtemplate allows to test the behaviour of all the <code>mapping_*</code> and <code>renaming_*</code> class of modifiers. As the template generates a very large page its expansion is not shown here. For more information please visit its documentation page.

{{A note}} An identical subtemplate that uses [[Module:Params/sandbox]] instead of [[Module:Params]] is available at  {{[[Module:Params/testcases/tmaps sandbox|./tmaps sandbox]]}}.

==== Helper subtemplate {{[[Module:Params/testcases/tcompare separated entries|./tcompare separated entries]]}} ====
The {{[[Module:Params/testcases/tcompare separated entries|./tcompare separated entries]]}} subtemplate compares the behaviours of [[Module:Params]] with that of [[Module:Separated entries]]. For instance,

<syntaxhighlight lang="wikitext">{{ module:params/testcases/tcompare separated entries | one | two | three | foo  | bar | Jupiter | hello = world }}</syntaxhighlight>

generates

{{ module:params/testcases/tcompare separated entries | one | two | three | foo  | bar | Jupiter | hello = world }}

== Testing individual functions ==

=== Testing the <code>[[Module:Params#list|list]]</code> function ===

==== Helper subtemplate {{[[Module:Params/testcases/techo|./techo]]}} ====
The {{[[Module:Params/testcases/techo|./techo]]}} subtemplate calls the {{mfl|params|list}} function to echo the code it was called with.

Example:

{{Automarkup|{{Make code|<<module:params/testcases/techo!hello!world!foo{{=}}bar>>}}}}

== Dummies ==
* Dummy submodules
** {{mfl|params/testcases/mdummy|echo sb}}
* Dummy subtemplates
** {{[[module:params/testcases/tdummy echo sb]]}}

== See also ==
* [[Module:Params/ChangeLog|ChangeLog of Module:Params]]
* {{rel|Module:Params/doc/examples}}
* <span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special:Search&search=insource%3A%2Finvoke%3Aparams%2F&limit=500&offset=0&ns0=1&ns1=1&ns2=1&ns3=1&ns4=1&ns5=1&ns6=1&ns7=1&ns8=1&ns9=1&ns10=1&ns11=1&ns12=1&ns13=1&ns14=1&ns15=1&ns100=1&ns101=1&ns118=1&ns119=1&ns710=1&ns711=1&ns829=1&sort=last_edit_desc Extensive “in source” search]</span>.

<noinclude>
[[Category:Module documents]]
[[Category:Module sand&test documents]]
</noinclude>