模組:Check for unknown parameters/doc

此頁面為 Module:Check for unknown parameters 的說明文件

此模組文件被引用於約818,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 – 生成給定模板的參數名列表