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]].]]
{{module:params/doc/main sidebox}}

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]].

{{module:params/doc/sandboxes
	| Module:Params/testcases/sandbox
	| Module:Params/testcases/sandbox2
	| Module:Params/testcases/sandbox3
	| Module:Params/testcases/sandbox4
	| Module:Params/testcases/sandbox5
}}

== General tests ==

=== 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 }}

=== Helper subtemplate {{[[Module:Params/testcases/tcoins|./tcoins]]}} ===
The {{[[Module:Params/testcases/tcoins|./tcoins]]}} subtemplate allows to experiment with the <code>[[Module:Params#coins|coins]]</code> and <code>[[Module:Params#unique_coins|unique_coins]]</code> functions, which are called with the following arguments: <syntaxhighlight lang="wikitext" inline>one|two|three|foo=bar|hello=world</syntaxhighlight>. Therefore, transcluding the template with,

<syntaxhighlight lang="wikitext">{{Module:Params/testcases/tcoins|foo|hello|2|3|foo}}</syntaxhighlight>

generates

{{module:params/testcases/tcoins|foo|hello|2|3|foo}}

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

== Testing individual functions ==

=== 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]]}}

== Deprecated tools ==
The following tools were developed with older versions of [[Module:Params]] in mind, and were later superseded by new functionalities in the module. They are kept here for historical reasons.

* {{[[Module:Params/testcases/tmulti|./tmulti]]}} and {{[[Module:Params/testcases/tmulti sandbox|./tmulti sandbox]]}}

== See also ==
* [[Module:Params/ChangeLog|ChangeLog of Module:Params]]
* {{rel|Module:Params/doc/examples}}
* {{Internal link with parameters | Special:Search | Extensive “in source” search
	| search = insource:/invoke:params/i
	| 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
}}
** {{sl|all: contentmodel:wikitext hastemplate:module:params insource:/\#[Ii][Nn][Vv][Oo][Kk][Ee] *: *[Pp]arams *\{{!}}/|Alternative search including in the <code>Module:</code> namespace|limit=500}}

[[Category:Module test cases]]