Bruk av dekoreringsmaler

En dekoreringmal er i utgangspunktet et helt vanlig HTML- eller XHTML-dokument. Det som skiller en dekoreringsmal fra et vanlig (X)HTML-dokument er at det på enkelte steder i malen er brukt Vortex-komponenter.

Om dekoreringsmaler

Hva skjer når du bruker en dekoreringsmal på et webområde?

Når en bruker går på en nettside som ligger på et dekorert webområde vil dekoreringsmalen være utgangspunktet for hva brukeren får se, ikke nettsiden som ligger på webområdet. Malen vil plukke innhold (dynamisk) fra den enkelte nettside (f.eks. <body> elementet) i tillegg til annet innhold som er lagt inn i malen (f.eks. en meny eller en brødsmulesti).

Eksempel på en enkel dekoreringmal

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
${document:head}
</head>
<body>
${resource:breadcrumb}
${document:body}
</body>
</html>

Ved å bruke denne malen på et webområde, vil innhold i <head> og <body> elementet bli hentet fra dokumentene som ligger på det dekorerte webområdet. I tillegg vil det bli satt inn en brødsmulesti (som vil være basert på det enkelte dokuments plassering i dokumentstrukturen) øverst i body-elementet.

Plassering av dekoreringsmaler

Alle dekoreringsmaler skal ligge i mappa:

/vrtx/decorating/templates

Ressurser som brukes i dekoreringsmalene

Andre ressurser som bilder, css eller javascript som brukes i dekoreringsmalene bør legges her:

/vrtx/decorating/resources

Konfigurasjon og oppsett av dekoreringsmaler

Plassering av konfigurasjonsfila

Hvilke maler som brukes hvor på nettstedet ditt er bestemt av fil som heter "config.txt", og som ligger plassert i mappen /vrtx/decorating/ på hvert nettsted:

/vrtx/decorating/config.txt

Hvis det ikke finnes en "decorating"-mappe, benytter ikke nettstedet dekorering.

Strukturen på config.txt-fila

Formateringen i "config.txt" følger standardmåten for properties-filer i Java (typisk navn=verdi):

webområde = dekoreringmal

hvor dekoreringsmal er malen som skal brukes på det oppgitte webområdet.

Eksempel på en enkel config.txt fil

/ = left-column.html

Med et slikt oppsett vil alle dokumenter, mapper og tjenester (som fritekstsøk) på hosten bli dekorert med malen "left-column.html".

Eksempel på en mer kompleks config.txt fil

Eksempler

/index.html = fullpage.html
/besokende/index.html = fullpage.html
/fagene/index.html = fullpage.html
/forskning-undervisning/index.html = fullpage.html
/ = left-menu.html 
/vrtx/decorating = NONE

I dette eksemplet vil dokumentene

  • "index.html",
  • "besokende/index.html",
  • "fagene/index.html"
  • "/forskning-undervisning/index.html"

bli dekorert med malen "fullpage.html" som typisk er uten meny.

Resten av dokumentene og mappene blir dekorert med malen "left-menu.html".

Unntaket er dokumenter og mapper under /vrtx/decorating som ikke dekoreres i det hele tatt (NONE)

Avanserte eksempler

Dekorering av feilmeldinger (404 - Siden finnes ikke m.m.)

Det er mulig å knytte egne maler for ulike feilmeldinger i "config.txt":

error[404] = 404.html
error[500] = 500.html
error = default-error.html

Dette er kun mulig for hoster som ikke benytter UHTML og Visuell profil. Det er også viktig å være klar over at ikke alle komponenter vil fungere på feilmeldingssider siden du ikke har tilgang til noen ressurs. 

Parametre som kan settes

NONE, TIDY og NOPARSE

NONE betyr at dekorering ikke kjøres i det hele tatt på det spesifiserte webområdet. TIDY bør brukes med varsomhet siden det er svært ressurskrevende for serveren. NOPARSE betyr at evt. komponenter som ligger i dokumentene som dekoreres ikke kjøres.

Publisert 21. aug. 2008 20:33 - Sist endret 17. juni 2015 17:44