Module:Params/testcases: Difference between revisions

Revision as of 01:22, 12 May 2024

Latest revision as of 13:34, 15 July 2025

(22 intermediate revisions by 2 users not shown)

Line 1:

This is the [[WikipediaFile:TemplateGelemental.svg|thumb|Here sandboxare andsome test cases|testcases]] pagetools for testing the{{ml|params|}} behaviour ofand [[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]]. Example templates, used by the documentation page, are available at [[Module:Params/doc/examples|/doc/examples]].

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

==== Helper subtemplate {{[[Module:Params/testcases/tdelimiters|./tdelimiters]]}} ====

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

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

Line 33 ⟶ 16:

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

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

The {{[[Module:Params/testcases/tnumerical|./tnumerical]]}} subtemplate allows to test the behaviour of functions that focus on the 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,

=== Helper subtemplate {{[[Module:Params/testcases/tnumerical|./tnumerical]]}} ===

The {{[[Module:Params/testcases/tnumerical|./tnumerical]]}} subtemplate allows to test the behaviour of functions that focus on the 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

Line 62 ⟶ 47:

}}

===={{A note}} An Helperidentical subtemplate that uses [[Module:Params/sandbox]] instead of [[Module:Params]] is available at {{[[Module:Params/testcases/tcomparetnumerical separated entriessandbox|./tcomparetnumerical separated entriessandbox]]}} ====.

==== Helper subtemplate {{[[Module:Params/testcases/tmultitmaps|./tmultitmaps]]}} ====

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,

Line 71 ⟶ 63:

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

=== Helper subtemplate {{[[Module:Params/testcases/tcoins|./tcoins]]}} ===

=== Miscellaneous helper subtemplates ===

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==== Helper subtemplate "wikitext">{{[[Module:Params/testcases/tprint1tcoins|./tprint1]]foo|hello|2|3|foo}} ====</syntaxhighlight>

The {{[[Module:Params/testcases/tprint1|./tprint1]]}} subtemplate only echoes the first unnamed parameter passed and discards the others (i.e. simply {{param|1|}}).

generates

== Testing single functions ==

{{module:params/testcases/tmultitcoins|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 singleindividual 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.

Line 89 ⟶ 85:

== Dummies ==

* Dummy submodules

** {{mlmfl|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|/doc/examples]]}}

* {{sl|all: contentmodel:wikitext hastemplate:module:params insource:/\#[Ii][Nn][Vv][Oo][Kk][Ee] *: *[Pp]arams *\{{!}}/|Extensive “in source” search|limit=500}}.

[[Category:Module test cases]]