Module:Check for clobbered parameters/doc
Jump to navigation
Jump to search
This is the documentation page for Module:Check for clobbered parameters
 | This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
 | This Lua module is used on approximately 586,000 pages, or roughly 6118% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module depends on the following other modules: |
This module may be appended to a template to check for uses of tuples of conflicting parameters.
Usage
Basic usage
{{#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}}
Here, (arg1a, arg1b), (arg2a, arg2b, arg2c), are tuples of the conflicting parameters.
By default, the module ignores blank parameters which is useful for {{if empty}} chains of parameters. For nested chains of parameters, use |nested=1 to consider blank parameters as well.
By default, the delimiter for the tuples is ; but this can be changed with |delimiter=.
The value of |template= is used to for the text of the preview warning message. When omitted, the module will use a generic message.
Example 1
{{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
}}
Example 2
{{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
}}
See also
- Module:Check for unknown parameters
- Module:Check for deprecated parameters
- Template:Conflicting parameters category (for use on category pages)
This module (and the documentation) are based (partially) on Module:Check for clobbered parameters/doc from the free encyclopedia wikipedia and is licensed under GNU license for free documentation and the Creative Commons Attribution/Share Alike. On wikipedia there is a List of authors accessible. More about importing from wikipedia on page Imedwiki:Importing from wikipedia.