Ver código fonte para Módulo:Template wrapper/doc

Esse módulo deve ser usado em modelos de ''wrapper'' ou envelope para permitir que esses modelos forneçam valores de parâmetro padrão e permitam que os editores passem parâmetros adicionais para o modelo de trabalho subjacente.

Ao gravar uma predefinição de wrapper, forneça a esse módulo todos os parâmetros padrão normalmente necessários para usar o modelo de wrapper em seu formato base. Em seguida, os editores usam o modelo de wrapper como está ou podem fornecer parâmetros adicionais de wrapper e canônicos. Qualquer um dos parâmetros canônicos suportados pelo modelo de trabalho pode ser adicionado ao modelo de wrapper ou fornecido pelos editores no espaço do artigo. Quando um editor fornece um parâmetro que possui um valor padrão no modelo de wrapper, o valor fornecido pelo editor substitui o padrão. Quando for necessário remover um parâmetro padrão, os editores podem definir o valor do parâmetro para a palavra-chave especial <code>unset</code>, o que fará com que este módulo de wrapper apague o valor padrão do modelo do wrapper para esse parâmetro. Este módulo descarta os parâmetros nomeados vazios.

Parâmetros posicionais não são normalmente passados para o modelo de trabalho. Definir {{parâmetro|_include-posicional|sim}} passará todos os parâmetros posicionais para o modelo de trabalho. Parâmetros posicionais não podem ser excluídos; Parâmetros posicionais podem ser <code>unset</code>.

Parâmetros que são usados somente pelo wrapper devem ser posicionais ({{parâmetro|{{var|n}}}}) ou listados em {{parâmetro|_exclude}} (uma lista separada por vírgulas de parâmetros nomeados). Este módulo não passará parâmetros <code>_excluded</code> para o modelo de trabalho.

== Uso ==

<code><nowiki>{{#invoke:</nowiki>{{BASEPAGENAME}}|wrap|_template={{var|working template}}|_exclude={{var|named parameter}}, {{var|named parameter}}, ...|_reuse={{var|named parameter}}, {{var|named parameter}}, ...|_alias-map={{var|alias parameter}}:{{var|canonical parameter}}|_include-positional=yes|&lt;{{var|default parameter}}>|&lt;{{var|default parameter}}>|...}}</code>

;Parâmetros de controle
: {{parâmetro|_template}} - (obrigatório) o nome, sem namespace, do modelo de trabalho (o modelo que é empacotado); veja § [[#_ template|_template]] abaixo
: {{parâmetro|_exclude}} - lista separada por vírgulas de nomes de parâmetros usados pelo modelo de wrapper que não devem ser passados para o template de trabalho; veja § [[#_ exclude|_exclude]] abaixo
: {{parâmetro|_reuse}} - lista separada por vírgulas de nomes canônicos que têm significado para o modelo de wrapper e para o modelo de trabalho; veja § [[#_ reuse|_reuse]] abaixo
: {{parâmetro|_alias-map}} - lista separada por vírgula de nomes de parâmetros de wrapper-modelo que devem ser tratados como aliases de parâmetros canônicos de modelos de trabalho especificados; veja § [[#_ alias-map|_alias-map]] abaixo
: {{parâmetro|_include-posicional}} - passa todos os parâmetros posicionais ao modelo de trabalho; veja § [[#_ include-posicional|_include-posicional]] abaixo

Definições
: parâmetro canonical - um parâmetro suportado e usado pelo modelo de trabalho
: parâmetro wrapper - um parâmetro usado pelo modelo wrapper; pode fornecer dados para parâmetros canônicos ou controlar outros aspectos do modelo de wrapper
: parâmetro alias - um parâmetro de wrapper que é contextualmente significativo para o modelo de wrapper, mas deve ser renomeado para um parâmetro canônico para uso pelo modelo de trabalho
: parâmetro reused - um parâmetro que é compartilhado pelos modelos wrapper e que funciona e foi modificado pelo template wrapper
: parâmetro padrão - um parâmetro canônico dado um valor padrão no modelo de wrapper

{|class="nowrap"
|+processamento de parâmetros
!style="border:1px solid black"|wrapper<br />template !! !!style="border:1px solid black" colspan="11"|Module:Template wrapper !! !! style="border:1px solid black"|working<br />predefinição
|-
|style="border: 1px solid black;"|{{parâmetro|plain=yes|{{var|canonical parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="border: 2px solid black;" rowspan="5"|filter<br />exclued<br />parameters||||style="border: 2px solid black;" rowspan="10"|working<br />template
|-
|style="border: 1px solid black;"|{{parâmetro|plain=yes|{{var|wrapper parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;
|-
|&nbsp;||||style="border: 1px solid black;"|{{parâmetro|plain=yes|[[#_exclude|_exclude]]}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||&nbsp;→&nbsp;
|-
|&nbsp;||||style="border: 1px solid black;"|{{parâmetro|plain=yes|[[#_include-positional|_include-positional]]}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;
|-
|&nbsp;||||style="border: 1px solid black;"|{{parâmetro|plain=yes|[[#_alias-map|_alias-map]]}}||&nbsp;→&nbsp;||style="border: 2px solid black;" rowspan="3"|convert alias<br />parameters to<br />canonical<br />parameters||&nbsp;→&nbsp;||style="border: 1px solid black;" rowspan="2"|{{parâmetro|plain=yes|{{var|canonical parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||||&nbsp;→&nbsp;
|-
|&nbsp;||||||||&nbsp;→&nbsp;||&nbsp;→&nbsp;||style="border: 2px solid black;" rowspan="4"|modify<br />reused<br />canonical<br />parameters
|-
|style="border: 1px solid black;"|{{parâmetro|plain=yes|{{var|alias parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||||||||&nbsp;→&nbsp;||style="border: 1px solid black;"|{{parâmetro|plain=yes|{{var|reused parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––→||&nbsp;→&nbsp;
|-
|&nbsp;||||style="border: 1px solid black;"|{{parâmetro|plain=yes|[[#_reuse|_reuse]]}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;
|-
|style="border: 1px solid black;"|{{parâmetro|plain=yes|{{var|canonical parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;
|-
|&nbsp;||||style="border: 1px solid black;"|{{parâmetro|plain=yes|{{var|default parameters}}}}||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––––––→||&nbsp;→&nbsp;||style="text-align: center;"|–––→||&nbsp;→&nbsp;
|}

== Detalhes do parâmetro ==
=== _ template ===
O único parâmetro necessário, {{parâmetro|_template}} fornece o nome, sem namespace, do modelo de trabalho (o modelo que é empacotado). Se este parâmetro for omitido, o módulo: invólucro de modelo emitirá a mensagem de erro:
:<span style="font-size:100%" class="error"><code style="color:inherit; border:inherit; padding:inherit;">&#124;_template=</code> em falta ou vazio</span>

=== _ alias-map ===
{{parâmetro|alias-map}} usa uma lista separada por vírgula dos parâmetros do modelo de wrapper que devem ser tratados como aliases dos parâmetros canônicos do modelo de trabalho especificado. Cada elemento de mapeamento da lista tem o formulário:
: <code>& lt; {{var|from}}>: & lt; {{var|to}}></code> - onde: <code>& lt; {{var|de}}></code> é um nome de parâmetro do wrapper e <code>& lt; {{var|to}}></code> é um nome de parâmetro canônico
Neste exemplo, pode ser preferível que um modelo de wrapper use {{parâmetro|assessor}}, que pode ser desconhecido para o modelo de trabalho, mas o modelo de trabalho pode ter um equivalente {{parâmetro|autor}} no <code><nowiki>{{#invoke:}}</nowiki></code> nós escreveríamos:
: {{parâmetro|_alias-map|assessor:autor}}
Parâmetros posicionais também podem ser mapeados para parâmetros canônicos:
: {{parâmetro|_alias-map|1:autor, 2:titulo, 3:lingua}}
Os parâmetros do wrapper enumerados podem ser mapeados para parâmetros canônicos enumerados usando o especificador <code>#</code> enumerator:
: {{parâmetro|_alias-map|assessor#:autor#}}
Dado o exemplo acima, {{parâmetro|assessor2}} será mapeado para {{parâmetro|autor2}}; Além disso, {{parâmetro|assessor}} e {{parâmetro|assessor1}} serão mapeados para {{parâmetro|autor1}}

Vários parâmetros de wrapper podem mapear para um único parâmetro canônico:
: {{parâmetro|_alias-map|1: autor, avaliador: autor}}
Os parâmetros do wrapper listados em {{parâmetro|alias-map}} não são passados para o modelo de trabalho. Mapeamento de parâmetros posicionais quando {{parâmetro|_include-posicional|sim}} pode dar resultados indesejáveis. {{parâmetro|_alias-map|1:autor}} e {{parâmetro|_include-posicional|yes}} fará com que todos os outros parâmetros posicionais sejam passados para o modelo de trabalho como é: wrapper template <code><nowiki>{{{2}}}</nowiki></code> torna-se o template de trabalho <code><nowiki>{{{2}}}</nowiki></code>, etc; O template de trabalho não vai ter <code><nowiki>{{{1}}}</nowiki></code>, mas ele terá {{parâmetro|author}}.

=== _ reuse ===
{{parâmetro|_reuse}} usa uma lista separada por vírgula de parâmetros canônicos que têm significado para o modelo de wrapper e para o modelo de trabalho

Nos casos mais simples, um parâmetro canônico enviado para o modelo de wrapper substitui um parâmetro padrão fornecido no modelo de wrapper. Às vezes, um parâmetro de wrapper é o mesmo que um parâmetro canônico e o modelo de wrapper precisa modificar o valor do parâmetro antes de ser passado para o modelo de trabalho. Neste exemplo, {{parâmetro|title}} é um parâmetro de wrapper e um parâmetro canônico que o modelo de wrapper precisa modificar antes de passar para o modelo de trabalho. Para fazer isso, primeiro escrevemos:
: {{parâmetro|_reuse|title}}
então, no <code><nowiki>{{# invoke: Template wapper|wrap|_template = ...|...}} do template do wrapper </nowiki></code> escrevemos:
: {{parâmetro|title|Modificado <nowiki>{{{title}}}</nowiki>}}

Parâmetros _reused não podem ser substituídos.

=== _ exclude ===
{{parâmetro|_exclude}} usa uma lista separada por vírgula de parâmetros usados pelo modelo de wrapper que não devem ser passados para o modelo de trabalho. Essa lista se aplica a todos os parâmetros de wrapper e canônicos (incluindo os parâmetros canônicos que são renomeados para os parâmetros de alias) recebidos do modelo de wrapper.

Como exemplo, um modelo de wrapper pode usar {{parâmetro|id}} para fornecer uma parte do valor atribuído ao parâmetro padrão {{parâmetro|url}}, portanto, poderíamos escrever:
: {{parâmetro|_exclude|id}}
então, no <code><nowiki>{{# invoke:Template wapper|wrap|_template = ...|...}} do template do wrapper </nowiki></code> escrevemos:
: {{parâmetro|url|<nowiki>https://example.com/{{{id}}}</nowiki>}}
O valor {{parâmetro|url}} modificado é passado para o template de trabalho, mas {{parâmetro|id}} e seu valor não é.

Os parâmetros _reused e default não podem ser excluídos

=== _ include-posicional ===
{{parâmetro|_include-posicional}} é um parâmetro booleano que usa apenas um valor: <code>yes</code>; o padrão (vazio, ausente) é <code>no</code> (parâmetros posicionais normalmente excluídos). Quando definido como <code>yes</code>, o wrapper Module: Template passará todos os parâmetros posicionais para o modelo de trabalho.

Veja também § [[#_ alias-map|_alias-map]].

=== Substituindo parâmetros padrão ===
Os editores podem substituir os parâmetros padrão simplesmente definindo o parâmetro padrão para o valor desejado no modelo de wrapper. Este módulo ignora os parâmetros vazios (aqueles parâmetros que são nomeados, mas que não possuem um valor atribuído). Quando for desejável sobrescrever um parâmetro padrão para nenhum valor, use a palavra-chave especial <code>unset</code>. Os parâmetros padrão com este valor são passados para o modelo de trabalho como parâmetros vazios (sem valor atribuído).

Parâmetros _reused não podem ser <code>unset</code> ou sobrescritos.

== Ajuda de depuração ==
Este módulo tem dois pontos de entrada. Um modelo de wrapper pode usar um módulo <code><nowiki>{{#invoke:}}</nowiki></code> escrito assim:
: <code><nowiki>{{#invoke:</nowiki>{{BASEPAGENAME}}|<nowiki>{{#if:{{{_debug|}}}|lista|embrulhar}}</nowiki>|_template =<{{var|modelo de trabalho}}>|_exclude = _debug, ...|...}}</code>
onde o parâmetro de wrapper {{parâmetro|_debug}}, definido como qualquer valor, fará com que o módulo renderize a chamada para o modelo de trabalho sem realmente chamar o modelo de trabalho.

Como exemplo, {{tlx|citar wikisource}} é um modelo de wrapper que usa {{tlx|citation}} como modelo de trabalho. O {{tld|citar wikisource}} aceita parâmetros posicionais, mas {{tld|citation}} não faz com que o modelo do wrapper converta os parâmetros posicionais em parâmetros nomeados, usando o parâmetro {{parâmetro|_alias-map}}:
: <syntaxhighlight lang = "moin"> {{#invoke:Template wapper|{{# if: {{{{_default|}}}|list|wrap}}|_template = citation
 |_exclude = ..., _debug <! - detalhes desnecessários omitidos ->
 |_alias-map = 1: title, 2: author, 3: language </ syntaxhighlight>
Este exemplo usa parâmetros posicionais e define {{parâmetro|_debug|yes}} para mostrar que o modelo {{tld|citation}} está formado corretamente:
: <code><nowiki>{{citar wikisource|Sentido e sensibilidade|Jane Austen|es|_debug = sim}}</nowiki></code>
:: {{citar wikisource|Sentido e sensibilidade|Jane Austen|es|_debug = sim}}
e, com {{parâmetro|_debug}} não definido:
: <code><nowiki>{{citar wikisource|Sentido e sensibilidade|Jane Austen|es|_debug =}}</nowiki></code>
:: {{citar wikisource|Sentido e sensibilidade|Jane Austen|es|_debug =}}
O nome {{parâmetro|_debug}} é escolhido aqui por conveniência, mas pode ser qualquer coisa desde que corresponda ao <code><nowiki>{{#if:}}</nowiki></code> no <code><nowiki>{{#invoke:}}</nowiki></code>.
<includeonly>{{Testes outro||
<!-- Categorias abaixo desta linha, por favor; interwikis no Wikidata -->
[[Categoria:!Módulos]]
}}</includeonly>