Arena 2.0:ImageFlow

Introduktion

Denne vejledning beskriver, hvordan man opsætter “ImageFlow” i Arena.

ImageFlow er en karrusel, der viser forsider for udvalgte titler med links til titeloplysningerne.

Javascriptet er skrevet af Finn Rudolph og frigivet under licensen “Creative Commons Attribution-Noncommercial 3.0 Unported.” Denne licens tillader gratis benyttelse på ikke-kommercielle hjemmesider.

Programmet er beskrevet her: [1]

Den originale programkode kan downloades her: [2]

Tekniske forudsætninger

Tekniske forudsætninger for ImageFlow:

• Arena-serveren skal kunne tilgå adressen arena-hotel-dk.axiell.info via HTTP (port 80) og HTTPS (port 443).

Forberedelse

Karrusellens titler angives i en xml-fil, der uploades til Document Library.

Man kan angive titler til flere karruseller i samme fil. Derved kan man på forhånd udvælge titler inden for forskellige emner, som man nemt kan skifte imellem i portlet-indstillingerne. Man kan også få karrusellen til at skifte indhold automatisk hver dag.

Download følgende eksempel-fil via browserens Gem som-funktion, og tilpas den efter behov i Notepad:

https://arena-hotel-dk.axiell.info/resources/add-ons/imageflow/v2/imageflow-example.xml

Det er vigtigt, at man gemmer filen i stedet for blot at kopiere teksten fra skærmen, da nogle browsere ikke viser den komplette xml-fil.

Hvis man opretter en ny fil fra grunden, skal man sørge for at gemme den med tegnkodningen UTF-8. I Notepad gør man dette ved at sætte Kodning til UTF-8 i Gem som-menuen.

Her er et eksempel på en karrusel med tre titler:

<?xml version="1.0" encoding="UTF-8"?>
 <imageflow>
   <list id="1" title="Eksempel">
       <item>
           <id>27319963</id>
           <author>Kirsten Ahlburg</author>
           <title>Sines sure sokker</title>
       </item>
       <item>
           <id>27157440</id>
           <author>Peter Arrhenius</author>
           <title>Simons sandaler</title>
       </item>
       <item>
           <id>27104150</id>
           <author></author>
           <title></title>
       </item>
  </list>
 </imageflow>

Eksemplet indeholder én karrusel (ét <list> element) med tre bøger (tre <item> elementer). De to første bøger står med faustnummer, forfatter og titel, mens den tredje bog kun står med faustnummer. Hvis man kun angiver faustnummer, tages forfatter og titel automatisk fra posten i basen. Nogle poster har et langt forfatternavn eller en lang titel, og man kan derfor selv angive en kortere tekst i xml-filen.

Elementet <list> har to attributter:

• id – Unikt id for listen angivet som et tal fra 1 og opefter. Det er dette id, man bruger til at udpege den karrusel, der skal vises. Hvis karrusellen skal skifte hver dag, vil id="1" blive vist om mandagen, id="2" om tirsdagen, id="3" om onsdagen osv.
• title – Overskrift, der vises over karrusellen.

Elementet <item> har tre underelementer:

• <id> – Faustnummer.
• <author> – Forfatter. Hvis feltet er tomt, hentes oplysningen fra posten i basen.
• <title> – Titel. Hvis feltet er tomt, hentes oplysningen fra posten i basen.

Bemærk: Tegnet & skal skrives som & i karrusel-overskrift, forfatter og title. Tegnet < skal skrives som < . Øvrige specialtegn bør virke uden særlig skrivemåde.

Der kan tilføjes flere <list> og <item> elementer efter behov. Her er et eksempel med to karruseller:

 <?xml version="1.0" encoding="UTF-8"?>
 <imageflow>
   <list id="1" title="Eksempel">
       <item>
           <id>27319963</id>
           <author>Kirsten Ahlburg</author>
           <title>Sines sure sokker</title>
       </item>
       <item>
           <id>27157440</id>
           <author>Peter Arrhenius</author>
           <title>Simons sandaler</title>
       </item>
       <item>
           <id>27104150</id>
           <author></author>
           <title></title>
       </item>
  </list>
<list id="2" title="Eksempel 2">
       <item>
           <id>27319963</id>
           <author></author>
           <title></title>
       </item>
       <item>
           <id>27157440</id>
           <author></author>
           <title></title>
       </item>
       <item>
           <id>27104150</id>
           <author></author>
           <title></title>
       </item>
  </list>
 </imageflow>

I karrusellen med id="2" er der kun angivet faustnumre. Første bog har tom <author> og <title>, og derfor hentes forfatter og titel fra basen. Anden bog har tom <title> og ingen <author>, og derfor hentes titlen fra basen, mens der ikke vises en forfatter. Tredje titel har hverken <author> eller <title>, og derfor vises hverken forfatter eller titel.

Upload xml-filen til Document Library

Når xml-filen er tilpasset, skal den uploades til Document Library:

1. Gå til Document Library, og opret mappen Arena Add-Ons, hvis den ikke allerede findes.

2. I Add-Ons oprettes undermappen ImageFlow, hvis den ikke allerede findes.

3. Giv den tilpassede xml-fil et passende navn, fx nye-billedboger.xml.

4. Upload filen til mappen ImageFlow, og notér filens url.

5. Tillad rettigheden View for rollen Guest for filen. På nogle installationer gøres dette automatisk.

Tilføj og indstil portlet

Tilføj Arena-portletten Webservice der, hvor karrusellen skal være.

Ret portlettens overskrift til eksempelvis “Biblioteket anbefaler”, hvis overskrift og ramme skal vises.

Fjern portlettens ramme, hvis overskrift og ramme ikke skal vises.

Indstil portletten:

Historik

2012-01-20

• Version 2 med ny url til xsl-filen.
• Parametren show=d ændret til show=day (show=d virker stadig, men show=day foretrækkes).
• Opsætningsvejledning tilpasset Arena 2.0.
• Eksempler forbedret.

2010-12-22

• Version 1.
• Første version som add-on via Webservice-portletten.