Editing Module:Check for clobbered parameters/doc

{{Module rating |beta}}
{{high-use|111137}}
{{Lua|Module:If preview}}
This module may be appended to a template to check for uses of tuples of conflicting parameters.

== Usage ==
=== Basic usage ===
<syntaxhighlight lang="wikitext">
{{#invoke:Check for clobbered parameters|check
|nested=1
|template=Some template name
|cat={{main other|Category:Some tracking category}}
|arg1a; arg1b|arg2a; arg2b; arg2c|...|argNa; argNb}}
</syntaxhighlight>
Here, (<code>arg1a</code>, <code>arg1b</code>), (<code>arg2a</code>, <code>arg2b</code>, <code>arg2c</code>), are tuples of the conflicting parameters.

By default, the module ignores blank parameters which is useful for {{tl|if empty}} chains of parameters.  For nested chains of parameters, use {{para|nested|1}} to consider blank parameters as well.

By default, the delimiter for the tuples is <code>;</code> but this can be changed with {{para|delimiter}}.

The value of {{para|template}} is used to for the text of the preview warning message.  When omitted, the module will use a generic message.

== Example 1 ==
<syntaxhighlight lang="wikitext">
{{Infobox
| above = {{{name|}}}

| label1 = Founder{{#if:{{{founders|}}}|s}}
| data1 = {{if empty| {{{founders|}}} | {{{founder|}}} }}

| label2 = Headquarters
| data2 = {{if empty| {{{headquarters|}}} | {{{hq|}}} | {{{location|}}} }}

}}<!-- 
  end infobox, start tracking
-->{{#invoke:Check for clobbered parameters|check
| template = Infobox example
| cat = {{main other|Category:Pages using infobox example with conflicting parameters}}
| founders; founder
| headquarters; hq; location
}}</syntaxhighlight>

== Example 2 ==
<syntaxhighlight lang="wikitext">
{{Infobox
| above = {{{name|}}}

| label1 = Founder(s)
| data1 = {{{founders|{{{founder|}}}}}}

| label2 = Headquarters
| data2 = {{{headquarters|{{{hq|{{{location|}}}}}}}}}

}}<!-- 
  end infobox, start tracking
-->{{#invoke:Check for clobbered parameters|check
| nested = 1
| template = Infobox example
| cat = {{main other|Category:Pages using infobox example with conflicting parameters}}
| founders; founder
| headquarters; hq; location
}}</syntaxhighlight>

==See also==
* [[Module:Check for unknown parameters]]
* [[Module:Check for deprecated parameters]]
* [[Module:Params]]
* [[Template:Conflicting parameters category]] (for use on category pages)

<includeonly>{{sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Modules that add a tracking category]]
[[Category:Template metamodules]]
}}</includeonly>
<noinclude>
[[Category:Module documentation pages]]
</noinclude>