Módulo:Principal/doc

Esta é uma subpágina de documentação para o Módulo:Principal.
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.

Descrição[editar código-fonte]

Este módulo produz uma ligação para um artigo principal ou artigos. Ele utiliza a predefinição {{artigo principal}}. Normalmente, ela produz uma ligação como "Artigo principal: A". Se for utilizado no domínio categoria, ele produz um link como "O artigo principal para esta categoria é A". É possível definir vários artigos, e neste caso as palavras em plural são utilizadas automaticamente. Se o primeiro link não é um artigo, o módulo utiliza as palavras "Página principal" em vez de "Artigo principal".

Utilização de texto wiki[editar código-fonte]

Este módulo não pode ser acedido diretamente de #invoke. Em vez disso, ele só pode utilizado através da predefinição {{artigo principal}}. Por favor ver a página da predefinição para a sua documentação.

Utilização de outros módulos Lua[editar código-fonte]

Carregue o módulo:

local mMain = require('Módulo:Principal')

Você pode utilizar a função _main desta maneira:

mMain._main(args, options)

O parâmetro args que segue options são uma lista de cadeias de texto para links de páginas; se eles utilizam valores por medida, cada cadeia deve ser preprocessada numa cadeia singular com pipe (e.g. página|valor mostrado). Os links de categoria ou de ficheiro são automaticamente escapados utilizando o colon trick. Se um link tem um nome de seção, e não foram definidos valores de impressão, as ligações são automaticamente formatados como página § seção, em vez do valor padrão da MediaWiki página#seção.

A tabela de opções options pode ser usada para configurar o resultado da função. Atualmente, a única opção disponível é "selfref", que é utilizada quando se mostra uma auto referência para a Wikipédia. Para configura esta opção, utilize {selfref = true}. (Ver a predefinição {{selfref}} para mais detalhes sobre auto referências.)

Exemplo 1[editar código-fonte]

mMain._main({'A'})

Mostra:

<div role="note" class="hatnote relarticle mainarticle">Artigo principal: [[A]]</div>

Mostra-se como:

Exemplo 2[editar código-fonte]

mMain._main({'Wikipédia:Categoria', 'Ajuda:Categoria', 'Categoria:Categorias'})

Mostra:

<div role="note" class="hatnote relarticle mainarticle">Páginas principais: [[Wikipédia:Categoria]], [[Ajuda:Categoria]] e [[:Categoria:Categorias]]</div>

Mostra-se como:

Exemplo 3[editar código-fonte]

mMain._main({'A|a letra "A"', 'B|a letra "B"', 'C|a letra "C"'})

Mostra:

<div role="note" class="hatnote relarticle mainarticle">Artigo principal: [[A|a letra "A"]], [[B|a letra "B"]] e [[C|a letra "C"]]</div>

Mostra-se como:

Exemplo 4[editar código-fonte]

mMain._main({'Wikipédia:Verificabilidade#Ónus'}, {selfref = true})

Mostra:

<div role="note" class="hatnote relarticle mainarticle selfref">Artigo principal: [[Wikipédia:Verificabilidade#Ónus|Wikipédia:Verificabilidade § Ónus]]</div>

Mostra-se como:

Exemplo 5 (se for utilizado no domínio categoria)[editar código-fonte]

mMain._main({'A'})

Mostra-se:

<div role="note" class="hatnote relarticle mainarticle">O artigo principal para esta [[Wikipédia:Categoria|categoria]] é [[A]]</div>

Mostra-se como:

Detalhes técnicos[editar código-fonte]

Este módulo utiliza o Módulo:Hatnote para formatar texto hatnote, Módulo:Hatnote list para processar listas de ligações, e o Módulo:Arguments para buscar os argumentos do texto wiki.