Módulo:Hatnote/doc

{{#invoke:Message box|ombox}} {{#invoke:Lua banner|main}} {{#invoke:Utiliza TemplateStyles|main}} Este é um meta-módulo que fornece várias funções para fazer notas de cabeçalho. Ele implementa a 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 s como uma nota de cabeçalho. Isso inclui s nas marcações <div class="hatnote">...</div>. As opções são fornecidas na tabela options. As opções incluem:

• options.extraclasses - uma série de classes extras para fornecer
• options.selfref - 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: <div class="hatnote">Isto é uma nota de cabeçalho.</div>

É mostrado como: {{#invoke:Hatnote|hatnote}}

Exemplo 2

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

Produz: <div class="hatnote boilerplate seealso selfref">Isto é uma nota de cabeçalho.</div>

É mostrado como: {{#invoke:Hatnote|hatnote}}

Encontrar a identificação do espaço nomeado

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

Localiza a identificação do espaço nomeado da sequência link, 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}} 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 removeColon como "false".

Exemplos

<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId('Leão')</syntaxhighlight> → 0

<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId('Categoria:Leões')</syntaxhighlight> → 14

<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId(':Categoria:Leões')</syntaxhighlight> → 14

<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId(':Categoria:Leões', false)</syntaxhighlight> → 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 msg como uma mensagem de erro texto wiki vermelha, com ligação opcional para uma página de ajuda helpLink. Normalmente esta função também adiciona Categoria:!Predefinições de nota de cabeçalho com erros (0). Para suprimir a categorização, passe false como terceiro parâmetro da função (addTrackingCategory).

Exemplos:

<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.makeWikitextError('ocorreu um erro')</syntaxhighlight> →

<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.makeWikitextError('ocorreu um erro', 'Predefinição:Exemplo#Erros')</syntaxhighlight> →

Exemplos

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

Notas

{{#invoke:Check for unknown parameters|check|unknown=|preview=Página que usam Predefinição:Reflist com parâmetro desconhecido "_VALUE_"|ignoreblank=y| 1 | colwidth | group | liststyle | refs | largcol | larguracol | grupo | estilolista | listaestilo }}