Módulo:Hatnote/doc
 | Esta é uma subpágina de documentação para o Módulo:Hatnote. Ela contém informações sobre o seu uso, categorias, bem como todo o conteúdo que não faz parte do módulo original. |
 | Este módulo depende dos seguintes outros módulos: |
 | Este módulo utiliza TemplateStyles: |
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
[editar código-fonte]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
[editar código-fonte]Para carregar este módulo a partir de outro módulo Lua, use o seguinte código.
local mHatnote = require('Módulo:Hatnote')
Você pode então usar as funções conforme documentado abaixo.
Nota de cabeçalho
[editar código-fonte]mHatnote._hatnote(s, options)
Esta função formata a sequência[a] s como uma nota de cabeçalho. Isso inclui s nas marcações[b] <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
mHatnote._hatnote('Isto é uma nota de cabeçalho.')
Produz:
<div class="hatnote">Isto é uma nota de cabeçalho.</div>
É mostrado como:
- 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:
Encontrar a identificação do espaço nomeado
[editar código-fonte]mHatnote.findNamespaceId(link, removeColon)
Localiza a identificação do espaço nomeado da sequência[a] 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[c]}} 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')→ 0mHatnote.findNamespaceId('Categoria:Leões')→ 14mHatnote.findNamespaceId(':Categoria:Leões')→ 14mHatnote.findNamespaceId(':Categoria:Leões', false)→ 0 (o espaço nomeado é detectado como ":Categoria" em vez de "Categoria")
Fazer erro de texto wiki
[editar código-fonte]mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
Formata a sequência[a] msg como uma mensagem de erro texto wiki vermelha, com ligação[c] 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 (4). Para suprimir a categorização, passe false como terceiro parâmetro da função (addTrackingCategory).
Exemplos:
mHatnote.makeWikitextError('ocorreu um erro')→ Erro: ocorreu um erro.mHatnote.makeWikitextError('ocorreu um erro', 'Predefinição:Exemplo#Erros')→ Erro: ocorreu um erro (ajuda).
Exemplos
[editar código-fonte]Para um exemplo de como este módulo é usado em outros módulos Lua, consulte Módulo:Labelled list hatnote.