TravelTales; håndtering af konfigurationsfil

Transkript

1 TravelTales; håndtering af konfigurationsfil 1 (7) TravelTales; håndtering af konfigurationsfil Synopsis Dette dokument beskriver indholdet i en TravelTales konfigurationsfil og metoder til hvordan man kan tilføje og ændre i indholdet. Dette dokument dækker funktionaliteten i TravelTales version 2.1/2.2 og konfigurationsfil layout version Inholdsfortegnelse 1 Introduktion TravelTales.xml Indholdet af TravelTales.xml Redigering af TravelTales.xml Referencer Introduktion Det vigtigste indhold i konfigurationsfilen er databasen hvor de enkelte koordinater er parret med den tilhørende lydfil. Herudover er der nogle generelle opsætningsparametre og en licens nøgle, der bruges af TravelTales applikationen. Konfigurationsfilen til TravelTales indlæses hver gang TravelTales applikationen startes. Herudover kan konfigurationsfilen også indlæses hvis man på et tidpunkt ønsker at skifte til en anden konfiguration. På denne måde er det muligt at have adskillige oplevelsesture liggende på telefonen på samme tid, da brugeren blot kan bede om at få indlæst en anden konfigurationsfil, der passer til f.eks. et nyt område, et andet transportmiddel eller et andet tur-tema. Når TravelTales applikationen startes, leder applikationen efter filen TravelTales.xml. Android versionen af TravelTales leder efter den sidst benyttede konfigurations fil. Vær opmærksom på at konfigurationsfilen skal være placeret i TravelTales folderen på SD-kortet, hvor også lydfilerne skal placeres. TravelTales folderen skal ligge i roden af SD-kortet.

2 TravelTales; håndtering af konfigurationsfil 2 (7) Her er et eksempel på hvorledes det kan se ud:.sdcard/traveltales/traveltales.xml.sdcard/traveltales/start.mp3.sdcard/traveltales/post1.mp3.sdcard/traveltales/post2.mp3.sdcard/traveltales/post3.mp3.sdcard/traveltales/post4.mp3 Se også [2]. I næste afsnit gennemgåes konfigurationsfilens indhold. 2 TravelTales.xml TravelTales applikationens konfigurationsfil er skrevet i et format der kendes som XML. Dette format er specielt velegnet til konfigurationsfiler, fordi det nemt kan håndteres af computere og samtidig er læsbart for et almindeligt menneske. Filer med efternavnet xml er skrevet i XML formatet, men det kræver kun en almindelig tekst editor for at se og redigere indholdet af en xml-fil. Typisk vil man på en Windows maskine bruge Notesblok eller VI på en Linux maskine. En xml-fil kan også vises i en internet browser, f.eks. Internet Explorer eller Firefox. I en browser får man også mulighed for at skjule eller afdække forskellige områder af filens indhold. Herunder er der vist et eksempel på konfigurationsfilen. (Bemærk: Licensnøglen er ikke gyldig) Billede 1: Eksempel på en konfigurationsfil til TravelTales vist i Internet Explorer

3 TravelTales; håndtering af konfigurationsfil 3 (7) Billede 2: Den samme konfigurationsfil hvor licens information og database er skjult Hvis man åbner en xml-fil i en internet browser foretager browseren en syntax kontrol, således at man kan verificere at filen kan læses. I afsnit 3 behandles dette nærmere. Der kan iøvrigt findes mere information om Extensible Markup Language (XML) på internettet f.eks. her: Indholdet af TravelTales.xml I dette afsnit gennemgåes konfigurationsfilen, der vises i Billede 1, linie for linie. De første tre linier i konfigurationsfilen er en fil-header. Den første linie fortæller noget generelt om xml-filen og dens kodning. De to næste linier er kommentar linier, der ikke læses af TravelTales. Selve konfigurationen af TravelTales findes indenfor <TravelTales> markeringen hvor cfgversion-feltet fortæller TravelTales applikationen noget om hvordan indholdet er struktureret. Opdateringer i filens layout vil altid kunne håndteres af ældre versioner af TravelTales, så længe af det første nummer bliver ved med at være 1. Dvs. Den nuværende TravelTales applikation vil kunne læse konfigurationsfiler med versioner op til

4 TravelTales; håndtering af konfigurationsfil 4 (7) I license-området findes oplysningerne om hvem TravelTales applikationen er licenseret til, hvornår licensen blev indhentet og hvor stor database indehaveren har ret til at anvende. Licensnøglen findes til sidst i linien. Licensnøglen er beregnet på baggrund af de tre første parametre, og hvis der foretages ændringer i disse felter (ift. hvad man har modtaget fra Eos-Consult), vil TravelTales kun starte op med en tom database. (Bemærk: Licensnøglen ovenfor er i øvrigt ikke gyldig) Hvis man tilkøber en større database beregnes en ny licensnøgle. Herefter kan man umiddelbart indsætte den nye licensnøgle i konfigurationsfilen og TravelTales vil indlæse en database svarende til den størrelse, der er tilkøbt. Under options finder man nogle generelle opsætningsparametre til TravelTales. Den første parameter, globalaccuracy, fortæller hvor stor nøjagtighed, der skal anvendes. Nøjagtigheden, der er angivet i meter, vil i ovenstående eksempel resultere i, at lyd-filen aktiveres i en radius af 20 meter fra koordinatet. Man kan vælge mellem værdierne 5, 10, 20, 50, 100 og 200. Ift. nøjagtigheden skal man være opmærksom på de forskellige fejlkilder, der kan være og hvilket transportmiddel, der anvendes. Se også [1]. De næste tre parametre finder endnu ikke anvendelse i TravelTales applikationen, men de er allerede nu introduceret i konfigurationsfilen for at kunne understøtte fremtidige funktioner. Parameteren allowreplaylatest benyttes til at afgøre om TravelTales skal tillade at man afspiller den seneste lokation igen. Har man været på lokationen for gudenaavest og har fået afspillet Test_C.mp3 og kommer tilbage til samme lokalitet uden at have været ved andre lokaliteter i mellemtiden vil denne parameter fortælle om TravelTales skal starte lydfilen igen eller ej. Til by-vandringer er det ikke altid ønskværdigt at høre den samme fil igen, mens man under f.eks. et orienteringsløb gerne må få kvitteringen for en post igen. Den sidste parameter, volume, bruges på Symbian platformen til at sætte lydstyrken på telefonen. default indstillingen bruges hvis man ønsker at telefonen selv skal styre lydstyrken. På visse gamle modeller kan telefonen dog ikke gøre dette, og her kan man således anvende indstillingerne verylow (20% af maximum), low (40% af maximum), medium (60% af maximum), high (80% af maximum) og veryhigh (100% af maximum). I blokken kaldet PointsOfInterest findes den egentlige database. Hvert punkt har et unikt navn, et unikt koordinat og en associeret lyd-fil. Koordinatet bruger det format der kaldes Decimal degrees og angiver koordinatet med en ren decimal værdi. Andre formater anvender minutter og sekunder i formatet, men Decimal degrees er meget anvendt i computer sammenhæng og derfor er dette format også anvendt til TravelTales.

5 TravelTales; håndtering af konfigurationsfil 5 (7) Får man behov for at omregne mellem forskellige formater, er der flere steder på internettet, der er ganske udemærket. F.eks. her: Bemærk at latitude (breddegrad) står først og longitude (længdegrad) står sidst. Begge værdier har seks cifre efter komma et som i øvrigt er et punktum med den engelske notation, der bruges i konfigurationsfilen. Breddegrad og længdegrad adskilles af et semikolon. Dette format kaldes i øvrigt RoboGEO tags og flere internet applikationer tilbyder præcist dette format, så det er nemt at kopiere og indsætte i konfigurationsfilen (som vi også vil se i afsnit 3). Bemærk at navnet og koordinatet skal være unikt i konfigurationsfilen, mens to koordinater godt kan anvende den samme lydfil. Bemærk også at xml filen benytter UTF-8 kodning, som ikke gør det muligt at anvende de danske karakterer æ, ø og å. Filtype skal i denne version af TravelTales altid være mp3. Den sidste parameter, accuracy, er endnu ikke taget i anvendelse. 3 Redigering af TravelTales.xml Hvis man vil ændre i konfigurationsfilen gøres dette meget nemt vha. en standard tekst editor f.eks. Notesblok. På nedenstående billede er der blevet tilføjet et nyt punkt til konfigurationsfilen. Billede 3: Redigering af konfigurationsfilen i Notepad Punktet er blevet tildelt det unikke navn Gudenaa-kryds og der er valgt den samme fil, som der afspilles ved punktet Komo. Koordinaterne findes enten ved at man tager en GPS modtager med ud på positionen f.eks. TravelTales applikationen. Man kan også finde mange gode steder på internettet, f.eks.: eller (højre klik på kortet og vælg Hvad er der her? vær opmærksom på at Google maps benytter et komma som adskillelse mellem de to koordinater. TravelTales kræver et semikolon)

6 TravelTales; håndtering af konfigurationsfil 6 (7) Man kan altså lave en hel konfigurationsfil til en hel ny oplevelsestur til TravelTales hjemme ved computeren. Dog anbefales det at teste konfigurationsfilen inden slut brugeren sendes ud på turen. På næste billede er der indsat en markering på punktet, der udgør Gudenaa-kryds. Billede 4: Koordinatet findes... Koordinatet kan nu kopieres og indsættes i konfigurationsfilen: Billede 5:...og indsættes... Nu kan konfigurationsfilen gemmes og anvendes med TravelTales. Inden anvendelsen er det dog god praksis at verificere filen med en internet browser. Den vil vise en fejl meddelelse hvis der er syntax fejl i filen. Hvis man f.eks. ved et uheld har fjernet linien med </PointsOfInterest> i filen vil Internet Explorer give nedenstående fejl meddelelse: Billede 6: Fejlmeddelelse fra Internet Explorer

7 TravelTales; håndtering af konfigurationsfil 7 (7) Hvis filen vises korrekt er der en god chance for at filen også vil virke med TravelTales applikationen. Billede 7: Den færdige konfigurationsfil 4 Referencer [1] DE : TravelTales; Transportation and accuracy [2] DE : Introduktion i brug af TravelTales