Exibir código-fonte para Módulo:Check for unknown parameters/doc

<section begin=header />
{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|Testes}}|0|<includeonly>{{Module rating|p}}{{Alto risco|445000}}</includeonly>}}<!-- if pagename does not contain sandbox -->
<section end=header />
{{Lua|Módulo:If preview|noprotcat=yes}}

Este módulo pode ser anexado a uma predefinição para verificar o uso de parâmetros desconhecidos. Diferentemente de muitos outros módulos, este módulo ''não'' é implementado por uma predefinição.

== Uso ==
=== Uso básico ===
<syntaxhighlight lang="wikitext">
{{#invoke:Check for unknown parameters|check
|unknown=[[Categoria:Alguma categoria de manutenção]]
|arg1|arg2|arg3|argN}}
</syntaxhighlight>
ou para classificar as entradas na categoria de manutenção por parâmetro com uma mensagem de erro de visualização
<syntaxhighlight lang="wikitext">
{{#invoke:Check for unknown parameters|check
|unknown=[[Categoria:Alguma categoria de manutenção|_VALUE_]]
|preview=parâmetro desconhecido "_VALUE_"
|arg1|arg2|...|argN}}
</syntaxhighlight>
ou para uma mensagem de erro vermelha explícita
<syntaxhighlight lang="wikitext">
{{#invoke:Check for unknown parameters|check
|unknown=<span class="error">Desculpe, eu não reconheço _VALUE_</span>
|arg1|arg2|...|argN}}
</syntaxhighlight>
Aqui, <code>arg1</code>, <code>arg2</code>, ..., <code>argN</code>, são os parâmetros conhecidos. Parâmetros sem nome (posicionais) também podem ser adicionados: <code><nowiki>|1|2|nomedoarg1|nomedoarg2|...</nowiki></code>. Qualquer parâmetro que for usado, mas não estiver nesta lista, fará com que o módulo retorne o que for passado com o parâmetro <code>unknown</code>. A palavra-chave <code>_VALUE_</code>, se for utilizada, será alterada para o nome do parâmetro. Isso é útil tanto para classificar as entradas em uma categoria de rastreamento quanto para fornecer informações mais explícitas.

Por padrão, o módulo não faz distinção entre um parâmetro definido, mas em branco, e um parâmetro que não está em branco. Isto é, tanto {{Parâmetro|foo|x}} quanto {{Parâmetro|foo}}, se não forem listados, são reportados. Para rastrear somente parâmetros que não estiverem em branco, use {{Parâmetro|ignoreblank|1}}.

Por padrão, o módulo ignora os parâmetros posicionais em branco. Ou seja, um {{Parâmetro|2}} que não estiver listado é ignorado. Para ''incluir'' parâmetros posicionais em branco no rastreamento use {{Parâmetro|showblankpositional|1}}.

=== Padrões ''Lua'' ===
Este módulo suporta [[:mw:Extension:Scribunto/Lua reference manual/pt-br#Patterns|padrões ''Lua'']] (semelhante a [[expressão regular|expressões regulares]]), que são úteis quando existem muitos parâmetros conhecidos que usam um padrão sistemático. Por exemplo, <code>[[:en:Module:Infobox3cols|Infobox3cols]]</code> usa
<syntaxhighlight lang="lua">
		regexp1 = "header[%d]+",
		regexp2 = "label[%d]+",
		regexp3 = "data[%d]+[abc]?",
		regexp4 = "class[%d]+[abc]?",
		regexp5 = "rowclass[%d]+",
		regexp6 = "rowstyle[%d]+",
		regexp7 = "rowcellstyle[%d]+",
</syntaxhighlight>
para corresponder a todos os parâmetros do formulário <code>headerNUM</code>, <code>labelNUM</code>, <code>dataNUM</code>, <code>dataNUMa</code>, <code>dataNUMb</code>, <code>dataNUMc</code>, ..., <code>rowcellstyleNUM</code>, onde NUM é uma sequência (''string'') de dígitos.

== Exemplo ==
<syntaxhighlight lang="wikitext">
{{Infobox
| above = {{{name|{{{nome|}}}}}}

| label1 = Altura
| data1 = {{{height|{{{altura|}}}}}}

| label2 = Peso
| data2 = {{{weight|{{{peso|}}}}}}

| label3 = Website
| data3 = {{{website|}}}
}}<!-- 
  Término da caixa de informações, início do rastreamento
-->{{#invoke:Check for unknown parameters|check
| unknown = {{Testes outro|[[Categoria:Alguma categoria de manutenção|_VALUE_]]}}
| preview = parâmetro "_VALUE_" desconhecido
| name | nome 
| height | altura 
| weight | peso 
| website
}}
</syntaxhighlight>

== Chamada de dentro de código ''Lua'' ==
Veja o final de [[:en:Module:Rugby box|Rugby box]] para um exemplo simples ou [[:en:Module:Infobox3cols|Infobox3cols]] ou [[:en:Module:Flag|Flag]] para exemplos mais complicados.

== Ver também ==
* [[Módulo:Check for clobbered parameters]] – módulo semelhante que verifica parâmetros conflitantes
* [[Módulo:Check for conflicting parameters]] – módulo semelhante que verifica parâmetros conflitantes

<includeonly>{{Testes outro||
[[Categoria:!Módulos que adicionam categorias de manutenção]]
}}</includeonly><noinclude>
[[en:Module:Check for unknown parameters/doc]]
</noinclude>