「モジュール:Check for unknown parameters/doc」を編集中 (節単位)

== 使い方 ==
=== 基本的な使い方 ===
<pre>
{{#invoke:check for unknown parameters|check
|unknown=[[Category:何らかの追跡カテゴリ]]
|arg1|arg2|...|argN}}
</pre>
または、追跡カテゴリでのソートキーを追加しつつプレビューで警告メッセージを表示させます：
<pre>
{{#invoke:check for unknown parameters|check
|unknown=[[Category:何らかの追跡カテゴリ|_VALUE_]]
|preview=不明な引数 "_VALUE_"
|arg1|arg2|...|argN}}
</pre>
または赤文字でエラーを表示します：
<pre>
{{#invoke:check for unknown parameters|check
|unknown=<span class="error">_VALUE_ 引数が不明です</span>
|arg1|arg2|...|argN}}
</pre>
上記の例において、<code>arg1</code>、<code>arg2</code>から<code>argN</code>までが既知とされる引数であり、名無し引数も<code><nowiki>|1|2|argname1|argname2|...</nowiki></code>のように指定できます。この呼び出しで記入されていない引数が指定されている場合、モジュールは<code>unknown</code>引数を返します。<code>_VALUE_</code>のキーワードは当該引数名を返します。このキーワードはエラーメッセージをより正確にしたり、追跡カテゴリでソートキーとして使ったりできます。

このモジュールは既定では空白と空白以外を指定した引数を区別しません。例えば、{{para|foo|x}}と{{para|foo}}は同じ扱いになります。空白以外を指定した引数のみ追跡する場合は{{para|ignoreblank|1}}を指定してください。

このモジュールは既定では空白の名無し引数を追跡しません。例えば、{{para|2}}は無視されます。このような引数を追跡する場合は{{para|showblankpositional|1}}を指定してください。

=== Luaパターン ===
このモジュールでは[[:mw:Extension:Scribunto/Lua reference manual#Patterns|Luaパターン]]（[[正規表現]]と似ている）が使えます。これは数多くの引数が何らかのパターンに従っているときに使えます。例えば、[[Template:Infobox3cols]]では下記のように指定して、<code>headerNUM</code>、<code>labelNUM</code>、<code>dataNUM</code>、<code>dataNUMa</code>、<code>dataNUMb</code>、<code>dataNUMc</code>、<code>rowcellstyleNUM</code>（NUMは数字）といった形の引数をマッチしています。
<pre>
| 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]*
</pre>