Predefinição:Navbox

Documentação da predefinição

Esta documentação é transcluída de Predefinição:Navbox/doc. [editar] [atualizar]

Predefinição:Navbox invoca a função navbox em Módulo:Navbox usando Lua.

Predefinição:Navbox evoca Módulo:Navbox usando Lua.

Uso

Essa predefinição pode ser usada para fazer uma caixa da navegação padrão. Tem a intenção de ser usada dentro de outras predefinições de padronização onde os títulos e o conteúdo de dentro delas são semelhantes. Essa predefinição não deve ser usada diretamente dentro de artigos, já que seria muito difícil de fazer a manutenção.

O propósito dessa predefinição é padronizar os atributos de todas as caixas de navegação, por exemplo, suas cores e outros atributos de CSS. A predefinição é bastante simples, e pode ser estendida para outras coisas no futuro. Usar essa predefinição permite que mudanças sejam efetuadas de maneiras mais simples ao invés de cada uma por vez.

Uso base:

{{Navbox
| name = 
| title = 
| gtitle1 =
| ggrid1  = normal
| group1 =
| footer = 
}}

Sintaxe

{{Navbox
| state = plain, collapsed
| class = quadrado (opcional, use caso não queira o canto redondo)
| name = <nome da predefinição>
| style = (opcional - estilo para toda a tabela)
| title = <título para o cabeçalho>
| gtitleNº = (opcional - nome para o título de um grupo
| ggridNº  = small/normal/large (opcional, tenta alinhar os elementos numa grelha)
| styleNº = (opcional - estilo para todo um grupo)
| groupNº = (opcional - conteúdo de um grupo)
| fstyle = (opcional - estilo para o rodapé)
| footer = (opcional - rodapé)
}}

• Grupos: Atualmente, o limite de grupos é 20.
  • Grupos podem ser adicionados como parâmetros: group1, group2, group3, até o group16.
• Títulos de grupo: Cada grupo tem seu próprio parâmetro de título: gtitle, gtitle2, gtitle3, até o group20. Nota que a largura padrão para os nomes é de 15%
• Estilo de grupo: O estilo de cada grupo pode ser customizado para cada grupo: style1, style, style3, até o style16.
  • Note que nenhum dos títulos ou os conteúdos tem links da wiki incluídos na predefinição. Como resultado, utilizadores da predefinição são livres para utilizá-los como necessário.
• Pontos: Cria listas não-numeradas em linhas que começam com {{*}}

Para usar a grelha ggrid, use:

• small — 5 colunas;
• normal — 3 colunas;
• large — 2 colunas.

Estados

autocollapse / automático

• Por padrão, uma navbox é aberta (uncollapsed)

collapsed / fechado

• Força a Navbox a ser fechada.

uncollapsed / aberto

• Força a navbox a ser aberta.

plain

• Remove o "mostrar/ocultar".

Subgrupos

• Para navboxes maiores, pode ser necessário incluir subgrupos dentro de grupos particulares de itens. Também é possível incluir navbox fechadas dentro de navboxes maiores.
• Para criar subgrupos dentro de uma Navbox, alguns parâmetros devem ser incluídos:
  • O grupo principal (ex. group2 no exemplo abaixo) requer o parâmetro (gtype2 = subgroup)
  • O subgrupo requer a inclusão do parâmetro de subgrupo (subgroup = yes). Isso permite que a predefinição diferencie os subgrupos da navbox principal.

{{Navbox
|name = 
|title = 
|gtitle1 = 
|group1 =
|gtitle2 = 
|gtype2 = subgroup (mandatory)
|group2 =
  {{Navbox
  |subgroup = yes (mandatory)
  |gtitle1 = 
  |group1 =
  |gtitle2 = 
  |group2 =
  }}
}}

Subgrupos fecháveis

• Para navboxes extremamente longas, é recomendado usar navboxes fecháveis dentro da navbox principal. Outros subgrupos podem ser então adicionados nelas.
• Para criar subgrupos fecháveis dentro de uma Navbox, esses parâmetros precisam ser incluidos:
  • A Navbox principal é quase sempre aberta (state = uncollapsed)
  • O grupo principal (ex. group1 no exemplo abaixo) requer o parâmetro (gtype1 = subgroup)
  • A Navbox secundária requer a inclusão do parâmetro de fechamento (collapsible=yes). Isso permite a predefinição diferenciar as duas.
  • A navbox secundária deve ser forçada a ficar fechada.

{{Navbox
|state = uncollapsed
|name = 
|gtype1 = subgroup
|group1 = 
  {{Navbox
  |collapsible = yes
  |state = collapsed
  |title = 
  |gtitle1 = 
  |group1 =
  |gtitle2 = 
  |group2 =
  }}
}}

Uso de imagens

• O uso de imagens em navboxes é permito, mas, por favor, redimencione-as para mantê-las pequenas. Imagens do tamanho de itens de mochila (25-30 pixels) são recomendados.
• Por favor, use {{plink}} para criar links com imagens. Use {{plinkp}} em casos onde o texto não é necessário. Funciona da mesma forma, mas não produz o texto com o link. Use {{cabeça}} para adicionar cabeças de NPCs.

Exemplos

Código	Resultado
{{plink|Torso de boate}}	Torso de boate
{{plink|Torso de boate|img=Barra de ferro}}	Torso de boate
{{plink|Torso de boate|txt=Torso}}	Torso

Categorizando

Navboxes são muito úteis para incluir categorias em um grande número de páginas que compartilham de mesmos traços (nome, forma de obter etc). Por exemplo: Predefinição:Divindades inclui a Categoria:Divindades em todas as páginas que ela está incluída.

Existem duas maneiras de categorizar com as navboxes:

A primeira maneira é com {{Ctg}}. É o melhor método, e pode ser usado na maioria dos casos. As regras e operações para ele são muito simples; entretanto, é o bastante para produzir os efeitos desejados na maioria das páginas.

O outro método é usando {{Mainonly|regras}} e faz com que possamos adicionar mais coisas, como parâmetros variáveis.

Exemplos

Navbox única com lista centralizada

{{Navbox
|name = 
|title = 
|style1 = text-align:center
|group1 =
}}

Navbox com rodapé padrão

{{Navbox
|name = 
|title = 
|gtitle1 = 
|group1 =
|footer = Rodapé centralizado
}}

Navbox com várias linhas

{{Navbox
|name = 
|title = 
|gtitle1 = Group title 1
|group1 =
|gtitle2 = Group title 2
|group2 =
|gtitle3 = Group title 3
|group3 =
}}

Navbox fechada

{{Navbox
|state = collapsed
|name = 
|title = 
|style1 = text-align:center
|group1 =
}}

Múltiplas Navboxes

Navbox complexa

{{Navbox
|state = uncollapsed
|name = 
|title = 
|gtitle1 = Nível 1 Título 1
|group1 =
|gtitle2 = Nível 1 Título 2
|group2 =
|gtitle3 = Nível 1 Título 3
|group3 =
|gtitle4 = Nível 1 Título 4
|group4 =
|gtitle5 = Nível 1 Título 5
|gtype5 = subgroup
|group5 =
  {{Navbox
  |subgroup = yes
  |gtitle1 = Nível 2 Título 1
  |group1 =
  |gtitle2 = Nível 2 Título 2
  |group2 =
  |gtitle3 = Nível 2 Título 3
  |gtype3 = subgroup
  |group3 =
    {{Navbox
    |subgroup = yes
    |gtitle1 = Nível 3 Título 1
    |group1 =
    |gtitle2 = Nível 3 Título 2
    |group2 =
    }}
  |gtitle4 = Nível 2 Título 4
  |group4 =
  }}
|gtitle6 = Nível 1 Título 6
|group6 =
|gtitle7 = Nível 1 Título 7
|group7 =
|fstyle = 
|footer = 
}}

Previnindo documentação desnecessária

A Documentação da predefinição de Navbox é automaticamente transcrita abaixo da navbox de qualquer página sob o namespace de Predefinição ou Template. Não é transcrito quando uma navbox é utilizada como subgrupo (subgroup = yes ou estado = collapsed).

Se a documentação aparecer em alguma ocasião onde não deveria, pode escondida usando o parâmetro doc = no na predefinição. Na maioria dos casos, o parâmetro não é necessário e a documentação é removida completamente.