Editing Module:Check for unknown parameters/doc

<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

This module may be appended to a template to check for uses of unknown parameters.

== Usage ==
=== Basic usage ===
<pre>
{{#invoke:check for unknown parameters|check
|unknown=[[Category:Some tracking category]]
|arg1|arg2|...|argN}}
</pre>
or to sort the entries in the tracking category by parameter with a preview error message
<pre>
{{#invoke:check for unknown parameters|check
|unknown=[[Category:Some tracking category|_VALUE_]]
|preview=unknown parameter "_VALUE_"
|arg1|arg2|...|argN}}
</pre>
or for an explicit red error message
<pre>
{{#invoke:check for unknown parameters|check
|unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>
|arg1|arg2|...|argN}}
</pre>
or to use hidden error messages which can be viewed in the HTML source and a preview error message
<pre>
{{#invoke:check for unknown parameters|check
|unknown=<span class="error" style="display:none">HIDDEN ERROR: Usage of "_VALUE_" is not recognized</span>
|preview=unknown parameter "_VALUE_"
|arg1|arg2|...|argN}}
</pre>
Here, <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, are the known parameters.  Any parameter which is used, but not on this list, will cause the module to return whatever is passed with the <code>unknown</code> parameter.  The <code>_VALUE_</code> keyword, if used, will be changed to the name of the parameter.  This is useful for either sorting the entries in a tracking category, or for provide more explicit information.

By default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter.  To only track non-blank parameters use {{para|ignoreblank|1}}.
=== Regular expressions ===
This module supports regular expressions, which are useful when there are many known parameters which use a systematic pattern.  

== Example ==
<pre>
{{Infobox
| above = {{{name|}}}

| label1 = Height
| data1 = {{{height|}}}

| label2 = Weight
| data2 = {{{weight|}}}

| label3 = Website
| data3 = {{{website|}}}
}}<!-- 
  end infobox, start tracking
-->{{#invoke:Check for unknown parameters|check
| unknown = [[Category:Some tracking category|_VALUE_]]
| preview = unknown parameter "_VALUE_"
| name
| height | weight
| website
}}
</pre>

==Templates invoking this module==

The following is a list of templates which invoke this module, with the associated category for each.

{| class="wikitable sortable collapsible collapsed" style="font-size:88%"
!  colspan="2" class="unsortable" style="background-color:#ddd" | List of templates which invoke "Module:Check for unknown parameters"
|-
! Template !! Tracking/maintenance category
|-
| [[Template:Multiple issues]] || [[:Category:Pages using multiple issues with incorrect parameters]]
|}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here and interwikis go in Wikidata. -->

}}</includeonly>
Description	What you type	What you get
Italic	''Italic text''	Italic text
Bold	'''Bold text'''	Bold text
Bold & italic	'''''Bold & italic text'''''	*Bold & italic text*