模組:Check for unknown parameters/doc

这是Module:Check for unknown parameters的文档页面

此模块文档被引用於約756,000個頁面。
為了避免造成大規模的影響，所有對此模块文档的編輯應先於沙盒或測試樣例上測試。
測試後無誤的版本可以一次性地加入此模块文档中，但是修改前請務必於討論頁發起討論。

模板引用數量會自動更新。

此模块文档已被保护。此为高度可见模块文档，其已用于大量条目或被频繁替换引用。由于破坏或失误会影响诸多页面，即便细小的改动也可能导致大量服务器负载，因此已被保护，不可编辑。

此模块使用Lua语言：

Module:If preview

此模块附于模板来检测未知参数的使用。

用法

基本用法

{{#invoke:check for unknown parameters|check
|unknown=[[分类:某追踪分类]]
|arg1|arg2|...|argN}}

或使用带预览错误信息的参数来排序追踪分类中的条目

{{#invoke:check for unknown parameters|check
|unknown=[[Category:某追踪分类|_VALUE_]]
|preview=未知参数“_VALUE_”
|arg1|arg2|...|argN}}

或直接显示红色错误信息

{{#invoke:check for unknown parameters|check
|unknown=<span class="error">不好意思，_VALUE_是什么？</span>
|arg1|arg2|...|argN}}

以上代码中，arg1、arg2、...、argN为已知参数。任何被使用的未列出参数都会导致模块返回unknown参数中的内容。这样有利于排序追踪列表中的条目，亦有利于提供具体信息。

默认情况下，模块不区分已定义但留空的参数和非空参数。要仅追踪非空参数，请使用|ignoreblank=1。

默认情况下，模块忽略空白位置参数。要追踪空白位置参数，请使用|showblankpositional=1。

正则表达式

本模块支持正则表达式，可在使用大量有规律格式的参数时使用。如，template:infobox3cols中有

| regexp1 = header[%d][%d]*
| regexp2 = label[%d][%d]*
| regexp3 = data[%d][%d]*[abc]?
| regexp4 = class[%d][%d]*[abc]?
| regexp5 = rowclass[%d][%d]*
| regexp6 = rowstyle[%d][%d]*
| regexp7 = rowcellstyle[%d][%d]*

即可匹配所有headerNUM、labelNUM、dataNUM、dataNUMa、dataNUMb、dataNUMc、...、rowcellstyleNUM格式的参数，其中NUM为一段数字。

举例

{{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
}}

另请参阅

Module:Check for unknown parameters 2 – 与英文维基百科同步的版本
module:TemplatePar（来自德语维基百科）
Template:Parameters 与 Module:Parameters – 生成给定模板的参数名列表