モジュール:Check for unknown parameters/doc

テンプレート:Module rating このモジュールはテンプレート内で不明な引数を検査するのに使われます。

使い方

基本的な使い方

{{#invoke:check for unknown parameters|check
|unknown=[[Category:何らかの追跡カテゴリ]]
|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までが既知とされる引数であり、名無し引数も|1|2|argname1|argname2|...のように指定できます。この呼び出しで記入されていない引数が指定されている場合、モジュールはunknown引数を返します。_VALUE_のキーワードは当該引数名を返します。このキーワードはエラーメッセージをより正確にしたり、追跡カテゴリでソートキーとして使ったりできます。

このモジュールは既定では空白と空白以外を指定した引数を区別しません。例えば、テンプレート:Paraとテンプレート:Paraは同じ扱いになります。空白以外を指定した引数のみ追跡する場合はテンプレート:Paraを指定してください。

このモジュールは既定では空白の名無し引数を追跡しません。例えば、テンプレート:Paraは無視されます。このような引数を追跡する場合はテンプレート:Paraを指定してください。

Luaパターン

このモジュールではLuaパターン（正規表現と似ている）が使えます。これは数多くの引数が何らかのパターンに従っているときに使えます。例えば、Template:Infobox3colsでは下記のように指定して、headerNUM、labelNUM、dataNUM、dataNUMa、dataNUMb、dataNUMc、rowcellstyleNUM（NUMは数字）といった形の引数をマッチしています。

| 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]*

例

{{Infobox
| above = {{{name|}}}
| label1 = 高さ
| data1 = {{{height|}}}
| label2 = 重さ
| data2 = {{{weight|}}}
| label3 = ウェブサイト
| data3 = {{{website|}}}
}}<!-- 
  Infoboxの終わり、追跡の始まり
-->{{#invoke:Check for unknown parameters|check
| unknown = {{main other|[[Category:何らかの追跡カテゴリ|_VALUE_]]}}
| preview = 不明な引数 "_VALUE_"
| name
| height | weight
| website
}}

このモジュールを使用しているテンプレート

検索をご参照ください。

関連項目

• Module:TemplatePar（ドイツ語版ウィキペディアより移入）
• en:Template:Parametersとen:Module:Parameters – テンプレートから引数名のリストを生成する
• he:Module:ParamValidator - TemplateDataに基づいて引数の検査を行う、ヘブライ語ウィキペディアのモジュール（英語の説明文あり）。下記を検査できます：
  • TemplateDataにない引数の使用
  • TemplateDataで非推奨と指定された引数
  • 引数内容の打ち間違い（主に「数字」とされる引数で数字以外が入力された場合）
  • TemplateDataで必須と指定された引数の未指定
  • 引数とそのエイリアスの両方が指定されている場合