Mudanças

Ir para navegação Ir para pesquisar

Módulo:Cat principal/doc

3 796 bytes adicionados, 16h52min de 27 de março de 2020
Criou página com '<section begin=header /> {{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|Testes}}|0|<includeonly>{{Module rating|p}}{{alto-risco| 6500}}</includeonly>}}<!-- if pagename does no...'
<section begin=header />
{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|Testes}}|0|<includeonly>{{Module rating|p}}{{alto-risco| 6500}}</includeonly>}}<!-- if pagename does not contain sandbox -->
<section end=header />

== Descrição ==
Este módulo produz uma ligação que diz "O artigo principal para esta categoria é x." Ele utiliza a predefinição {{tl|cat principal}}.

== Utilização de texto wiki ==

Este módulo deve normalmente ser utilizado através da predefinição {{tl|cat principal}}. Mesmo assim, ele pode ser usado de #invoke com sintaxe <code><nowiki>{{#invoke:Cat main|catMain|</nowiki>''parâmetros''<nowiki>}}</nowiki></code>. Por favor utilize a documentação da predefinição {{tl|cat principal}} para os parâmetros disponíveis.

Este módulo produz uma ligação para um artigo principal ou artigos. Ele utiliza a predefinição {{tl|cat principal}}. Normalmente produz uma ligação como "Artigo principal: A". Se for utilizado no domínio [[Ajuda:Categoria|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 ==
Este módulo não pode ser acedido diretamente de #invoke. Em vez disso, só pode ser utilizado através da predefinição {{tl|cat principal}}. Por favor ver a página da predefinição para a sua documentação.

== Utilização de outros módulos Lua ==
Carregue o módulo:

<source lang="lua">
local mMain = require('Módulo:Cat main')
</source>

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

<source lang="lua">
mMain._main(args, options)
</source>

<var>options</var> é uma tabela opcional que pode ser utilizada para configurar o que a função mostra. Existem duas opções disponíveis, "artigo" e "selfref".
* '''artigo''' - se isto for definidos como false, "no", "n", "false", "não" ou 0, o módulo mostra "A página principal" em vez de "O artigo principal". Utilize o código {{code|1={artigo = false}|2=lua}}.
* '''selfref''' - isto é usado quando o que se mostra é uma referência própria da Wikipédia. Para configura esta opção, use {{code|1={selfref = true}|2=lua}}. (Ver a predefinição {{tl|autorreferência}} para mais detalhe sobre autorreferências.)

Os restantes argumentos são nomes de páginas que são transformados em ligações seguindo o texto "O artigo principal para esta categoria é". Se não existir o nome da página definido, é utilizado para o primeiro link o nome da página atual (menos o nome do [[WP:NS|domínio]]).

; Exemplo 1
<source lang="lua">
mCatMain._catMain(nil, 'Foo')
</source>
Mostra:
:<code><nowiki><div class="hatnote relarticle mainarticle">O artigo principal para esta [[Ajuda:Categoria|categoria]] é '''[[Foo]]'''.</div></nowiki></code>
Mostra-se:
{{cat principal|Foo}}

; Exemplo 2
<source lang="lua">
mCatMain._catMain(nil, 'Foo', 'Bar', 'Baz')
</source>
Mostra-se:
:<code><nowiki><div class="hatnote relarticle mainarticle">Os artigos principais para esta [[Ajuda:Categoria|categoria]] é '''[[Foo]]''', '''[[Bar]]''' e '''[[Baz]]'''.</div></nowiki></code>
Mostra-se:
{{cat principal|Foo|Bar|Baz}}

; Exemplo 3
<source lang="lua">
mCatMain._catMain({article = false}, 'Foo')
</source>
Mostra-se:
:<code><nowiki><div class="hatnote relarticle mainarticle">A página principal para esta [[Ajuda:Categoria|categoria]] é '''[[Foo]]'''.</div></nowiki></code>
Mostra-se:
{{cat principal|Foo|article=no}}

== Detalhes técnicos ==

Este módulo utiliza o [[Módulo:Hatnote]] para formatar texto hatnote.

<includeonly>{{testes outro||
[[Categoria:!Módulos Hatnote]]
}}</includeonly>

Menu de navegação