View source for Module:Sandbox/BrandonXLF/Module:Map params/doc

<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Module rating|beta}}
{{Lua|Module:Yesno}}

{{mlx|Map params|map}} maps parameters received by a function to wikitext using {{para|1}} or to a template call using {{para|call}}.

== Usage ==
<code><nowiki>{{</nowiki>#invoke:Map params|main|''parameters''<nowiki>}}</nowiki></code>

== Parameters ==
=== Input ===
* {{para|prefix''n''}} - The prefix of the parameters to process. All registered prefixes will be checked to determine if a number is present in the provided arguments. {{para|prefix1}} defaults to processing unnamed parameters.
* {{para|extra''n''}} - An extra parameter to pass to the wikitext or template being called. If the extra parameter is suffixed with a number (same as prefixed parameters but not checked to determine if a number is present), add the suffix <code>(i)</code>. For example, <code>style(i)</code>.
* {{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 it to be {{para|''prefix''}} rather than {{para|''prefix''1}}. Defaults to <code>yes</code>.

=== Map to ===
* {{para|1}} - The wikitext to map parameters to. Parameters are substituted with their number removed, i.e. {{para|item''n''}} becomes {{para|item}} etc. The parameter {{param|i}} is replaced with the current index and {{param|1}} is replaced with the current unnamed parameter (if applicable).
* {{para|call}} - Template to call. Parameters are passed with their number removed, i.e. {{para|item''n''}} becomes {{para|item}} etc. The parameter {{param|i}} is the current index and {{param|1}} is the current unnamed parameter (if applicable). Overrides {{para|1}}.

=== Concatenation ===
* {{para|sep}} / {{para|2}} - Separator to add between outputs. To preserve leading and tailing whitespace, {{para|2}} can be used instead, or {{para|1}} when {{para|call}} is being used.
* {{para|conj}} - Special separator to use before the final output. Outer spaces can be added with {{tlx|sp}} or <code>&amp;#32;</code>.

=== Advanced ===
* {{para|expand}} - Whether or not to expand templates, parser functions, extension tags, etc. after substituting parameters. This is most useful when {{para|1}} is used without {{tag|nowiki}} tags and can provide a slight performance advantage. Only relevant when using {{para|1}}. Defaults to <code>yes</code>.

== See also ==
{{Navbox
| title = [[Help:Infinite parameters|Infinite parameters]] modules
| group1 = Fixed format
| list1 = {{Plainlist|
* {{ml|Separated entries|main}} - Joins unnamed parameters prose-style
* {{ml|Enumerate|main}} - Enumerates parameters as a list
}}
| group2 = Arbitrary output
| list2 = {{Plainlist|
* {{ml|Map params|map}} - Maps parameters to arbitrary wikitext or a template
* {{ml|Params}} - Advanced module that enables modifying parameters before operating on them
* {{ml|ArgRest|main}} - Auto-detects incrementing parameters, no separator support
* {{ml|For nowiki|template}} - Equivalent to {{tl|For nowiki}} for template parameters
}}
}}

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->

}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>