Módulo:Testes/Gkiyoshinishimoto/Hatnote/doc

Este é um meta-módulo que fornece várias funções para fazer notas de cabeçalho. Ele implementa a predefinição {{Teste/Gkiyoshinishimoto/Hatnote}}, 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:Teste/Gkiyoshinishimoto/Hatnote e Predefinição:Teste/Gkiyoshinishimoto/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.

local mHatnote = require('Módulo:Testes/Gkiyoshinishimoto/Hatnote')

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

Nota de cabeçalho

mHatnote._hatnote(s, options)

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:Teste/Gkiyoshinishimoto/Selfref)

As folhas de estilos em cascatas (F.E.C.) da classe de nota de cabeçalho são definidas em Módulo:Testes/Gkiyoshinishimoto/Hatnote/styles.css.

Exemplo 1

mHatnote._hatnote('Isto é uma nota de cabeçalho.')

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

É mostrado como:

Isto é uma nota de cabeçalho.

Exemplo 2

mHatnote._hatnote('Isto é uma nota de cabeçalho.', {extraclasses = 'boilerplate seealso', selfref = true})

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

É mostrado como:

Isto é uma nota de cabeçalho.

Encontrar a identificação do espaço nomeado

mHatnote.findNamespaceId(link, removeColon)

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

mHatnote.findNamespaceId('Leão') → 0

mHatnote.findNamespaceId('Categoria:Leões') → 14

mHatnote.findNamespaceId(':Categoria:Leões') → 14

mHatnote.findNamespaceId(':Categoria:Leões', false) → 0 (o espaço nomeado é detectado como ":Categoria" em vez de "Categoria")

Fazer erro de texto wiki

mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)

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 Predefinição:Teste/Gkiyoshinishimoto/Clc. Para suprimir a categorização, passe false como terceiro parâmetro da função (addTrackingCategory).

Exemplos:

mHatnote.makeWikitextError('ocorreu um erro') →

mHatnote.makeWikitextError('ocorreu um erro', 'Predefinição:Teste/Gkiyoshinishimoto/Exemplo#Erros') →

Exemplos

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