Module:Params/doc සඳහා මුලාශ්‍රය නරඹන්න

== Modifiers (piping functions) ==
The following are ''modifiers'', i.e. functions that expect to be piped instead of returning to the caller. Each of them can be followed by either another modifier or a non-piping function. The actions that modifiers do are done sequentially, in the same order chosen during the invocation of this module. Some modifiers, however, after signaling their presence to the modifiers that might follow, add their action to the queue of actions that will be done last (e.g. <code>[[#sequential|sequential]]</code>,  <code>[[#non-sequential|non-sequential]]</code>, <code>[[#all_sorted|all_sorted]]</code>).

{{vpad}}

=== <code>sequential</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>sequential</code>
| label1 = Num. of arguments | data1 = 0
| label2 = Repeatable | data2 = No
| label3 = Conflicts with | data3 = <code>[[#non-sequential|non-sequential]]</code>, <code>[[#all_sorted|all_sorted]]</code>
| header4 =  See also
| data5 = <code>[[#non-sequential|non-sequential]]</code>, <code>[[#all_sorted|all_sorted]]</code>, <code>[[#squeezing|squeezing]]</code>
}}

; Brief
: ''Reduce the parameter list to the subgroup of consecutive parameters that follow {{tjp|1:}}''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|sequential|pipe function name}}</syntaxhighlight>

Example:

<syntaxhighlight lang="wikitext">{{#invoke:params|sequential|count}}</syntaxhighlight>

This modifier does not take arguments besides the name of the function that will follow.

Using <code>sequential</code> together with <code>[[#non-sequential|non-sequential]]</code> will generate an error.

{{vpad}}

{{A note}} Like <code>[[#non-sequential|non-sequential]]</code>, the <code>sequential</code> modifier permanently marks a query. For instance, writing <syntaxhighlight lang="wikitext" inline>{{#invoke:params|sequential|with_name_not_matching|1|...}}</syntaxhighlight> will first mark the query as “sequential”, then will discard the first element from the sequence (leaving all the others intact). And so, no matter how many other parameters will be present, nothing will be shown.

{{vpad|1.5em}}

=== <code>non-sequential</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>non-sequential</code>
| label1 = Num. of arguments | data1 = 0
| label2 = Repeatable | data2 = No
| label3 = Conflicts with | data3 = <code>[[#sequential|sequential]]</code>
| header4 =  See also
| data5 = <code>[[#sequential|sequential]]</code>, <code>[[#all_sorted|all_sorted]]</code>
}}

; Brief
: ''Reduce the parameter list by discarding the subgroup of consecutive parameters that follow {{tjp|1:}}''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|non-sequential|pipe function name}}</syntaxhighlight>

Example:

<syntaxhighlight lang="wikitext">{{#invoke:params|non-sequential|setting|ih/p|{{!}}|{{=}}|list}}</syntaxhighlight>

This modifier does not take arguments besides the name of the function that will follow.

Using <code>non-sequential</code> together with <code>[[#sequential|sequential]]</code> will generate an error.

{{vpad}}

{{A note}} Like <code>[[#sequential|sequential]]</code>, the <code>non-sequential</code> modifier permanently marks a query, and no matter what transformations will follow (see <code>[[#squeezing|squeezing]]</code>) the parameters' “sequence” will not be shown.

{{vpad|1.5em}}

=== <code>all_sorted</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>all_sorted</code>
| label1 = Num. of arguments | data1 = 0
| label2 = Repeatable | data2 = No
| label3 = Conflicts with | data3 = <code>[[#sequential|sequential]]</code>
| label4 = Has no effects on | data4 = <code>[[#count|count]]</code>, <code>[[#value_of|value_of]]</code>, <code>[[#concat_and_call|concat_and_call]]</code>, <code>[[#concat_and_invoke|concat_and_invoke]]</code>, <code>[[#concat_and_magic|concat_and_magic]]</code>
| header5 =  See also
| data6 = <code>[[#sequential|sequential]]</code>
}}

; Brief
: ''When the time will come, all parameters will be dispatched sorted: first the numerical ones, then the rest in alphabetical order''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|all_sorted|pipe function name}}</syntaxhighlight>

Example:

<syntaxhighlight lang="wikitext">{{#invoke:params|all_sorted|setting|ih/p|{{!}}|{{=}}|list}}</syntaxhighlight>

This modifier does not take arguments besides the name of the function that will follow.

Normally only sequential parameters are dispatched sorted, whereas non-sequential ones are dispatched randomly. The <code>all_sorted</code> modifier ensures that nothing is left out of (alphabetical) order. Attention must be paid to the fact that parameters whose name is a negative number will appear first. To avoid this the <code>[[#squeezing|squeezing]]</code> modifier can be used.<ref>To be precise, the order will not be strictly alphabetical, because this would imply that a template called with the following parameters <syntaxhighlight lang="wikitext" inline>{{foobar|-4=you|9=wanna|.=me?|11=marry|-8=do}}</syntaxhighlight> would see them reordered as follows: <syntaxhighlight lang="wikitext" inline>{{foobar|-8=do|-4=you|.=me?|9=wanna|11=marry}}</syntaxhighlight> (with the dot in the middle between negative and positive numbers). To avoid this, '''numbers are always displayd first''' (i.e. <syntaxhighlight lang="wikitext" inline>{{foobar|-8=do|-4=you|9=wanna|11=marry|.=me?}}</syntaxhighlight>).</ref>

The <code>all_sorted</code> modifier only affects the way parameters are shown, but has no effects on functions that do not iterate or cannot impose an order, such as:

* <code>[[#count|count]]</code>
* <code>[[#value_of|value_of]]</code>
* <code>[[#concat_and_call|concat_and_call]]</code>
* <code>[[#concat_and_invoke|concat_and_invoke]]</code>
* <code>[[#concat_and_magic|concat_and_magic]]</code>

{{vpad}}

{{A note}} The <code>all_sorted</code> modifier cannot be used with functions that propagate several parameters together in a single call, like <code>[[#concat_and_call|concat_and_call]]</code>, <code>[[#concat_and_invoke|concat_and_invoke]]</code>, and <code>[[#concat_and_magic|concat_and_magic]]</code>, because during a call the order of arguments is always lost. For the same reason, it is not possible to guess the order of named parameters a template was invoked with.

{{vpad|1.5em}}

=== <code>setting</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>setting</code>
| label1 = Num. of arguments | data1 = 2–7 (variable)
| label2 = Repeatable | data2 = Yes
| header3 =  Memory slots
| data4 = {{aligned table|fullwidth=y
  | col1header=y | col1style=display:block;
  | <code>p</code>| Key-value delimiter
  | <code>i</code>| Iteration delimiter
  | <code>l</code>| Last iteration delimiter
  | <code>h</code>| Header text
  | <code>f</code>| Footer text
  | <code>n</code>| Fallback text
 }}
}}

; Brief
: ''Define glue strings''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|directives|...|pipe function name}}</syntaxhighlight>

This modifier allows to set some internal variables that will be used by functions. It takes a variable number of arguments, relying on the first argument to understand how many other arguments to read. A few examples will introduce it better than words:

* <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|i|{{!}}|list_values}}</syntaxhighlight>
*: ↳ Set the value of ''iteration delimiter'' to <code>|</code>, then list all values
* <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih|{{!}}|list_values}}</syntaxhighlight>
*: ↳ Set the value of both ''header text'' and ''iteration delimiter'' to <code>|</code>, then list all values
* <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|{{!}}|{{=}}|list}}</syntaxhighlight>
*: ↳ Set the value of both ''header text'' and ''iteration delimiter'' to <code>|</code>, set ''key-value pair delimiter'' to <code>=</code>, then list all parameters
* <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p/n|{{!}}|{{=}}|No parameters were passed|list}}</syntaxhighlight>
*: ↳ Set the value of both ''header text'' and ''iteration delimiter'' to <code>|</code>, set ''key-value pair delimiter'' to <code>=</code>, set ''fallback text'' to <code>No parameters were passed</code>, then list all parameters

The first argument is a slash-separated list of lists of slots to assign; one slot is referred by exactly one character and each list of slots maps exactly one argument. A slot indicates which internal variable to set. If more than one slot is aggregated within the same slash-separated list the same text will be assigned to more than one variable.

The slots available are the following:

{| class="wikitable" style="margin-left: auto; margin-right: auto;"
|-
! Slots
! Variable
! Description
|-
| <code>p</code>
| ''Key-value pair delimiter''
| The string of text that will be placed between each parameter name and its value; it is never inserted by functions that only iterate between values, or by functions that pass the key-value pairs to external calls.
|-
| <code>i</code>
| ''Iteration delimiter''
| The string of text that will be placed between each iteration; it is never inserted unless there are two or more parameters to show when <code>l</code> is not given, or three or more parameters when <code>l</code> is given.
|-
| <code>l</code>
| ''Last iteration delimiter''
| The string of text that will be placed between the second last and the last iteration; it is never inserted unless there are two or more parameters to show; if omitted defaults to <code>i</code>.
|-
| <code>h</code>
| ''Header text''
| The string of text that will be placed before the iteration begins; it is never inserted if there are no parameters to show.
|-
| <code>f</code>
| ''Footer text''
| The string of text that will be placed after the iteration is over; it is never inserted if there are no parameters to show.
|-
| <code>n</code>
| ''Fallback text''
| The string of text that will be placed if there are no parameters to show.
|}

All space characters in the directives arguments are discarded. Therefore writing <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|...}}</syntaxhighlight> is equivalent to writing

<syntaxhighlight lang="wikitext">{{#invoke:params|setting| i
	h	/ p |...}}</syntaxhighlight>

In theory, instead of assigning different slots at once (i.e. <syntaxhighlight lang="wikitext" inline>{{...|setting|ih/p|{{!}}|{{=}}|...}}</syntaxhighlight>), it is possible to write separate invocations of <code>setting</code> for each variable, as in <syntaxhighlight lang="wikitext" inline>{{...|setting|ih|{{!}}|setting|p|{{=}}...}}</syntaxhighlight>. This method however will be slightly less efficient.

Sometimes it might be necessary to make the values assigned depend on conditional expressions. For instance, the following imaginary <code><nowiki>{{Foobar see also}}</nowiki></code> template uses the <code>[[:mw:Help:Extension:ParserFunctions##ifexpr|#ifexpr]]</code> parser function to properly show the “and” conjunction and possibly an [[Serial comma|Oxford comma]] when more than two page names are provided:

<syntaxhighlight lang="wikitext">{{Hatnote|{{{altphrase|Foobar see also}}}: {{#if:{{{1|}}}
	|{{#invoke:params|sequential|squeezing|setting|i/l|, |{{#ifexpr:{{#invoke:params|sequential|squeezing|count}} > 2|,}} and |trimming_values|for_each|[[$@]]}}
	|{{Error|{{tl|Foobar see also}} requires at least one page name}}
}}}}</syntaxhighlight>

You can find this example at {{[[:en:Module:Params/doc/examples/Oxford comma|./{{#ifeq:{{SUBPAGENAME}}|doc||doc/}}examples/Oxford comma]]}}. E.g., <syntaxhighlight lang="wikitext" inline>{{module:params/doc/examples/Oxford comma|Latin|English|German|Italian}}</syntaxhighlight> will generate

{{module:params/doc/examples/Oxford comma|Latin|English|German|Italian}}

{{vpad}}

{{A note}} The <code>setting</code> modifier will be trimmed of its surrounding spaces. The directives argument will be stripped of all space characters, including internal spaces. All the other arguments passed to this modifier will be parsed verbatim (i.e. leading and trailing spaces will not be removed).

{{vpad|1.5em}}

=== <code>squeezing</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>squeezing</code>
| label1 = Num. of arguments | data1 = 0
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#sequential|sequential]]</code>
}}

; Brief
: ''Rearrange all parameters that have numerical names to form a compact sequence starting from 1, keeping the same order''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|squeezing|pipe function name}}</syntaxhighlight>

Example:

<syntaxhighlight lang="wikitext">{{#invoke:params|squeezing|sequential|setting|i/p|<br />|: |list}}</syntaxhighlight>

This modifier does not take arguments besides the name of the function that will follow.

The following three concatenations will lead to the same result of discarding all parameters with numerical names:

# <syntaxhighlight lang="wikitext" inline>{{...|non-sequential|squeezing|...}}</syntaxhighlight>
# <syntaxhighlight lang="wikitext" inline>{{...|squeezing|non-sequential|...}}</syntaxhighlight>
# <syntaxhighlight lang="wikitext" inline>{{...|with_name_not_matching|^%-?%d+$|...}}</syntaxhighlight>

{{vpad|1.5em}}

=== <code>cutting</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>cutting</code>
| label1 = Num. of arguments | data1 = 2
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#sequential|sequential]]</code>, <code>[[#squeezing|squeezing]]</code>
}}

; Brief
: ''Remove zero or more parameters from the beginning and the end of the parameter list''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|cutting|left trim|right trim|pipe function name}}</syntaxhighlight>

The first argument indicates how many sequential parameters must be removed from the beginning of the parameter list, the second argument indicates how many sequential parameters must be removed from the end of the parameter list. If any of the two arguments contains a negative number its absolute value indicates what must be left ''on the other side'' – i.e. <syntaxhighlight lang="wikitext" inline>{{#invoke:params|cutting|-3|0|list}}</syntaxhighlight> indicates that the last three arguments must not be discarded.

Example:

<syntaxhighlight lang="wikitext">{{#invoke:params|cutting|0|2|sequential|call_for_each_value|example template}}</syntaxhighlight>

If the absolute value of the sum of the two arguments (left and right cut) is greater than the number of sequential parameters available, the behavior will be the same as if the sum had been equal to the number of sequential parameters available, both when this is a positive value and when it is a negative value (with opposite results). After the desired sequential parameters have been discarded, all numerical parameters will be shifted accordingly.

In some cases it might be necessary to concatenate more than one invocation of the <code>cutting</code> modifier. For instance, the following code prints the last unnamed parameter passed, but only if at least two parameters were passed:

<syntaxhighlight lang="wikitext">{{#invoke:params|sequential|cutting|1|0|cutting|-1|0|list_values}}</syntaxhighlight>

{{A note|Suggestion:}} Although <syntaxhighlight lang="wikitext" inline>{{#invoke:params|cutting|-1|1|...}}</syntaxhighlight> de facto gets rid of all sequential parameters, it is clearer and more idiomatic to write <syntaxhighlight lang="wikitext" inline>{{#invoke:params|non-sequential|...}}</syntaxhighlight> to obtain the same effect. Writing instead <syntaxhighlight lang="wikitext" inline>{{#invoke:params|sequential|cutting|-1|1|...}}</syntaxhighlight> will leave zero arguments to show.

{{vpad|1.5em}}

=== <code>with_name_matching</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>with_name_matching</code>
| label1 = Num. of arguments | data1 = ''Ad libitum''
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#with_name_not_matching|with_name_not_matching]]</code>, <code>[[#with_value_matching|with_value_matching]]</code>, <code>[[#with_value_not_matching|with_value_not_matching]]</code>
}}

; Brief
: ''Discard all parameters whose name ''does not match '''any''''' of the given patterns''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|with_name_matching|pattern 1|[plain flag 1]|[or]|[pattern 2]|[plain flag 2]|[or]|[...]|[pattern N]|[plain flag N]|pipe function name}}</syntaxhighlight>

Internally this modifier uses Lua's <code>[[:mw:Extension:Scribunto/Lua reference manual#string.find|string.find()]]</code> function to find whether parameter names match against given patterns; therefore, unless a target string is set to <code>plain</code>, please use the same syntax of [[:mw:Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]]. The plain flag can be either <code>plain</code> or omitted. When omitted it is assumed that the target string is a Lua pattern.

To express a [[Disjunction (logical connective)|logical OR]] the <code>or</code> keyword is available. To express a [[Logical conjunction|logical AND]] instead, concatenate more invocations of <code>with_name_matching</code>.

{{vpad}}

For the sake of argument we will imagine that we are invoking <code>with_name_matching</code> from within the {{tl|Infobox artery}} template, and this is being called with the following parameters:

{{tj|Infobox artery
	| Name: Pulmonary artery
	| Latin: truncus pulmonalis, arteria pulmonalis
	| Image: <nowiki>{{Heart diagram 250px}}</nowiki>
	| Caption: Anterior (frontal) view of the opened heart. (Pulmonary artery upper right.)
	| Image2: Alveoli diagram.png
	| Caption2: Diagram of the alveoli with both cross-section and external view.
	| BranchFrom: <nowiki>[[right ventricle]]</nowiki>
	| BranchTo: 
	| Vein: <nowiki>[[pulmonary vein]]</nowiki>
	| Precursor: truncus arteriosus
	| Supplies: 
}}

{{vpad}}

Test cases:

* List only the parameters whose names match against the <code>^Image</code> pattern:
*: ↳ <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|{{!}}|{{=}}|with_name_matching|^Image|list}}</syntaxhighlight>
*:: ↳ {{highlight round|bc=#ff9|<nowiki>|Image={{Heart diagram 250px}}|Image2=Alveoli diagram.png</nowiki>}}
* List the parameters whose names match against both patterns <code>^Image</code> '''and''' <code>%d+$</code>:
*: ↳ <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|{{!}}|{{=}}|with_name_matching|^Image|with_name_matching|%d+$|list}}</syntaxhighlight>
*:: ↳ {{highlight round|bc=#ff9|<nowiki>|Image2=Alveoli diagram.png</nowiki>}}
* List the parameters whose names match against either the <code>^Name</code> '''or''' the <code>^Latin$</code> pattern:
*: ↳ <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|{{!}}|{{=}}|with_name_matching|^Name$|or|^Latin$|list}}</syntaxhighlight>
*:: ↳ {{highlight round|bc=#ff9|<nowiki>|Latin=truncus pulmonalis, arteria pulmonalis|Name=Pulmonary artery</nowiki>}}
* List the parameters whose names match against either the <code>ma</code> plain string '''or''' the <code>me$</code> pattern:
*: ↳ <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|{{!}}|{{=}}|with_name_matching|ma|plain|or|me$|list}}</syntaxhighlight>
*:: ↳ {{highlight round|bc=#ff9|<nowiki>|Image={{Heart diagram 250px}}|Name=Pulmonary artery|Image2=Alveoli diagram.png</nowiki>}}

{{vpad}}

{{A note}} The pattern arguments passed to this function are not trimmed of their leading and trailing spaces. The <code>or</code> and <code>plain</code> keywords, and the <code>with_name_matching</code> function name itself, however, will be trimmed of their surrounding spaces.

{{vpad|1.5em}}

=== <code>with_name_not_matching</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>with_name_not_matching</code>
| label1 = Num. of arguments | data1 = ''Ad libitum''
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#with_name_matching|with_name_matching]]</code>, <code>[[#with_value_matching|with_value_matching]]</code>, <code>[[#with_value_not_matching|with_value_not_matching]]</code>
}}

; Brief
: ''Discard all parameters whose name ''matches '''all''''' the given patterns''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|with_name_not_matching|pattern 1|[plain flag 1]|[and]|[pattern 2]|[plain flag 2]|[and]|[...]|[pattern N]|[plain flag N]|pipe function name}}</syntaxhighlight>

Internally this modifier uses Lua's <code>[[:mw:Extension:Scribunto/Lua reference manual#string.find|string.find()]]</code> function to find whether parameter names match against given patterns; therefore, unless a target string is set to <code>plain</code>, please use the same syntax of [[:mw:Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]]. The plain flag can be either <code>plain</code> or omitted. When omitted it is assumed that the target string is a Lua pattern.

To express a [[Disjunction (logical connective)|logical OR]] the <code>or</code> keyword is available. To express a [[Logical conjunction|logical AND]] instead, concatenate more invocations of <code>with_name_not_matching</code>.

{{vpad}}

For the sake of argument we will imagine that we are invoking <code>with_name_not_matching</code> from within the {{tl|Infobox artery}} template, and this is being transcluded using the same parameters that we had imagined in the previous example at <code>[[#with_name_matching|with_name_matching]]</code>:

* List only the parameters whose names do not match against the <code>a</code> pattern:
*: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|{{!}}|{{=}}|with_name_not_matching|a|list}}</syntaxhighlight>
*:: ↳ {{highlight round|bc=#ff9|<nowiki>|Precursor=truncus arteriosus|Supplies=|Vein=pulmonary vein</nowiki>}}
* List the parameters whose names do not match against the <code>a</code> plain string '''and''' do not match against the <code>l</code> plain string either:
*: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|{{!}}|{{=}}|with_name_not_matching|a|plain|with_name_not_matching|l|plain|list}}</syntaxhighlight>
*:: ↳ {{highlight round|bc=#ff9|<nowiki>|Precursor=truncus arteriosus|Vein=pulmonary vein</nowiki>}}
* List the parameters whose names do not match against either the <code>a</code> plain string '''or''' the <code>n</code> plain string:
*: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|setting|ih/p|{{!}}|{{=}}|with_name_not_matching|a|plain|or|n|plain|list}}</syntaxhighlight>
*:: ↳ {{highlight round|bc=#ff9|<nowiki>|Precursor=truncus arteriosus|Supplies=|Image={{Heart diagram 250px}}|Name=Pulmonary artery|Image2=Alveoli diagram.png|Vein=pulmonary vein</nowiki>}}

{{vpad}}

It is possible to use this function to check for unknown parameters:

<syntaxhighlight lang="wikitext">{{#ifexpr:{{#invoke:params|with_name_not_matching|^hello$|with_name_not_matching|^wind$|count}} > 0
	|{{#invoke:Error|error|Error: The only parameters accepted are {{para|hello}} and {{para|wind}}.}}
	|Everything is good: do something
}}</syntaxhighlight>

For simple cases like this, however, specialized modules are available; you might want to have a look at:

* {{ml|Check for unknown parameters|check}}
* {{ml|Check for deprecated parameters|check}}
* {{ml|Check for clobbered parameters|check}}
* {{ml|Parameter validation|validateparams}}
* {{ml|TemplatePar|valid}}

{{vpad}}

{{A note}} The pattern arguments passed to this function are not trimmed of their leading and trailing spaces. The <code>or</code> and <code>plain</code> keywords, and the <code>with_name_not_matching</code> function name itself, however, will be trimmed of their surrounding spaces.

{{vpad|1.5em}}

=== <code>with_value_matching</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>with_value_matching</code>
| label1 = Num. of arguments | data1 = ''Ad libitum''
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#with_name_matching|with_name_matching]]</code>, <code>[[#with_name_not_matching|with_name_not_matching]]</code>, <code>[[#with_value_not_matching|with_value_not_matching]]</code>
}}

; Brief
: ''Discard all parameters whose value ''does not match '''any''''' of the given patterns''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|with_value_matching|pattern 1|[plain flag 1]|[or]|[pattern 2]|[plain flag 2]|[or]|[...]|[pattern N]|[plain flag N]|pipe function name}}</syntaxhighlight>

Exactly like <code>[[#with_name_matching|with_name_matching]]</code>, but applied to parameter values instead of names.

Internally this modifier uses Lua's <code>[[:mw:Extension:Scribunto/Lua reference manual#string.find|string.find()]]</code> function to find whether parameter names match against given patterns; therefore, unless a target string is set to <code>plain</code>, please use the same syntax of [[:mw:Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]]. The plain flag can be either <code>plain</code> or omitted. When omitted it is assumed that the target string is a Lua pattern.

Example:

<syntaxhighlight lang="wikitext">{{#invoke:params|with_value_matching|banana|count}}</syntaxhighlight>

{{vpad}}

{{A note}} The pattern arguments passed to this function are not trimmed of their leading and trailing spaces. The <code>or</code> and <code>plain</code> keywords, and the <code>with_value_matching</code> function name itself, however, will be trimmed of their surrounding spaces.

{{vpad|1.5em}}

=== <code>with_value_not_matching</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>with_value_not_matching</code>
| label1 = Num. of arguments | data1 = ''Ad libitum''
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#with_name_matching|with_name_matching]]</code>, <code>[[#with_name_not_matching|with_name_not_matching]]</code>, <code>[[#with_value_matching|with_value_matching]]</code>
}}

; Brief
: ''Discard all parameters whose value ''matches '''all''''' the given patterns''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|with_value_not_matching|pattern 1|[plain flag 1]|[and]|[pattern 2]|[plain flag 2]|[and]|[...]|[pattern N]|[plain flag N]|pipe function name}}</syntaxhighlight>

Exactly like <code>[[#with_name_not_matching|with_name_not_matching]]</code>, but applied to parameter values instead of names.

Internally this modifier uses Lua's <code>[[:mw:Extension:Scribunto/Lua reference manual#string.find|string.find()]]</code> function to find whether parameter names match against given patterns; therefore, unless a target string is set to <code>plain</code>, please use the same syntax of [[:mw:Extension:Scribunto/Lua reference manual#Patterns|Lua patterns]]. The plain flag can be either <code>plain</code> or omitted. When omitted it is assumed that the target string is a Lua pattern.

For instance, before calling <code>[[#list|list]]</code>, the following code will get rid of all blank parameters (i.e. parameters whose values contain only zero or more spaces):

<syntaxhighlight lang="wikitext">{{#invoke:params|with_value_not_matching|^%s*$|setting|hi/p|{{!}}|{{=}}|list}}</syntaxhighlight>

{{vpad}}

{{A note}} The pattern arguments passed to this function are not trimmed of their leading and trailing spaces. The <code>or</code> and <code>plain</code> keywords, and the <code>with_value_not_matching</code> function name itself, however, will be trimmed of their surrounding spaces.

{{vpad|1.5em}}

=== <code>trimming_values</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>trimming_values</code>
| label1 = Num. of arguments | data1 = 0
| label2 = Repeatable | data2 = No
}}

; Brief
: ''Remove leading and trailing spaces from values''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|trimming_values|pipe function name}}</syntaxhighlight>

This modifier does not take arguments besides the name of the function that will follow.

Most modifiers are order-dependent, therefore placing <code>trimming_values</code> in different positions can generate different results. For instance, imagining our <code><nowiki>{{Example template}}</nowiki></code> being called with the following spaced arguments: <syntaxhighlight lang="wikitext" inline>{{Example template| wanna | be | my | friend | ? }}</syntaxhighlight>. If <code><nowiki>{{Example template}}</nowiki></code> contained the following code,

<syntaxhighlight lang="wikitext">{{#invoke:params|with_value_matching|%s+$|trimming_values|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

the following text would be printed: <code>1=wanna|2=be|3=my|4=friend|5=?</code>. But if instead it contained the following code,

<syntaxhighlight lang="wikitext">{{#invoke:params|trimming_values|with_value_matching|%s+$|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

no arguments would be shown.

Order affects also performance, and how many values will be trimmed of their leading and trailing spaces will depend on where <code>trimming_values</code> is placed. For instance, if a template were invoked with 50 parameters and its code contained <syntaxhighlight lang="wikitext" inline>{{#invoke:params|trimming_values|cutting|-1|0|list}}</syntaxhighlight>, first all its values would be trimmed of leading and trailing blank spaces and then its first 49 parameters would be discarded. On the other hand, writing <syntaxhighlight lang="wikitext" inline>{{#invoke:params|cutting|-1|0|trimming_values|list}}</syntaxhighlight> would first discard 49 parameters and then trim the only value left, resulting in a more efficient code. As a general rule, placing <code>trimming_values</code> as the last modifier is usually the best choice.

Placing <code>trimming_values</code> together with <code>non-sequential</code> will result in an empty call with no effects, because non-sequential parameters are stripped of their leading and trailing spaces by default.

Using <code>trimming_values</code> makes this module behave like many Wikipedia modules behave. For example, if we wanted to emulate {{ml|Separated entries|main}}, writing

<syntaxhighlight lang="wikitext">{{#invoke:params|sequential|squeezing|trimming_values|setting|i|XXXX|list_values}}</syntaxhighlight>

will be equivalent to writing,

<syntaxhighlight lang="wikitext">{{#invoke:separated entries|main|separator=XXXX}}</syntaxhighlight>

whereas writing

<syntaxhighlight lang="wikitext">{{#invoke:params|sequential|squeezing|trimming_values|setting|i/l|XXXX|YYYY|list_values}}</syntaxhighlight>

will be equivalent to writing

<syntaxhighlight lang="wikitext">{{#invoke:separated entries|main|separator=XXXX|conjunction=YYYY}}</syntaxhighlight>

The {{[[:en:Module:Params/doc/examples/trim and call|./{{#ifeq:{{SUBPAGENAME}}|doc||doc/}}trim and call]]}} example template shows how to call any arbitrary template trimming all parameters beforehand.

{{vpad|1.5em}}

=== <code>mapping_values_by_calling</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>mapping_values_by_calling</code>
| label1 = Num. of arguments | data1 = ''Ad libitum''
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#mapping_values_by_invoking|mapping_values_by_invoking]]</code>, <code>[[#mapping_values_blindly_by_calling|mapping_values_blindly_by_calling]]</code>, <code>[[#mapping_values_blindly_by_invoking|mapping_values_blindly_by_invoking]]</code>
}}

; Brief
: ''[[Map (higher-order function)|Map]] all parameter values, replacing their content with the expansion of a given template repeatedly called with at least two arguments (the parameter's name and value)''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|mapping_values_by_calling|template name|[number of additional arguments]|[argument 1]|[argument 2]|[...]|[argument N]|pipe function name}}</syntaxhighlight>

This modifier (temporarily) changes the contents of the parameters the current template is being called with, replacing each of them with the text returned by another template. The latter will be repeatedly called with at least two parameters: key and value. If the template name is followed by a number, this will be parsed as the amount of additional parameters to pass. For instance, before listing all parameters,

<syntaxhighlight lang="wikitext">{{#invoke:params|mapping_values_by_calling|foobar|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

will replace each value with the expansion of <syntaxhighlight lang="wikitext" inline>{{foobar|NAME|VALUE}}</syntaxhighlight> (where <code>NAME</code> and <code>VALUE</code> indicate each different name and value).

On the other hand,

<syntaxhighlight lang="wikitext">{{#invoke:params|mapping_values_by_calling|foobar|2|hello|world|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

will do the same, but using the expansion of <syntaxhighlight lang="wikitext" inline>{{foobar|NAME|VALUE|hello|world}}</syntaxhighlight>.

There are no mechanisms for passing non-sequential or non-numeric additional parameters to the mapping template. A similar function, <code>[[#mapping_values_blindly_by_calling|mapping_values_blindly_by_calling]]</code>, omits the first parameter (i.e. the parameter's name).

{{vpad}}

{{A note}} All arguments passed to this modifier except the template name and the number of additional arguments are not trimmed of their leading and trailing spaces. The <code>mapping_values_by_calling</code> modifier name itself, however, will be trimmed of its surrounding spaces.

{{vpad|1.5em}}

=== <code>mapping_values_by_invoking</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>mapping_values_by_invoking</code>
| label1 = Num. of arguments | data1 = ''Ad libitum''
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#mapping_values_by_calling|mapping_values_by_calling]]</code>, <code>[[#mapping_values_blindly_by_calling|mapping_values_blindly_by_calling]]</code>, <code>[[#mapping_values_blindly_by_invoking|mapping_values_blindly_by_invoking]]</code>
}}

; Brief
: ''[[Map (higher-order function)|Map]] all parameter values, replacing their content with the text returned by a given module function repeatedly invoked with at least two arguments (the parameter's name and value)''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|mapping_values_by_invoking|template name|[number of additional arguments]|[argument 1]|[argument 2]|[...]|[argument N]|pipe function name}}</syntaxhighlight>

This modifier (temporarily) changes the contents of the parameters the current template is being called with, replacing each of them with text returned by a custom module function. The latter will be repeatedly invoked with at least two arguments: key and value. If the function name is followed by a number, this will be parsed as the amount of additional arguments to pass. For instance, before listing all parameters,

<syntaxhighlight lang="wikitext">{{#invoke:params|mapping_values_by_invoking|foobar|main|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

will replace each value with the expansion of <syntaxhighlight lang="wikitext" inline>{{#invoke:foobar|main|NAME|VALUE}}</syntaxhighlight> (where <code>NAME</code> and <code>VALUE</code> indicate each different name and value).

On the other hand,

<syntaxhighlight lang="wikitext">{{#invoke:params|mapping_values_by_invoking|foobar|main|2|hello|world|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

will do the same, but using the expansion of <syntaxhighlight lang="wikitext" inline>{{#invoke:foobar|main|NAME|VALUE|hello|world}}</syntaxhighlight>.

There are no mechanisms for passing non-sequential or non-numeric additional arguments to the mapping module. A similar function, <code>[[#mapping_values_blindly_by_invoking|mapping_values_blindly_by_invoking]]</code>, omits the first argument (i.e. the parameter's name).

{{vpad}}

{{A note}} All arguments passed to this modifier except the module name, the function name and the number of additional arguments are not trimmed of their leading and trailing spaces. The <code>mapping_values_by_invoking</code> modifier name itself, however, will be trimmed of its surrounding spaces.

{{vpad|1.5em}}

=== <code>mapping_values_blindly_by_calling</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>mapping_values_blindly_by_calling</code>
| label1 = Num. of arguments | data1 = ''Ad libitum''
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#mapping_values_by_calling|mapping_values_by_calling]]</code>, <code>[[#mapping_values_by_invoking|mapping_values_by_invoking]]</code>, <code>[[#mapping_values_blindly_by_invoking|mapping_values_blindly_by_invoking]]</code>
}}

; Brief
: ''[[Map (higher-order function)|Map]] all parameter values, replacing their content with the expansion of a given template repeatedly called with at least one argument (the parameter's value)''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|mapping_values_blindly_by_calling|template name|[number of additional arguments]|[argument 1]|[argument 2]|[...]|[argument N]|pipe function name}}</syntaxhighlight>

This modifier (temporarily) changes the contents of the parameters the current template is being called with, replacing each of them with the text returned by another template. The latter will be repeatedly called with at least one parameter: the parameter's value. If the template name is followed by a number, this will be parsed as the amount of additional parameters to pass. For instance, before listing all parameters,

<syntaxhighlight lang="wikitext">{{#invoke:params|mapping_values_blindly_by_calling|foobar|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

will replace each value with the expansion of <syntaxhighlight lang="wikitext" inline>{{foobar|VALUE}}</syntaxhighlight> (where <code>VALUE</code> indicates each different value).

On the other hand,

<syntaxhighlight lang="wikitext">{{#invoke:params|mapping_values_blindly_by_calling|foobar|2|hello|world|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

will do the same, but using the expansion of <syntaxhighlight lang="wikitext" inline>{{foobar|VALUE|hello|world}}</syntaxhighlight>.

There are no mechanisms for passing non-sequential or non-numeric additional parameters to the mapping template. A similar function, <code>[[#mapping_values_by_calling|mapping_values_by_calling]]</code>, passes the parameter's name as well, as first argument.

{{vpad}}

{{A note}} All arguments passed to this modifier except the template name and the number of additional arguments are not trimmed of their leading and trailing spaces. The <code>mapping_values_blindly_by_calling</code> modifier name itself, however, will be trimmed of its surrounding spaces.

{{vpad|1.5em}}

=== <code>mapping_values_blindly_by_invoking</code> ===
{{Infobox|headerstyle=background:lavender
| titlestyle = font-weight:normal; font-size:100%;
| title = Modifier <code>mapping_values_blindly_by_invoking</code>
| label1 = Num. of arguments | data1 = ''Ad libitum''
| label2 = Repeatable | data2 = Yes
| header3 =  See also
| data4 = <code>[[#mapping_values_by_calling|mapping_values_by_calling]]</code>, <code>[[#mapping_values_by_invoking|mapping_values_by_invoking]]</code>, <code>[[#mapping_values_blindly_by_calling|mapping_values_blindly_by_calling]]</code>
}}

; Brief
: ''[[Map (higher-order function)|Map]] all parameter values, replacing their content with the text returned by a given module function repeatedly invoked with at least one argument (the parameter's value)''
; Syntax
: <syntaxhighlight lang="wikitext" inline>{{#invoke:params|mapping_values_blindly_by_invoking|template name|[number of additional arguments]|[argument 1]|[argument 2]|[...]|[argument N]|pipe function name}}</syntaxhighlight>

This modifier (temporarily) changes the contents of the parameters the current template is being called with, replacing each of them with text returned by a custom module function. The latter will be repeatedly invoked with at least one argument: the parameter's value. If the function name is followed by a number, this will be parsed as the amount of additional arguments to pass. For instance, before listing all parameters,

<syntaxhighlight lang="wikitext">{{#invoke:params|mapping_values_blindly_by_invoking|foobar|main|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

will replace each value with the expansion of <syntaxhighlight lang="wikitext" inline>{{#invoke:foobar|main|VALUE}}</syntaxhighlight> (where <code>VALUE</code> indicates each different value).

On the other hand,

<syntaxhighlight lang="wikitext">{{#invoke:params|mapping_values_blindly_by_invoking|foobar|main|2|hello|world|setting|i/p|{{!}}|{{=}}|list}}</syntaxhighlight>

will do the same, but using the expansion of <syntaxhighlight lang="wikitext" inline>{{#invoke:foobar|main|VALUE|hello|world}}</syntaxhighlight>.

There are no mechanisms for passing non-sequential or non-numeric additional arguments to the mapping module. A similar function, <code>[[#mapping_values_by_invoking|mapping_values_by_invoking]]</code>, passes the parameter's name as well, as first argument.

{{vpad}}

{{A note}} All arguments passed to this modifier except the module name, the function name and the number of additional arguments are not trimmed of their leading and trailing spaces. The <code>mapping_values_blindly_by_invoking</code> modifier name itself, however, will be trimmed of its surrounding spaces.

{{vpad}}