Wikipedia>BrandonXLF: /* Parameter suffixes */

2026-09-15T01:58:56Z

Parameter suffixes

New page

{{Module rating|beta}}
{{Lua|Module:Yesno}}

{{mlx|For params|main}} implements a [[loop (statement)|loop]] over valid numbered parameters. The loop body that receives the parameters is either defined as wikitext using {{para|1}} or as a template using {{para|call}}.

== Syntax ==
* Wikitext: <code><nowiki>{{</nowiki>#invoke:For params|main|<nowiki>''wikitext''<nowiki>|''config parameters''<nowiki>}}</nowiki></code>
* Template: <code><nowiki>{{</nowiki>#invoke:For params|main|call=''template''|''config parameters''<nowiki>}}</nowiki></code>

== Body ==
The wikitext where parameters are substituted into is defined either as wikitext or a template. Parameters are passed with their number '''removed''', i.e. {{para|1=''prefix''''i''''suffix''}} becomes {{para|1=''prefix''''suffix''}} and {{para|1=''extra''''i''''extrasuffix''}} becomes {{para|1=''extra''''extrasuffix''}}. The parameter {{param|i}} is the current index, and {{param|1}} is the current unnamed parameter (if applicable).

; Body definition parameters
* {{para|1}} - Wikitext to process using the parameters each iteration. Enclosed in {{Tag|nowiki}}.
* {{para|call}} - Template to call. Overrides {{para|1}}. As with transclusion, if the passed title does have a namespace prefix, it will default to the <code>Template:</code> namespace.

== Input ==
The parameters passed to the body are either prefix parameters, extra parameters, or fixed parameters.

; Parameter definitions parameters
* {{para|prefix''n''}} - A parameter prefix to process. All registered parameter prefixes will be checked to determine if a iteration number is present in the provided arguments. {{para|prefix1}} defaults to processing unnamed parameters.
* {{para|suffix''n''}} - Suffix for the corresponding {{para|prefix''n''}} if applicable. For example, <code>{{!}}prefix1=person</code> will look for parameters of the form <code>person''x''</code> (where ''x'' is a number), and <code>{{!}}prefix1=person {{!}}suffix1=_name</code> will look for parameters of the form <code>person''x''_name</code>.
* {{para|extra''n''}} - An extra parameter prefix to process. Unlike prefixes, these will not be checked to determine if a number is present in the provided arguments. For example, if <code>item</code> is a prefix and <code>style</code> is an extra, then <code>style2</code> will be ignored unless <code>item2</code> is also defined.
* {{para|extrasuffix''n''}} - Suffix for the corresponding {{para|extra''n''}} if applicable. For example, <code>{{!}}extra1=age</code> will look for parameters of the form <code>age''x''</code> (where ''x'' is a number), and <code>{{!}}extra1=person {{!}}suffix1=_age</code> will look for parameters of the form <code>person''x''_age</code>.
* {{para|fixed''n''}} - A fixed parameter to use the value of as an argument for all iterations. Useful for configuration parameters that apply to all iterations.

; Behaviour parameters
* {{para|sparse}} - Set to <code>yes</code> to support parameter lists with gaps. Defaults to <code>no</code>.
* {{para|optnum}} - Whether or not to support passing the first parameter without a number, i.e. allow {{para|1=''prefix''''suffix''}} rather than {{para|1=''prefix''1''suffix''}} for the first parameter. Defaults to <code>yes</code>.
* {{para|start}} - Begin iterating from this number. Parameters before this number are ignored.
* {{para|noindex}} - Don't pass {{param|i}}, the current index, to the body. Defaults to <code>no</code>, i.e. do pass {{param|i}}.

== Concatenation ==
Before the final output is produced, optional concatenation separators can be added in-between iterations.

; Separator parameters
* {{para|sep}} / {{para|2}} - Separator to add between outputs. To preserve leading and trailing whitespace, an unnamed parameter can be used instead ({{para|2}}, unless {{para|call}} is being used, then {{para|1}}).
* {{para|conj}} - Special separator to use before the final output. Outer spaces can be added with {{tlx|sp}} or <code>&#32;</code>.

== Examples ==
{{See also|Module talk:For params/testcases}}

=== Wkitext ===
'''Template wikitext:'''
<syntaxhighlight lang="WikiText">{{#invoke:For params|main|<nowiki>{{{first}}} {{{last}}}</nowiki>|, |prefix1=last|prefix2=first}}</syntaxhighlight>

'''Template call:'''
<syntaxhighlight lang="WikiText">
{{__TEMPLATE__
|last1=Doe |first1=Jane
|last2=Smith |first2=John
}}
</syntaxhighlight>

'''Output:'''
{{Call wikitext
|sourceCode=<nowiki>{{#invoke:For params|main|<nowiki>{{{first}}} {{{last}}}</nowiki>|, |prefix1=last|prefix2=first}}</nowiki>
|last1=Doe |first1=Jane
|last2=Smith |first2=John
}}

{{ivmbox|bg=#edf2ff|
When {{para|optnum|no}} is not set, the first parameter set does not require a number suffix:

'''Template call:'''
<syntaxhighlight lang="WikiText">
{{__TEMPLATE__
|last=Doe |first=Jane
|last2=Smith |first2=John
|last3=White |first3=Walter
}}
</syntaxhighlight>

'''Output:'''
{{Call wikitext
|sourceCode=<nowiki>{{#invoke:For params|main|<nowiki>{{{first}}} {{{last}}}</nowiki>|, |prefix1=last|prefix2=first}}</nowiki>
|last=Doe |first=Jane
|last2=Smith |first2=John
|last3=White |first3=Walter
}}
}}

{{ivmbox|bg=#edf2ff|
If the first parameter set has a number suffix, parameters without a suffix are overridden:

'''Template call:'''
<syntaxhighlight lang="WikiText">
{{__TEMPLATE__
|last=Doe |first=Jane
|last1=Smith |first1=John
}}
</syntaxhighlight>

'''Output:'''
{{Call wikitext
|sourceCode=<nowiki>{{#invoke:For params|main|<nowiki>{{{first}}} {{{last}}}</nowiki>|, |prefix1=last|prefix2=first}}</nowiki>
|last=Doe |first=Jane
|last1=Smith |first1=John
}}
}}

{{ivmbox|bg=#edf2ff|
If parameters specified some (but not all) <code>prefix''n''</code> are missing in a group, they will be missing in the call of the wikitext:

'''Template call:'''
<syntaxhighlight lang="WikiText">
{{__TEMPLATE__
|last1=Doe
|first2=John
}}
</syntaxhighlight>

'''Output:'''
{{Call wikitext
|sourceCode=<nowiki>{{#invoke:For params|main|<nowiki>{{{first}}} {{{last}}}</nowiki>|, |prefix1=last|prefix2=first}}</nowiki>
|last1=Doe
|first2=John
}}
}}

=== Parameter suffixes ===
'''Template wikitext:'''
<syntaxhighlight lang="WikiText">{{#invoke:For params|main|<nowiki>{{{person_name}}}, aged {{{person_age|?}}}</nowiki>|; |prefix=person|suffix=_name|extra=person|extrasuffix=age}}.</syntaxhighlight>

'''Template call:'''
<syntaxhighlight lang="WikiText">
{{__TEMPLATE__
|person_name=John |person_age=40
|person2_name=Jane |person2_age=45
|person3_name=Bill
}}
</syntaxhighlight>

'''Output:'''
{{Call wikitext
|sourceCode=<nowiki>{{#invoke:For params|main|<nowiki>{{{person_name}}}, aged {{{person_age|?}}}</nowiki>|; |prefix=person|suffix=_name|extra=person|extrasuffix=_age}}.</nowiki>
|person_name=John |person_age=40
|person2_name=Jane |person2_age=45
|person3_name=Bill
}}

=== Complex wikitext ===
'''Template wikitext:'''
<syntaxhighlight lang="WikiText">{{#invoke:For params|main
|<nowiki>* ''{{{item}}}'' {{#if:{{{date|{{{alias|}}}}}}
| @ Date: {{#if:{{Yesno|{{{red_dates|}}}}}
| {{Red|{{{date|{{{alias|}}}}}}}}
| {{{date|{{{alias|}}}}}}
}}
}}</nowiki>|
|prefix1=item |extra1=date |extra2=alias |fixed1=bold_dates
}}</syntaxhighlight>

'''Template call:'''
<syntaxhighlight lang="WikiText">
{{__TEMPLATE__ |item1=Foo |item2=Bar |date2=2026-08-27 |item3=Baz |alias3=2026-08-30 |red_dates=1}}
</syntaxhighlight>

'''Output:'''
{{Call wikitext|sourceCode=<nowiki>{{#invoke:For params|main
|<nowiki>* ''{{{item}}}'' {{#if:{{{date|{{{alias|}}}}}}
| @ Date: {{#if:{{Yesno|{{{red_dates|}}}}}}
| {{Red|{{{date|{{{alias|}}}}}}}}
| {{{date|{{{alias|}}}}}}
}}
}}</nowiki>|
|prefix1=item |extra1=date |extra2=alias |fixed1=bold_dates
}}</nowiki>|item1=Foo |item2=Bar |date2=2026-08-27 |item3=Baz |alias3=2026-08-30 |red_dates=1}}

=== Secondary template ===
'''Template wikitext:'''
<syntaxhighlight lang="WikiText">{{#invoke:For params|main |call=Cite web |prefix1=last |prefix2=first |prefix3=title |prefix4=url |noindex=y |sep={{sp}}}}</syntaxhighlight>

'''Template call:'''
<syntaxhighlight lang="WikiText">
{{__TEMPLATE__
|last=Doe |first=Jane |title=A website |url=https://www.example.com
|last2=Smith |first2=John |title2=A better website |url2=https://www.example.com/better
|last3=White |first3=Walter |title3=The best website |url3=https://www.example.com/best
}}
</syntaxhighlight>

'''Output:'''
{{Call wikitext
|sourceCode=<nowiki>{{#invoke:For params|main |call=Cite web |prefix1=last |prefix2=first |prefix3=title |prefix4=url |noindex=y |sep={{sp}}}}</nowiki>
|last=Doe |first=Jane |title=A website |url=https://www.example.com
|last2=Smith |first2=John |title2=A better website |url2=https://www.example.com/better
|last3=White |first3=Walter |title3=The best website |url3=https://www.example.com/best
}}

== See also ==
{{Infinite parameters modules}}

<includeonly>{{Sandbox other||

[[Category:Template metamodules]]
[[Category:Wikitext processing modules]]
}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>

Module:For params/doc - Revision history

Wikipedia>BrandonXLF: /* Parameter suffixes */