Exibir código-fonte para Módulo:Labelled list hatnote/doc

<section begin=header />

{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|Testes}}|0|<includeonly>{{Module rating|pa}}{{Module rating|p}}{{alto risco|42000}}</includeonly>}}<!-- if pagename does not contain sandbox -->
<section end=header />
{{Module rating|protected}}
<!---->
{{Lua|Módulo:Hatnote|Módulo:Hatnote list|Módulo:Arguments|Módulo:Yesno}}

Este módulo fornece várias funções que facilitam a implementação de notas de cabeçalho{{Nre|nome=hatnotes|do inglês ''hatnotes''}} que assumem a forma de um rótulo na frente de uma lista de páginas, por exemplo, {{Nota de cabeçalho|Rótulo: [[A]], [[B]], e [[C]]}}
 
== Uso ==

=== labelledList ===
Invocar a função <code>labelledList()</code> é suficiente para implementar a maioria dessas predefinições:

<code><nowiki>{{#invoke:Labelled list hatnote|labelledList|Rótulo universal}}</nowiki></code>

ou

<code><nowiki>{{#invoke:Labelled list hatnote|labelledList|Rótulo singular|Rótulo plural}}</nowiki></code>

Por exemplo, fornecer "Ver também" em vez de "Rótulo universal" duplica a funcionalidade de {{Ligação para predefinição|VT}}, enquanto fornecer "Artigo principal" e "Artigos principais" em vez de "Rótulo singular" e "Rótulo plural" duplica a funcionalidade (espaço nomeado de artigos) de {{Ligação para predefinição|Artigo principal}}.

Se o terceiro e o quarto rótulos forem fornecidos, eles serão usados no caso em que qualquer uma das páginas de destino estiver fora do espaço nomeado do artigo, por exemplo, {{Ligação para predefinição|Artigo principal}} pode ser implementado assim:

<code><nowiki>{{#invoke:Labelled list hatnote|labelledList|Artigo principal|Artigos principais|Página principal|Páginas principais}}</nowiki></code>

=== preprocessDisplays ===
A função <code>preprocessDisplays()</code> pega uma lista bruta de argumentos e combina em qualquer argumento de exibição. Por exemplo, {{Tlx|VT|1|<nowiki>l1=Um</nowiki>}} inicialmente tem a tabela de argumentos <code><nowiki>{'1', ['l1'] = 'Um'}</nowiki></code>; esta tabela iria combiná-los na tabela <code><nowiki>{'1|Um'}</nowiki></code>. Ela substitui a inserção manual da barra vertical (por exemplo, {{Tlx|VT|<nowiki>1{{!}}2</nowiki>|<nowiki>l1=Um</nowiki>}} → <code><nowiki>{'1|Um'}</nowiki></code>) e comprime arranjos{{Nre|nome=array|do inglês ''arrays''}} esparsos se um parâmetro for ignorado ou deixado em branco.

Exemplo: <syntaxhighlight lang="lua">
local mLabelledList = require('Módulo:Labelled list hatnote')
local pages = mLabelledList.preprocessDisplays(args)
</syntaxhighlight>

=== _labelledList ===
Para módulos que precisam modificar um pouco a funcionalidade enquanto ainda a usam, <code>_labelledList()</code> fornece alguma flexibilidade. Leva três parâmetros:
# Uma lista de páginas, preferencialmente pré-processada e comprimida por <code>preprocessDisplays</code>
# Uma tabela de rótulos, onde o primeiro item é o rótulo singular ou universal e o segundo é um rótulo plural ou uma cópia do primeiro.
# Uma tabela de opções, preferencialmente contendo:
#* uma sequência{{Nre|nome=string|do inglês ''string''}} <code>template</code> com o título completo da predefinição. O padrão é o título deste módulo.
#* uma sequência{{Nre|nome=string}} de <code>category</code> (ou ''nil'') conforme obtida por <code>makeWikitextError</code> de [[Módulo:Hatnote]], para desabilitar opcionalmente as categorias de erro
#* uma sequência{{Nre|nome=string}} <code>selfref</code> (ou ''nil'') conforme obtida por <code>_hatnote</code> para habilitar a opção "''selfref''"

Exemplo: <syntaxhighlight lang="lua">
local mLabelledList = require('Módulo:Labelled list hatnote')
return mLabelledList._labelledList(pages, labels, options)
</syntaxhighlight>

==Erros==
Este módulo faz com que as predefinições baseadas nele produzam uma mensagem de erro se nenhum nome de página for fornecido como parâmetro de predefinição. Normalmente, elas devem levar de volta às seções "Erros" na documentação dessas predefinições. No entanto, se essas predefinições usarem um módulo com <code>_labelledList()</code> e não fornecerem um item <code>template</code> em sua tabela de opções, esse erro retornará aqui por padrão. O erro pode ser resolvido fornecendo pelo menos um parâmetro de nome de página válido para a predefinição em questão; o problema na predefinição pode ser corrigido fornecendo algum valor ao item <code>template</code> da tabela <code>_labelledList()</code> <code>options</code>.

==Notas ==
{{Reflist|group=lower-alpha}}

<includeonly>{{Testes outro||

[[Categoria:!Módulos Hatnote| ]]
}}</includeonly><noinclude>
[[en:Module:Labelled list hatnote/doc]]
</noinclude>