Exibir código-fonte para Módulo:Hatnote/doc

<!---->
{{Alto uso|62094}}
{{Lua|Módulo:Yesno|Módulo:Arguments|Módulo:Format link}}
{{Utiliza TemplateStyles|Módulo:Hatnote/styles.css}}
Este é um meta-módulo que fornece várias funções para fazer [[Wikipédia:Livro de estilo#Cabeçalho geral|notas de cabeçalho]]. Ele implementa a predefinição {{Ligação para predefinição|Nota de cabeçalho}}, para uso em notas de cabeçalho no topo das páginas. Ele também contém várias funções auxiliares para uso em outros módulos de notas de cabeçalhos Lua.

== Uso a partir de texto wiki ==

As funções neste módulo não podem ser usadas diretamente a partir de "''#invoke''" e devem ser usadas por meio de predefinições. Consulte [[Predefinição:Nota de cabeçalho]] e [[Predefinição:Format link]] para obter a documentação.

== Uso a partir de outros módulos Lua ==

Para carregar este módulo a partir de outro módulo Lua, use o seguinte código.

<syntaxhighlight lang="lua">
local mHatnote = require('Módulo:Hatnote')
</syntaxhighlight>

Você pode então usar as funções conforme documentado abaixo.

=== Nota de cabeçalho ===

<syntaxhighlight lang="lua">
mHatnote._hatnote(s, options)
</syntaxhighlight>

Esta função formata a sequência{{Nre|nome=string|do inglês ''string''}} <var>s</var> como uma nota de cabeçalho. Isso inclui <var>s</var> nas marcações{{Nre|nome=tag|do inglês ''tag''}} {{Tag|div|params=class="hatnote"}}. As opções são fornecidas na tabela <var>options</var>. As opções incluem:
* <var>options.extraclasses</var> - uma série de classes extras para fornecer
* <var>options.selfref</var> - se não for nulo ou falso, adiciona a classe "selfref", usada para denotar auto-referências à Wikipedia (consulte [[Predefinição:Autorref]])
As folhas de estilos em cascatas (''CSS'') da classe de nota de cabeçalho são definidas em [[Módulo:Hatnote/styles.css]].

; Exemplo 1

<syntaxhighlight lang="lua">
mHatnote._hatnote('Isto é uma nota de cabeçalho.')
</syntaxhighlight>

Produz:
{{Tag|div|content=Isto é uma nota de cabeçalho.|params=class="hatnote"}}

É mostrado como:
{{Nota de cabeçalho|Isto é uma nota de cabeçalho.}}

; Exemplo 2

<syntaxhighlight lang="lua">
mHatnote._hatnote('Isto é uma nota de cabeçalho.', {extraclasses = 'boilerplate seealso', selfref = true})
</syntaxhighlight>

Produz:
{{Tag|div|content=Isto é uma nota de cabeçalho.|params=class="hatnote boilerplate seealso selfref"}}

É mostrado como:
{{Nota de cabeçalho|Isto é uma nota de cabeçalho.|extraclasses=boilerplate seealso|selfref=true}}

=== Encontrar a identificação do espaço nomeado ===

<syntaxhighlight lang="lua">
mHatnote.findNamespaceId(link, removeColon)
</syntaxhighlight>

Localiza a [[Wikipédia:Domínio|identificação do espaço nomeado]] da sequência{{Nre|nome=string}} <var>link</var>, que deve ser um nome de página válido, com ou sem o nome da seção. Esta função não funcionará se o nome da página estiver entre colchetes. Ao tentar analisar o nome do espaço nomeado, os dois-pontos são removidos do início da ligação{{Nre|nome=link|do inglês ''link''}}}} por padrão. Isso é útil se os usuários especificaram dois-pontos quando eles não são estritamente necessários. Se você não precisar verificar os dois-pontos iniciais, defina <var>removeColon</var> como "''false''".

;Exemplos:
: {{Código|mHatnote.findNamespaceId('Leão')|lua}} &rarr; 0
: {{Código|mHatnote.findNamespaceId('Categoria:Leões')|lua}} &rarr; 14
: {{Código|mHatnote.findNamespaceId(':Categoria:Leões')|lua}} &rarr; 14
: {{Código|mHatnote.findNamespaceId(':Categoria:Leões', false)|lua}} &rarr; 0 (o espaço nomeado é detectado como ":Categoria" em vez de "Categoria")

=== Fazer erro de texto wiki ===

<syntaxhighlight lang="lua">
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
</syntaxhighlight>

Formata a sequência{{Nre|nome=string}} <var>msg</var> como uma mensagem de erro texto wiki vermelha, com ligação{{Nre|nome=link}} opcional para uma página de ajuda <var>helpLink</var>. Normalmente esta função também adiciona {{Clc|!Predefinições de nota de cabeçalho com erros}}. Para suprimir a categorização, passe <code>false</code> como terceiro parâmetro da função (<code>addTrackingCategory</code>).

Exemplos:
:{{Código|mHatnote.makeWikitextError('ocorreu um erro')|lua}} &rarr; <strong class="error">Erro: ocorreu um erro.</strong>
:{{Código|mHatnote.makeWikitextError('ocorreu um erro', 'Predefinição:Exemplo#Erros')|lua}} &rarr; <strong class="error">Erro: ocorreu um erro ([[Predefinição:Exemplo#Erros|ajuda]]).</strong>

== Exemplos ==

Para um exemplo de como este módulo é usado em outros módulos Lua, consulte [[Módulo:Labelled list hatnote]].

== Notas ==
{{Reflist|group=lower-alpha}}
<includeonly>{{Testes outro||
[[Categoria:!Módulos Hatnote| ]]
[[Categoria:!Módulos que adicionam categorias de manutenção]]
}}</includeonly><noinclude>
[[en:Module:Hatnote/doc]]
</noinclude>