Mal:Navboks/dok

For en kortere veiledning, se Mal:Navboks/dok/innføring

Denne malen lar deg sette opp en navigasjonsmal forholdsvis raskt ved å legge inn en eller flere lister med lenker. Den er utstyrt med standardstiler som burde fungere for de fleste navigasjonsmaler. Det anbefales å ikke endre standardstilene, men det er mulig. Bruk av denne malen anbefales sterkt på grunn av standardisering av navigasjonsmaler, og fordi den er lett å bruke.

Bruk

Vennligst fjern parametre som er blanke.

{{Navboks
| innholdsklasse = hlist
| navn = {{subst:PAGENAME}}
| tittel = 
| tittelklasse =
| bilde = 
| over = 

| gruppe1 = 
| liste1 = 

| gruppe2 = 
| liste2 = 
 ...
| gruppe30 = 
| liste30 = 

| under = 
}}

Parameterliste

Navboksen bruker parameternavn med små bokstaver, som vist i boksen. De obligatoriske navn og tittel vil lage en enlinjesboks hvis andre parametre er utelatt.

Legg merke til at «gruppe1» (etc.) er valgfri, og det er også seksjonene «over/under».

De grunnleggende og vanligste parametrene er som følger (se under for den fulle listen):

innholdsklasse - legger på et HTML class-attributt for hele navboksen.

navn - navnet på malen (ikke tittelen). Hvis malen f.eks. heter Mal:Foo, blir navnet Foo.

tittel - tekst i tittelfeltet, som f.eks. [[Dingser]].

tittelklasse - legger på et HTML class-attributt for tittelfeltet.

status - autocollapse, uncollapsed, collapsed: om boksen skal være skjult eller ikke, der «autocollapse» skjuler stablede navbokser automatisk.

tittelstil - en CSS-stil for tittelfeltet, som f.eks. background:gray;

gruppestil - en CSS-stil for gruppecellene, som f.eks. background:#eee;

bilde - et valgfritt bilde på høyre side (kodet som en hel bilde-tagg: [[Fil:XX.jpg|90px]] ).

bildevenstre - et valgfritt bilde på venstre side (kodes på samme måte som «bilde»-parameteren).

over - valgfri tekst som skal vises over gruppe-/listeseksjonen (kan være en liste med generelle lenker).

gruppen - teksten på venstre side før liste_n (hvis gruppe_n er utelatt, starter liste_n til venstre i boksen).

listen - tekst som lister opp lenker, ofte adskilt av middot-maler, som f.eks. [[A]]{{,}} [[B]]

under - valgfri tekst som skal vises under gruppe-/listeseksjonen.

Ytterligere detaljer, og kompliserte restriksjoner, er forklart under i avsnittet Parameterbeskrivelser. Se noen alternative navboks-formater under Tabellens utseende.

Parameterbeskrivelser

Følgende er en fullstendig liste over parametre for bruk i {{Navboks}}. I de fleste tilfeller er navn, tittel og liste1 de eneste obligatoriske parametrene, men barnenavbokser trenger ikke at disse parametrene angis.

Oppsettsparametre

navn

Navnet på malen; navnet trengs for at lenkene «v · d · r» («vis · diskusjon · rediger») skal fungere på alle sider der malen brukes. Du kan skrive snarveien {{subst:PAGENAME}} for denne verdien. Navnet er bare obligatorisk hvis en tittel er angitt, og parameteren kantlinje ikke er angitt. For å se «v · d · r» må man slå på det i «Tilleggsfunksjoner» på Spesial:Innstillinger, grunnet å ikke gjøre det enklere for vandaler å finne maler som brukes på mange sider.

status [autocollapse, uncollapsed, collapsed, plain, off]

• Standardverdien er autocollapse. En navboks med autocollapse vil begynne som skjult hvis det er to eller flere tabeller på den samme siden som bruker skjulbare tabeller. Ellers vil navboksen være utvidet. For de teknisk interesserte, se MediaWiki:Common.js.
• Hvis den settes til lukket/collapsed, vil navboksen alltid begynne som skjult.
• Hvis den settes til vanlig/plain, vil navboksen alltid være utvidet, uten en [skjul]-lenke til høyre, og tittelen vil forbli midtstilt (ved å bruke padding til å flytte v • d • r-lenkene).
• Hvis den settes til av/off, vil navboksen alltid være utvidet, uten en [skjul]-lenke til høyre, men det brukes ikke padding for å beholde tittelen midtstilt. Dette er bare for avansert bruk; alternativet «plain» burde være tilstrekkelig for de fleste formål der [vis]/[skjul]-knappen trenger å være skjult.
• Hvis den settes til noe annet enn auto/autocollapse, lukket/collapsed, vanlig/plain eller av/off (som f.eks. «uncollapsed»), vil navboksen alltid begynne i en status der boksen er utvidet, men den har «skjul»-knappen.

For å vise boksen når den er alenestående (ikke inkludert på en annen artikkel), men autoskjule boksen når den er i en artikkel, putt «autocollapse» inni <noinclude>-tagger:

• status = <noinclude>uncollapsed</noinclude>
• Den innstillingen vil tvinge boksen til å være synlig når den er alenestående (selv når den blir fulgt av andre bokser), og til å vise «[skjul]», men den blir autoskjult når den stables inni en artikkel.

Personer som redigerer, ønsker ofte en standard startstatus for en navboks, som kan være overstyrt i en artikkel. Her er trikset for å gjøre det:

• Lag en parameter som heter «status» som en pass-through på denne måten:
• | status = {{{status<includeonly>|din_ønskede_startstatus</includeonly>}}}
• Her vil <includeonly>| gjøre malen synlig når selve malen vises alene.

• Eksempel: {{en:Template:Peso}} med autocollapse som standard startstatus. [en:Bolivian peso] inkluderer den, og har bare en navboks. Så peso-navboksen vises. [en:Chilean peso] har to navbokser. Så peso-navboksen skjules.

• Eksempel: {{en:Template:Historical currencies of Hungary}} med utvidet som standard startstatus. Alle inkluderende artikler viser innholdet som standard, unntatt hvis det var en hypotetisk artikkel som angir status = skjult ved inkludering.

navbar

Standarden er Tnavbar. Hvis den settes til plain, vil ikke v • d • r-lenkene på venstre side av tittelfeltet bli vist, og padding vil automatisk bli brukt for å beholde tittelen midtstilt. Bruk av for å fjerne v • d • r-lenkene, men ikke bruke padding (dette er bare for avansert bruk; alternativet «plain» burde være tilstrekkelig for de fleste formål der en navbar ikke er ønskelig). Legg merke til det anbefales sterkt at man ikke skjuler navbaren; dette er for å gjøre det enklere for brukere å redigere malen, og for å beholde en standard stil på tvers av sider.

kantlinje

Se avsnittet nedenfor om bruk av navbokser inni hverandre for eksempler og en mer fullstendig beskrivelse.

Hvis den settes til child eller subgroup, så kan navboksen brukes som et kantlinjeløst barn (barn = underordnet objekt) som passer inn i en annen navboks. Kantlinjen er skjult, og det er ingen padding på sidene av tabellen, så den passer inn i liste-området i sin foreldrenavboks. Hvis den settes til none, så er kantlinjen skjult og paddingen fjernes, og navboksen kan brukes som et barn av en annen container (ikke bruk alternativet none inni en annen navboks; på samme måte skal alternativet child/subgroup bare brukes inni en annen navboks). Hvis den settes til hva som helst annet (standard), så blir en vanlig navboks med en kantlinje på 1 piksel vist. Her er en alternativ måte å angi at kantlinjen skal være en undergruppestil på (altså bruke den første unavngitte parameteren i stedet for den navngitte kantlinje-parameteren).

{{Navboks|child

...

}}

Celler

tittel

Tekst som vises midtstilt i den øverste raden i tabellen. Denne teksten er vanligvis emnet for malen, dvs. en kortfattet beskrivelse av innholdet i boksen. Teksten bør være på en enkelt linje, men hvis det er behov for en andre linje, bruk {{-}} for å sikre riktig midtstilling. Denne parameteren er teknisk sett ikke obligatorisk, men å bruke {{Navboks}} er ganske meningsløst uten en tittel.

gruppe_n

(dvs. gruppe1, gruppe2, etc.) Hvis angitt, vises teksten i en overskriftscelle til venstre for liste_n. Hvis utelatt, bruker liste_n tabellen i full bredde.

liste_n

(dvs. liste1, liste2, etc.) Hovedinnholdet i malen, vanligvis en liste med lenker. Formatet er at de kommer etter hverandre på en linje; teksten kan imidlertid skrives på separate linjer hvis hele listen omgis av <div> </div>. Minst en liste-parameter er påkrevd; hver ekstra liste blir vist i en egen rad i tabellen. Hver liste_n kan settes etter en korresponderende gruppe_n-parameter, hvis den er oppgitt (se nedenfor).

bilde

Et bilde som skal vises i en celle under tittelen og til høyre for hovedinnholdet (gruppene/listene). For at bildet skal vises ordentlig må parameteren liste1 være angitt. Parameteren bilde godtar standard wikikode for visning av et bilde, dvs.

bilde = [[Bilde:Eksempel-no.jpg|100px]]

bildevenstre

Et bilde som skal vises i en celle under tittelen og til venstre for hovedinnholdet (listene). For at bildet skal vises ordentlig må parameteren liste1 være angitt, og ingen grupper kan være angitt. Parameteren bildevenstre godtar standard wikikode for visning av et bilde, dvs.

bildevenstre = [[Bilde:Eksempel-no.jpg|100px]]

over

En celle i full bredde som vises mellom tittelfeltet og den første gruppen/listen, dvs. over hovedinnholdet i malen (grupper, lister og bilde). I en mal uten et bilde oppfører over seg på samme måte som parameteren liste1 uten parameteren gruppe1.

under

En celle i full bredde som vises under hovedinnholdet i malen (grupper, lister og bilde). I en mal uten et bilde, oppfører under seg på samme måte som malens siste liste_n-parameter uten en gruppe_n-parameter. For et eksempel på bruk av parameteren under, se {{en:Template:Lists of the provinces and territories of Canada}}.

Stilparametre

For å beholde en viss overensstemmelse blant maler og sider på Wikipedia, anbefales stiler generelt ikke. Muligheten til å endre stiler er imidlertid gitt. Hvis du vil angi flere stilegenskaper med den samme parameteren, må du skrive på denne måten:

stil = background:#nnnnnn;width:50em;

Hvis du skriver som vist nedenfor, vil det bare bli tatt hensyn til den siste linjen.

stil = background:#nnnnnn;

stil = width:50 em;

stil

Angir CSS-stiler som skal brukes på malens hovedinnhold. Parameteren innholdsstil gjør også det samme, og kan brukes i stedet for denne stil-parameteren. Denne parameteren bør brukes med forsiktighet ettersom den kan føre til visuelle uoverensstemmelser. Eksempler:

stil = background:#nnnnnn;

stil = width:N [em/%/px eller width:auto];

stil = float:[left/right/none];

stil = clear:[right/left/both/none];

basisstil

CSS-stiler som skal brukes på alle cellene tittel, over, under og gruppe på en gang. Stilen er ikke brukt på liste-cellene. Dette er praktisk for enkel endring av hovedfargen på navboksen uten å måtte gjenta stilangivelsene for de forskjellige delene av navboksen. Eksempler:

basisstil = background:lightskyblue;

tittelstil

CSS-stiler som skal brukes på tittel, oftest tittelfeltets bakgrunnsfarge:

tittelstil = background:#nnnnnn;

tittelstil = background:name;

gruppestil

CSS-stiler som skal brukes på gruppe_n-cellene. Dette alternativet overstyrer alle stiler som er brukt på hele tabellen. Eksempler:

gruppestil = background:#nnnnnn;

gruppestil = text-align:[left/center/right];

gruppestil = vertical-align:[top/middle/bottom];

gruppe_nstil

CSS-stiler som skal brukes på en bestemt gruppe, i tillegg til alle stiler som er angitt av parameteren gruppestil. Denne parameteren bør bare brukes når det er absolutt nødvendig for å opprettholde standardisering og enkelhet. Eksempler:

gruppe3stil = background:red;color:white;

listestil

CSS-stiler som skal brukes på alle lister. Overstyres av parametrene oddetallsstil og partallsstil (hvis de er angitt) nedenfor.

liste_nstil

CSS-stiler som skal brukes på en bestemt liste, i tillegg til alle stiler som er angitt med parameteren listestil. Denne parameteren bør bare brukes nå det er absolutt nødvendig for å opprettholde standardisering og enkelhet. Eksempler:

liste5stil = background:#ddddff;

listepadding

Et tall og en enhet som angir paddingen i hver liste-celle. liste-cellene er utstyrt med en standardpadding på 0.25em på venstre og høyre side, og 0em over og under. På grunn av kompliserte, tekniske grunner virker det ikke å ganske enkelt angi listestil=padding:0.5em; (eller en hvilken som helst annen padding). Eksempler:

listepadding = 0.5em 0em; (angir 0.5em padding for venstre og høyre, og 0em padding over/under.)

listepadding = 0em; (fjerner all listepadding.)

oddetallsstil

partallsstil

Brukes på oddetalls-/partallslistenummer. Overstyrer stiler definert av listestil. Standardoppførselen er å legge på striper, henholdsvis hvit og grå, på oddetalls- og partallsrader for å øke lesbarheten. Disse bør ikke endres, bortsett fra i helt spesielle tilfeller.

partalloddetall [swap, even, odd, off]

Hvis den settes til swap, blir de automatiske stripene for partalls- og oddetallsrader gjort omvendt. Vanligvis får partallsrader en lys grå bakgrunn; når denne parameteren brukes, får oddetallsradene den grå fargen i stedet. Hvis du setter parameteren til even eller odd, får alle radene den stripefargen. Hvis du setter parameteren til off, slår du av automatiske radstriper. Denne avanserte parameteren bør bare brukes for å fikse problemer når navboksen brukes som barn av en annen navboks, og stripene ikke stemmer. Eksempler og en nærmere beskrivelse finnes i avnsittet om barnenavbokser nedenfor.

overstil

understil

CSS-stiler som skal brukes på toppcellen (angitt med parameteren over) og bunncellen (angitt med parameteren under). Brukes vanligvis til å angi bakgrunnsfarge eller tekstjustering:

overstil = background:#nnnnnn;

overstil = text-align:[left/center/right];

bildestil

bildevenstrestil

CSS-stiler som skal brukes på cellene der bildet som er angitt med bilde eller bildevenstre er plassert. Disse stilene bør bare brukes unntaksvis, vanligvis for å fikse breddeproblemer hvis breddene på gruppene er angitt og bredden av bildecellen blir for stor. Eksempler:

bildestil = width:5em;

Standardstiler

Her er det listet opp stilinnstillingene som de fleste brukerne av navboksen oftest endrer. For å holde listen enkel er mer kompliserte stilinnstillinger er ikke tatt med. De fleste stilene er definert i norsk wikipedias MediaWiki:Common.css. Ved behov kan vi spørre om hjelp av en interface-admin for å redigere filen på wikibøker.

innholdsstil  = background:#fdfdfd; width:100%; vertical-align:middle;

tittelstil    = background:#ccccff; padding-left:1em; padding-right:1em; text-align:center;

overstil      = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;

understil     = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;

gruppestil    = background:#ddddff; padding-left:1em; padding-right:1em; text-align:right;

listestil     = background:transparent; text-align:left/center;

oddetallsstil = background:transparent;

partallsstil  = background:#f7f7f7;

Siden listestil og oddetallsstil er transparente, har oddetallslister fargen definert i innholdsstil, som er satt til #fdfdfd (hvit med en anelse grå) som standard. En liste har text-align:left; hvis den har en gruppe, hvis ikke har den text-align:center;. Siden bare innholdsstil har en vertical-align (justering i høyderetningen), arver alle andre dens vertical-align:middle;.

Avanserte parametre

tittelgruppe

Denne putter en gruppe i tittelfeltet, med samme standardstiler som gruppe_n. Den bør bare brukes unntaksvis (vanligvis i avanserte metamaler) og bruken krever noe kunnskap om den indre koden i {{Navboks}}; du bør være klar til å manuelt sette opp CSS-stiler for å få alt til å virke ordentlig hvis du ønsker å bruke den. Hvis du tror du har bruk for denne parameteren, kan det være best å ombestemme seg, eller konsultere diskusjonssiden først.

tittelgruppestil

Stilene for tittelgruppecellen.

indrestil

En meget avansert parameter som bare skal brukes på avanserte metamaler som bruker navboksen. Internt bruker navboksen en ytre tabell for å tegne kantlinjen, og så en indre tabell for alt annet (tittel/over/grupper/lister/under/bilder etc.). Parametrene stil/innholdsstil angir parametrene for den ytre tabellen, som den indre tabellen arver, men i avanserte tilfeller (metamaler) kan det være nødvendig å direkte angi stilene for den indre tabellen. Denne parameteren gir tilgang til den indre tabellen så stiler kan angis. Brukes på eget ansvar.

Mikroformater

innholdsklasse

Denne parameteren settes inn i «class»-attributtet for hele navboksen.

tittelklasse

Denne parameteren settes inn i «class»-attributtet for navboksens tittelfelt.

Denne malen støtter innlegging av mikroformatinformasjon. Dette gjøres ved å legge til «class»-attributter til forskjellige dataceller for å indikere hva slags informasjon som befinner seg der. For å merke en navboks med at den inneholder hCard-informasjon om en person, for eksempel, legg til følgende parameter:

| innholdsklasse = vcard

og

| tittelklasse = fn

eller (for eksempel):

| tittel = <span class="fn">[[Iain Banks]]</span>' bøker

...og så videre.

Se det engelske underprosjektet en:Wikipedia:WikiProject Microformats for mer informasjon om innlegging av mikroformatinformasjon på Wikipedia og en:microformat (norsk mikroformat) for mer informasjon om mikroformater generelt.

Tabellens utseende

Tabell generert av {{Navboks}} uten parametrene bilde, over og under (grå listebakgrunnsceller er tatt med bare for illustrasjon):

Tabell generert av {{Navboks}} med parametrene bilde, over og under (grå listebakgrunnsceller er tatt med bare for illustrasjon):

Tabell generert av {{Navboks}} med bilde, bildevenstre, lister, og uten grupper, over, under (grå listebakgrunnsceller er tatt med bare for illustrasjon):

Barnenavbokser (navbokser inni hverandre)

Det er mulig å plassere flere navbokser innenfor en enkelt kantlinje ved å bruke parameteren kantlinje, eller ved å sette den første unavngitte parameteren til child. Basiskoden for å gjøre dette er som følger (som legger til en undergruppe for det første gruppe/liste-feltet):

{{Navboks
| navn = {{subst:PAGENAME}}
| tittel = Tittel

| gruppe1 = [valgfri]
| liste1 = {{Navboks|child
   ...parametre for barnenavboks...
 }}

...
}}

Flere vis/skjul i en enkelt container

Eksemplet under er generert med en vanlig navboks for hovedcontaineren. Parametrene liste1 og liste2 inneholder hver en annen navboks, med kantlinje = child angitt. Legg merke til at hver av barnenavboksene har sin egen VDR-navigasjonslinje; disse kan skjules med navbar = plain for hver av dem, eller ved bare å utelate parameteren navn (barnenavbokser trenger ikke, i motsetning til vanlige navbokser, å ha navn-parameteren angitt).

Ytterligere eksempler

Du kan finne tilleggseksempler på kompliserte undergrupper og barnenavbokser på siden med avanserte navboks-eksempler og siden med eksempler på navboks-kode.

Tekniske detaljer

• Denne malen bruker CSS-klasser for de fleste av sine detaljer ved utseendet; derfor er den fullt mulig å tilpasse med skins (egendefinerte utseender).

• Internt bruker denne metamalen HTML-kode i stedet for wikikode for tabellkoden. Det er den vanlige måten vi lager metamaler på siden wikikode har mange ulemper. For eksempel gjør den det vanskeligere å bruke parserfunksjoner og spesialtegn i parametrene.

• For flere tekniske detaljer, se diskusjonssiden, CSS-klassene i MediaWiki:Common.css og den skjulbare tabellen som brukes til å skjule boksen i MediaWiki:Common.js.

Vanskeligheter

• Den 2 piksler brede linjen mellom grupper og lister er tegnet ved hjelp av egenskapen border-left til listecellen. Derfor må du sette border-left-color lik bakgrunnsfargen (dvs. listestil = border-left-color:purple;) hvis du vil endre bakgrunnsfargen til malen (f.eks. innholdsstil = background:purple;). Hvis du vil ha en kantlinje rundt hver listecelle, så vil den 2 piksler brede linjen mellom listecellene og gruppecellene forsvinne; du må finne din egen løsning.

• Listecellebredden er i utgangspunktet satt til 100%. Derfor må du også sette listestil til å ha width:auto hvis du vil sette bredden på gruppeceller manuelt. Hvis du vil sette gruppebredden og bruke bilder, er det opp til deg å tenke ut CSS-koden i parametrene gruppestil, listestil, bildestil og bildevenstrestil for å få alt til å fungere riktig. Eksempel på å sette gruppebredde:

gruppestil = width:10em;

listestil = width:auto;

• Tilstøtende navbokser har bare en 1 piksel bred kantlinje mellom dem (unntatt i IE6, som ikke støtter den nødvendige CSS). Hvis du setter topp- eller bunnmargen for stil/innholdsstil, vil ikke dette fungere.

• Standardverdiene for margin-left og margin-right for den ytre navbokstabellen er satt til «auto;». Hvis du vil bruke navboksen som en float, må du manuelt sette verdiene for margin-left og margin-right fordi automargene «forstyrrer» float-innstillingen. For eksempel, legg til følgende kode for å bruke navboksen som en float:

stil = width:22em;float:right;margin-left:1em;margin-right:0em;

Se også

• {{Navboks vedlikehold}} sjekker bruk av en navboks. Anbefales å inkludere på dokumentasjonssiden til navbokser.
• Wikipedia:Line break handling (engelsk) – Et veiledning om hvordan linjeskift (tekstbryting) skal håndteres på Wikipedia, slik som tekstbryting av lenkelister brukt i navbokser.
• {{Nowrap begin}} – Det anbefalte formatet for å legge punkter, loddrette streker eller tankestreker mellom listeelementer. Denne siden beskriver hvordan man skal bruke dem med riktig tekstbryting.
• {{Nobold}} – For å vise teksten som en vanlig font i en sammenheng der standarden er fet, f.eks. overskriftsceller i tabeller.
• {{,}} og {{*}} – Punktene som vanligvis brukes til å adskille elementer i navbokslister.
• {{Navboks/kjerne}}