Abrir menu principal

Módulo:Info/doc

< Módulo:Info
Revisão de 09h45min de 21 de abril de 2021 por Campari (discussão | contribs) (Criação da documentação do Módulo Info)
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

Esta é a página de documentação para Módulo:Info

Descrição

Este módulo gera infoboxes semelhante à {{Info}}

Uso

O módulo funciona de modo semelhante à {{Info}} e em muitos casos vai funcionar da mesma forma ao trocar a linha

{{Info

por

{{#invoke:Info|base

O preenchimento dos campos pode ser igual ao da {{Info}} (usando rótulo1, dados1, rótulo2, dados2, etc), porém este módulo oferece uma opção mais simples de preenchimento:

Erro em Lua em Módulo:Info na linha 369: attempt to index field 'wikibase' (a nil value).

{{#invoke:Info|base
| cor      = 6.3
| título   = Título
| rodapé   = Rodapé
| #tópico  : Tópico 1
| Rótulo A : dados A
| Rótulo B : dados B
| Rótulo B : #wd:17
| Rótulo C : {{{campo C|}}}
| Rótulo C : #wd:P123
| : dados D sem rótulo
| #tópico  : Tópico 2
| Rótulo E : dados E
}}

Nessa forma de preenchimento os rótulos e dados são inseridos na mesma linha, o que torna a criação da infobox mais rápida, e como não existe números nos campos é mais fácil trocar a ordem dos campos e inserir novos campos em qualquer posição.

Quando existem dois rótulos iguais, como o "Rótulo C" no exemplo acima, será criado somente um campo com esse rótulo, usando o primeiro campo que possuir dados, o "#wd:P123" é a forma como uma propriedade do Wikidata é usada, como não existe essa propriedade para esta página o campo não é preenchido.

Wikidata

Se os dados estiverem no formato #wd:P<número da propriedade>, os dados dessa propriedade serão obtidos do Wikidata, por exemplo |país: #wd:P17 vai gerar o rótulo "país" e pegar o nome do país no Wikidata. Para colocar ligação interna coloque ":link" depois da propriedade, por exemplo #wd:P17:link. Outras funções também estão disponíveis para modificar o valor obtido do Wikidata, veja a documentação do Módulo:Info/wd para detalhes.

Todo campo que estiver usando dados do Wikidata tem a classe de estilo "dadoswd", isso é útil para visualizar quais campos usam dados do Wikidata e quais usam dados locais, para isso edite o seu common.css e adicione algum estilo para diferenciar os campos do Wikidata dos campos locais. O exemplo abaixo coloca um borda roxa a direita do campo:

/* Exibir borda roxa ao lado dos campos da infobox que usam dados do Wikidata */
.dadoswd {
    border-right: 1px solid #CC99FF
}
Diferenciar campos do Wikidata
Rótulo1 dado preenchido localmente
Rótulo2 dado obtido do Wikidata

O código acima em seu common.css produz o efeito ao lado nas infoboxes com dados do Wikidata. O efeito é sutil mas suficiente para diferenciar visualmente qual campo usa dados do Wikidata, para marcar a diferença de forma mais forte use cores mais fortes, bordas mais espessas ou qualquer outro estilo que quiser, só você verá o estilo que configurar no seu common.css.

Cor e estilos

Este módulo segue o padrão visual, nenhuma classe de estilo ou estilos em linha podem ser adicionados, isso garante a acessibilidade das informações e garante uma consistência visual. Somente a cor pode ser alterada usando as cores padrões.

Para usar cores preencha o parâmetro |cor= com uma das cores do padrão visual ou os respectivos números na tabela de cores abaixo, essa cor será usada como fundo do título, as cores mais claras da mesma matiz serão automaticamente usadas no fundo dos tópicos (primeira mais clara) e rótulos (segunda mais clara).

Cor 9.3
dados sem rótulo
Tópico
Rótulo1 dados
Rótulo2 dados
Rodapé
Cor 2.1
dados sem rótulo
Tópico
Rótulo1 dados
Rótulo2 dados
Rodapé
Tom escuro Tom médio Tom claro Tom mais claro
1.1 1.2 1.3 1.4
2.1 2.2 2.3 2.4
3.1 3.2 3.3 3.4
4.1 4.2 4.3 4.4
5.1 5.2 5.3 5.4
6.1 6.2 6.3 6.4
7.1 7.2 7.3 7.4
8.1 8.2 8.3 8.4
9.1 9.2 9.3 9.4
10.1 10.2 10.3 10.4
11.1 11.2 11.3 11.4
12.1 12.2 12.3 12.4
13.1 13.2 13.3 13.4

Pictograma

Pictogramas podem ser colocados no título da infobox com o parâmetro pictograma:

Título
Tópico
Rótulo dados
{{#invoke:Info|base
|título     = Título
|cor        = 12.3
|pictograma = Picto infobox map.png
|#tópico    : Tópico
|rótulo     : dados
}}

Imagem e legenda

A imagem pode ser inserida usando o rótulo #imagem e a legenda com o rótulo #legenda como no exemplo abaixo. Erro em Lua em Módulo:Info na linha 369: attempt to index field 'wikibase' (a nil value).

{{#invoke:Info|base
|título   = Imagem e legenda
|#imagem  : Flatirons Winter Sunrise edit.jpg
|#legenda : esta é a legenda da imagem
}}

A imagem inserida pode estar no formato "exemplo.jpg" ou no formato "[[Ficheiro:exemplo.jpg|220px]]", caso esteja no segundo formato o módulo irá usar somente o nome da imagem, qualquer argumento como o tamanho será ignorado, o tamanho exibido será sempre 200px.

A legenda pode ser usada após uma imagem ou após qualquer outro campo, mesmo que a legenda esteja preenchida ela só será exibida se o campo acima contiver dados, e ela terá o texto menor (90%), então não é preciso usar <small>.

Fusão de infoboxes

É possível inserir uma infobox dentro da outra simplesmente colocando-a dentro de um campo como no exemplo abaixo. Erro em Lua em Módulo:Info na linha 369: attempt to index field 'wikibase' (a nil value).

{{#invoke:Info|base
|título   = Infobox principal
|Rótulo A : dados A
|Rótulo B : dados B
{{#invoke:Info|base
|título = Infobox secundária (este título não aparece)
|#tópico : Tópico da segunda infobox
|Rótulo 2A : dados 2A
|Rótulo 2B : dados 2B
}}
{{#invoke:Info|base
|título = Infobox secundária (este título não aparece)
|#tópico : Tópico da terceira infobox
|Rótulo 3A : dados 3A
|Rótulo 3B : dados 3B
}}
|Rótulo C : dados C
}}

Ao incluir uma infobox dentro de outra lembre de usar infoboxes com a mesma cor e preste atenção aos campos que usam o Wikidata, pois mesmo que uma informação não for preenchida localmente ela pode ser preenchida com dados do Wikidata e fazer com que duas infoboxes fundidas tenham campos repetidos.

Contagem de campos

O número de campos das infoboxes são contados e por padrão a página é categorizada quando não tem nenhum campo, tem apenas 1 campo, tem apenas 2 campos e quando todos os campos são obtidos do Wikidata. Essa categorização ajuda a encontrar infoboxes que precisam de mais dados.

A contagem tambem pode ser modificada através dos parâmetros 'contar campos' e 'contar wikidata':

  • |contar campos=sim vai fazer a categorização ocorrer sempre, até 9 campos será usada a categoria '!Artigos com N campos' com N sendo o número de campos, infoboxes com 10 ou mais serão categorizadas na Categoria:!Infoboxes com 10 ou mais campos.
  • |contar campos=não vai desativar a contagem inclusive para 0, 1 e 2 campos.
  • |contar campos=X a Y vai fazer a categorização ocorrer no intervalo X a Y, por exemplo |contar campos=0 a 5 vai categorizar quando o número de campos estiver entre 0 e 5. O número 10 ou qualquer número maior que 10 será considerado 10 ou mais.
  • |contar wikidata=sim vai fazer a categorização específica para campos do Wikidata, até 9 campos será usada a categoria '!Artigos com N campos do Wikidata' com N sendo o número de campos que usam dados do Wikidata, infoboxes com 10 ou mais serão categorizadas na Categoria:!Infoboxes com 10 ou mais campos do Wikidata.
  • |contar wikidata=não vai desativar a categorização na Categoria:!Infoboxes em que todos campos são do Wikidata
  • |contar wikidata=X a Y vai fazer a categorização específica para campos do Wikidata ocorrer no intervalo X a Y, por exemplo |contar campos=0 a 5 vai categorizar quando o número de campos que usam dados do Wikidata estiver entre 0 e 5. O número 10 ou qualquer número maior que 10 será considerado 10 ou mais.

Extensões

O módulo pode ser estendido com um submódulo para adicionar funções especiais. Para usar por exemplo a extensão Módulo:Info/local use {{#invoke:Info|local em vez de usar o {{#invoke:Info|base.

Os submódulos devem retornar uma tabela, por exemplo ext, na qual deve haver uma tabela ext.especial com as funções especiais, por exemplo para que o rótulo '#nome' chame a função ext.especial['nome']. E se existir a função ext.extra, ela será chamada após o processamento dos campos, o que for retornado será colocado após a infobox.

Campo debug

Para facilitar a identificação de erros durante o preenchimento da infobox ou erros no funcionamento do módulo, o campo 'debug' pode ser usado de diferentes formas:

Campo resultado
| debug = vazio Exibe todos os campos que não foram preenchidos
| debug = campos Exibe o processamento dos campos no rodapé
| debug = erros Exibe erros durante o processamento no rodapé
| debug = wikidata Exibe processamento dos campos do Wikidata no rodapé

Ver também