Indicacións de uso do modelo

Este modelo permite crear caixas de navegación de forma relativamente sinxela usando unha ou máis listas de ligazóns. Os estilos por defecto deberían ser suficientes para a mioría de caixas de navegación. Estes estilos poden cambiarse, pero non está recomendado. O uso deste modelo e dos seus derivados está recomendado para estandarizar os modelos de navegación e para un uso máis doado destes.

Os Navboxes e outros modelos que usan os atributos navbox ou vertical-navbox non se visualizan no Sitio Móbil da Wikipedia.

Suprime os parámetros que vaian quedar en branco:

{{Navbox
| name       = {{subst:PAGENAME}}
| title      =
| listclass  = hlist
| state      = {{{state|}}}

| above      =
| image      =

| group1     =
| list1      =

| group2     =
| list2      =
<!-- ... -->
| group20    =
| list20     =

| below      =
}}

Lista de parámetros

editar

O navbox usa parámetros en minúscula, como se pode ver na caixa de enriba. Os parámetros requiridos |name= e |title= crean unha caixa dunha soa liña en caso de omitirse o resto de parámetros.

Os parámetros |groupX= e as seccións |above= e |below= son opcionais.

Os parámetros básicos máis comúns son os listados a continuación. Para unha lista completa de parámetros vexa as seguintes seccións.

name – nome do modelo.
title – texto da barra de título.
listclass – clase CSS para as celas de listas, habitualmente hlist para as listas horizontais. Tamén se pode usar bodyclass para aplicar un estilo á caixa completa.
state – controla cando se amosa o navbox expandido ou colapsado.
titlestyle – estilo CSS para a barra de título.
groupstyle – estilo CSS para as celas de grupos.
above – texto opcional que aparece na sección "above".
image – imaxe opcional, amosada á dereita da caixa. Debe indicarse co código completo: [[Ficheiro:XX.jpg|XXpx|link=|alt=]].
imageleft – imaxe opcional, amosada á esquerda da caixa.
groupn – Texto do grupo "n".
listn – Texto da lista "n".
below – texto opcional que aparece na sección "below".

Descrición dos parámetros

editar

A seguinte é unha lista completa dos parámetros deste modelo. Na maioría dos casos, os parámetros requiridos son só name, title, e list1, aínda que os navboxes fillos non precisan destes.

Este modelo comparte moitos parámetros comúns cos modelos irmáns {{Navbox con columnas}} e {{Navbox with collapsible groups}}. Os parámetros marcados con un asterisco (*) son comúns a todos estes modelos.

Parámetros de configuración

editar
name*
Nome do modelo, necesario para que as ligazóns "V • C • E" ("Ver • Conversa • Editar") funcionen correctamente en tódalas páxinas nas que se usa o modelo. Pode indicarse como {{subst:PAGENAME}} . Este parámetro só é obrigatorio cando se especifica o parámetro title e se o parámetro border non está definido e se o parámetro navbar non se usa para deshabilitar a barra de navegación.
state* [autocollapse, collapsed, expanded, plain, off]
  • O valor por defecto é autocollapse. Un navbox con autocollapse visualízase de inicio colapsado se hai dúas ou máis táboas na mesma páxina que usen táboas colapsables. De non ser así, o navbox visualízase expandido de inicio. Este comportamento defínese en MediaWiki:Common.js.
  • O valor collapsed fai que o navbox sempre comece no estado colapsado.
  • O valor expanded fai que o navbox sempre comece no estado expandido.
  • O valor plain fai que o navbox sempre estea expandido sen o botón [agochar] na dereita, e o título mantense centrado.
  • O valor off fai que o navbox sempre estea expandido sen o botón [agochar] na dereita, pero non se centra o título.
navbar*
Se o valor é plain, as ligazóns V • C • E da esquerda do título non se amosan, e o título mantense centrado. Pode usarse off para eliminar as ligazóns V • C • E sen centrar o título.
border*
Vexa a sección Navboxes fillos para unha descrición máis completa. Co valor child ou subgroup pode usarse o navbox como un fillo sen bordo que se inclúe dentro doutro navbox. O bordo agóchase e non se aplica marxes nos lados da táboa, para que se visualice ben na área list correspondente do navbox pai. Co valor none o bordo agóchase e elimínanse as marxes, para poder empregar o navbox como fillo doutro contedor. (non se debe usar o valor none dentro doutro navbox, e o valor child/subgroup só debe usarse dentro doutro navbox). Con calquera outro valor fai que se visualice un navbox estándar cun bordo de 1px. Para especificar o estilo de grupo fillo pódese empregar da forma:
{{Navbox|child
...
}}
title*
Texto que se amosa centrado na fila superior da táboa. Por norma xeral debe ser unha única liña.
above*
Cela que se amosa entre a barra de título e o primeiro grupo ou lista.
groupn*
(group1, group2 etc.) Cando se especifican, o texto amósase nunha cela á esquerda do listn correspondente. De omitirse, o listn correspondente usa o tamaño total da táboa.
listn*
(list1, list2 etc.) Corpo do modelo, habitualmente unha lista de ligazóns. O formato é en liña, aínda que o texto pode introducirse en liñas separadas incluíndo un code><div> </div>. Polo menos un parámetro list é obrigatorio. Cada parámetro list adicional amósase nunha fila distinta da táboa. Cada parámetro listn pode ir acompañado do seu correspondente groupn.
Cando se usa o formato hlist as entradas da lista deben indicarse separadas con saltos de liña e asteriscos (*). Cando se usan dous asteriscos (**) a entrada aníñase coa anterior, amosándose entre chaves. Engadindo máis asteriscos tamén incrementa o número de chaves ó redor da entrada.
image*
Unha imaxe que se visualiza nunha cela baixo o título e a dereita do corpo (o conxunto de groups/list). Para que se vexa ben a imaxe debe existir polo menos o parámetro list1. O parámetro image acepta código wiki estándar para amosar a imaxe:
[[Ficheiro:XX.jpg|80px|link=|alt=]]
imageleft*
Unha imaxe que se visualiza nunha cela baixo o título e a esquerda do corpo (o conxunto de groups/list). Para que se vexa ben a imaxe debe existir polo menos o parámetro list1. Acepta código wiki estándar para amosar a imaxe.
below*
Cela amosada ó final do corpo do artigo. Nos modelos sen imaxe, below compórtase da mesma forma que o último parámetro listn sen un groupn correspondente.

Parámetros de estilo

editar

Polo xeral non se recomenda o uso de estilos para manter a consistencia entre modelos e páxinas. Porén, existe esta opción que se pode aplicar de diversas formas segundo se indica a continuación.

bodystyle*
Especifica estilos CSS para aplicar no corpo do modelo. Cómpre ter precaución ó aplicar esta opción xa que pode producir inconsistencias visuais.
Exemplos:
bodystyle = background: #nnnnnn;
bodystyle = width: N [em/%/px or width: auto];
bodystyle = float: [left/right/none];
bodystyle = clear: [right/left/both/none];
basestyle*
Estilo CSS "base" para aplicar as celas title, above, below e group ó mesmo tempo. Este estilo non se aplica as celas list. Isto permite cambiar a cor básica do navbox sen ter que repetir a especificación de estilo para cada unha das partes do mesmo.
Exemplos:
basestyle = background: lightskyblue;
titlestyle*
Estilo CCS para aplicar a title, habitualmente a cor de fondo do título.
titlestyle = background: #nnnnnn;
titlestyle = background: name;
titlestyle = background: none; — sen cor de fondo
groupstyle*
Estilo CCS para aplicar as celas groupN. Esta opción sobreescribe calquera estilo aplicado á táboa no seu conxunto.
Exemplos:
groupstyle = background: #nnnnnn;
groupstyle = text-align: [left/center/right];
groupstyle = vertical-align: [top/middle/bottom];
groupnstyle*
Estilo CCS para aplicar a un grupo específico, a maiores doutros estilos indicados no parámetro groupstyle. Este parámetro debería usarse só cando sexa necesario para manter unha estandarización e simplicidade.
Exemplos:
group3style = background: red; color: white;
groupwidth
Número e unidade que especifica un ancho uniforme para o grupo de celas, nos casos nos que pouco contido nas celas de listas provoquen que as celas de grupo sexan demasiado anchas. Non ten valor por defecto. O parámetro group(n)style pode sobreescribir este valor.
Exemplos:
groupwidth = 9em
liststyle*
Estilo CCS para aplicar a tódalas listas. Sobreescríbese polos parámetros oddstyle e evenstyle.
listnstyle*
Estilo CCS para unha lista particular, a maiores dos estilos especificados no parámetro liststyle. Debe empregarse só cando sexa necesario para manter a estandarización e a simplicidade do modelo.
Exemplos:
list5style = background: #ddddff;
listpadding*
Número e unidade que especifica as marxes de cada cela list. As celas list teñen uns marxes por defecto de 0.25em na esquerda e dereita, e 0 arriba e abaixo.
Exemplos:
listpadding = 0.5em 0; (sets 0.5em padding for the left/right, and 0 padding for the top/bottom.)
listpadding = 0; (removes all list padding.)
oddstyle
evenstyle
Estilo CCS para aplicar as listas pares e impares. Sobreescribe o estilo definido por liststyle. Por defecto amosa cores brancas e gris de forma alterna as filas pares e impares respectivamente.
evenodd [swap, even, odd, off]
Co valor swap invirte as cores das filas por defecto. Co valor even ou odd iguala tódalas filas á cor correspondente. Co valor off deshabilita as cores automáticas para as filas. Recoméndase o seu uso só para arranxar problemas cando o navbox se usa como fillo doutro.
abovestyle*
belowstyle*
Estilo CCS para as filas above e below.
Exemplos:
abovestyle = background: #nnnnnn;
abovestyle = text-align: [left/center/right];
belowstyle = background: #nnnnnn;
belowstyle = text-align: [left/center/right];
imagestyle*
imageleftstyle*
Estilo CCS para as celas das imaxes image e imageleft. Estes estilos deben empregarse só cando sexa necesario arranxar problemas coa disposición ou tamaño das imaxes
Exemplos:
imagestyle = width:5em;
Valores por defecto
editar

Os valores por defecto para a maioría de estilos do modelo defínense en MediaWiki:Common.css.

bodystyle = background: #fdfdfd; width: 100%; vertical-align: middle;
titlestyle = background: #ccccff; padding-left: 1em; padding-right: 1em; text-align: center;
abovestyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: center;
belowstyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: center;
groupstyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: right;
liststyle = background: transparent; text-align: left/center;
oddstyle = background: transparent;
evenstyle = background: #f7f7f7;

Xa que liststyle e oddstyle son transparente, as filas impares teñen a cor de bodystyle, por defecto #fdfdfd. Por defecto as listas teñen o valor de aliñamento á esquerda text-align: left; se ten un grupo, se non o valor por defecto é text-align: center;. Só bodystyle ten un valor para vertical-align, polo que o resto herda vertical-align: middle;.

Parámetros avanzados

editar
bodyclass
aboveclass
groupclass
listclass
belowclass
Habilitan a opción de asignar unha clase CSS a celas de grupos ou listas. O uso máis común de listclass é darlle a clase hlist para que os elementos da lista se visualicen en horizontal. Todos estes parámetros aceptan a clase hlist, pero de usarse para máis dun deles debería indicarse só en |bodyclass=hlist.
titlegroup
Inclúe un grupo na zona do título, co mesmo estilo por defecto que groupn. Só para uso en ocasións excepcionais, como en meta-modelos.
titlegroupstyle
Estilo para a cela titlegroup.
innerstyle
Parámetro avanzado para o seu uso so en meta-modelos avanzados que usen o navbox. Internamente o navbox emprega unha táboa exterior para o bordo, e unha táboa interior para o condido. Os parámetros style/bodystyle definen o estilo da táboa exterior, mentres que os da interior herdan estes estilos, pero en meta-modelos avanzados pode ser necesario definir directamente os estilos da táboa interior.

Microformatos

editar
bodyclass
Parámetro insertado no atributo "class" para o navbox no seu conxunto.
titleclass
Parámetro insertado no atributo "class" para o texto do título do navbox.

É posible engadir información de microformatos. Isto faise engadindo atributos "class" as celas de datos, indicando que tipo de información conteñen. Por exemplo, para indicar que un navbox contén información dunha persoa hCard:

| bodyclass = vcard

e

| titleclass = fn

ou (por exemplo):

| title = Obras de <span class="fn">[[Iain Banks]]</span>

Disposición da táboa

editar

Sen imaxe, above e below

editar

Táboa xerada por {{Navbox}} sen os parámetros image, above e below (cor de fondo gris das listas engadidas por motivos ilustrativos):

Con imaxe, above e below

editar

Táboa xerada por {{Navbox}} incluíndo os parámetros image, above e below (cor de fondo gris das listas engadidas por motivos ilustrativos):

Con imaxe e sen grupos

editar

Táboa xerada por {{Navbox}} con image, imageleft, lists, e sen groups, above, below (cor de fondo gris das listas engadidas por motivos ilustrativos):

Exemplos

editar

Sen imaxe

editar
{{Navbox
| name  = {{PAGENAME}}
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist

| group1 = Centro
| list1  =
* [[Cyberjaya]]

| group2 = Área
| list2  =
* [[Klang Valley]]

| group3 = Lugares principais
| list3  =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Kuala Lumpur International Airport]]

| group4 = Infraestrutura
| list4  =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| group5 = Aplicacións principais
| list5  =
* [[EGovernment]]
* [[MyKad]]
}}

Con imaxe, sen grupos

editar
{{Navbox
| name  = {{PAGENAME}}
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist
| image = [[Ficheiro:Flag of Malaysia.svg|80px|link=|alt=Malaisia]]

| list1 =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Kuala Lumpur International Airport]]
}}

Con dúas imaxes, sen grupos, listas múltiples

editar
{{Navbox
| name  = {{PAGENAME}}
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=Malaisia]]
| imageleft = [[File:Flag of Malaysia.svg|80px]]

| list1 =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]

| list2 =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| list3 =
* [[EGovernment]]
* [[MyKad]]

| list4 =
* [[Klang Valley]]
}}

Con imaxe, grupos, above, below

editar
{{Navbox
| name  = {{PAGENAME}}
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist
| above = O texto "above" vai aquí
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=Malaisia]]

| group1 = Centro
| list1  =
* [[Cyberjaya]]

| group2 = Área
| list2  =
* [[Klang Valley]]

| group3 = Lugares principais
| list3  =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]

| group4 = Infraestrutura
| list4  =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| group5 = Aplicacións principais
| list5  =
* [[EGovernment]]
* [[MyKad]]

| below  = O texto "below" vai aquí
}}
editar

É posible incluír navboxes múltiples dentro dun bordo único co uso do parámetro border, ou especificando no primeiro parámetro o valor "child". O código básico para isto é:

{{Navbox
| name = {{subst:PAGENAME}}
| title = Título

| group1 = [opcional]
| list1  = {{Navbox|child
   ...parámetros do navbox fillo...
 }}

...
}}

Exemplo de subgrupo

editar
Artigo principal: Modelo:Navbox subgroup.

Recoméndase o uso de {{Navbox subgroup}}, pero pode acadarse o mesmo resultado usando {{Navbox}} co parámetro border = child ou co primeiro parámetro sen nome co valor child.

{{Navbox
| name = {{PAGENAME}}
| image = [[Ficheiro:Flag of Galicia.svg|100px|link=|alt=Galicia]]
| state = uncollapsed
| title = Exemplo de subgrupos múltiples
| above = Above
| below = Below
| group1 = Group1
| list1  = List1
| group2 = Group2
| list2  =
 {{Navbox|child
  | evenodd = swap
  | group1 = Group2.1
  | list1  = List1
  | group2 = Group2.2
  | list2  = List2
  | group3 = Group2.3
  | list3  = List3
 }}
| group3 = Group3
| list3 = List3
| group4 = Group4
| list4 =
 {{Navbox|child
  | evenodd = swap
  | group1 = Group4.1
  | list1  = List1
  | group2 = Group4.2
  | list2  = List2
  | group3 = Group4.3
  | list3  = List3
 }}
}}


Botóns de agochar/amosar múltiples nun só contedor

editar
{{Navbox
| name = {{PAGENAME}}
| title = [[Ficheiro:Blason France moderne.svg|x17px|link=|alt=]] [[Ficheiro:Flag of France.svg|x17px|link=|alt=]] [[Imperio colonial francés]]
| state = uncollapsed
| list1 = {{Navbox|child
 | navbar    = plain
 | title     = [[Imperio colonial francés|Antigas colonias]] en [[África]] e o [[Océano Índico]]
 | listclass = hlist
 | group1 = [[Magreb]]
 | list1  =
* [[Alxeria]]
* [[Marrocos]] <small>([[Arguin]])</small>
* [[Historia de Tunisia|Tunisia]]
 | group2 = [[África occidental francesa]]
 | list2  =
* [[Historia de Costa de Marfil|Costa de Marfil]]
* [[Dahomey]]
* [[Sudán francés]]
* [[Guinea]]
* [[Historia de Mauritania|Mauritania]]
* [[Historia de Níxer|Níxer]]
* [[Historia de Senegal|Senegal]]
* [[Alto Volta]]
* [[Togolandia]]
* [[Illa James]]
| group3 = [[África ecuatorial francesa]]
 | list3  =
* [[Chad]]
* [[Historia de Gabón|Gabón]]
* [[Historia da República do Congo|Congo]]
* [[Oubangui-Chari]]
| group4 = [[Comoros]]
 | list4  =
* [[Anjouan]]
* [[Grande Comore]]
* [[Mohéli]]
* [[Historia de Xibutí|Xibutí]]
* [[Historia de Madagascar|Madagascar]]
* [[Mauricio|Ile de France]]
* [[Seychelles]]
}}
| list2 = {{Navbox|child
 | navbar    = plain
 | title     = [[Imperio colonial francés|Antigas colonias]] en [[América]]
 | listclass = hlist
| list1 =
* [[Nova Francia ]]{{espazos|2}}<small>([[Acadia]], [[Louisiana]], [[Canadá]], [[Terra Nova]]) 1655–1763 </small>
| list2 =
* [[Inini]]
* [[Berbice]]
* [[Santo Domingo]]
* <small>[[Haití]]</small>
* [[Tobago]]
* [[Historia das Illas Virxes Británicas|Illas Virxes]]
* [[Francia antártica]]
| below      = [[Compañía francesa das Indias occidentais]]
}}
| list3 = {{Navbox|child
 | navbar     = plain
 | title      = [[Imperio colonial francés|Antigas colonias]] en [[Asia]] e [[Oceanía]]
 | listclass  = hlist
| group1 = [[India francesa]]
 | list1  =
* [[Chandernagor]]
* [[Coromandel Coast]]
* [[Historia de Chennai|Madras]]
* [[Mahé]]
* [[Historia de Pondichéry|Pondichéry]]
* [[Karaikal]]
* [[Yanaon]]
| group2 = [[Indochina francesa]]
 | list2  =
* [[Cambodxa]]
* [[Historia de Laos|Laos]]
* [[Vietnam]] <small>([[Annam]], [[Cochinchina]], [[Tonkin]])</small>
| group3 = Outros territorios
 | list3  =
* [[Alaouites]]
* [[Alexandretta-Hatay]]
* [[Sri Lanka]]
* [[Kwangchowan]]
| group4 = [[Oceanía]]
 | list4  =
* [[Novas Hebrides]]
** [[Vanuatu]]
| below      = [[Compañía francesa das Indias orientais]]
}}
}}

Relación con outros modelos Navbox

editar

Este modelo pode traballar conxuntamente con outros dos modelos: {{Navbox con columnas}} and {{Navbox with collapsible sections}}. Os tres modelos comparten parámetros comúns para manter unha consistencia e facilitar o seu uso. Cada un deles pode empregarse como navbox fillo de outro co parámetro |border=child Por exemplo: {{Navbox|child ...}}, {{Navbox con columnas|child ...}} ou {{Navbox with collapsible sections|child ...}}.)

Véxase tamén

editar
  • {{Navbar}} – Usado para as ligazóns de navegación do navbox.
  • {{Barra lateral}} – Caixas de navegación verticais.
  • {{Nowrap begin}}, {{·}} e {{}} están desbotados en favor do uso da clase hlist para o formato das listas.
Este recadro non aparecerá no artigo.
Esta documentación está transcluída desde Modelo:Navbox/uso. Os editores poden probar cambios no mesmo en Modelo:Navbox/probas.
Por favor, engade as categorías na subpáxina de documentación e os interwikis no Wikidata. Ver as subpáxinas deste modelo.