Glitre

10.09.2010

Fra «plugins» til «formats»

Filed under: API — magnusenger @ 12:30

Glitre har lidd litt under at kodesnuttene som formaterer bibliografiske poster både har vært omtalt som «formats» og «plugins». Dette skal det nå være ryddet opp i, slik at «format(s)» brukes over hele linja. Følgende endringer er gjort:

  • Mappa med snuttene er omdøpt fra «plugin» til formats»
  • «format» beholdes som argument i APIet, og «plugin.» fjernes fra verdiene, slik at man bruker format=simple, ikke format=plugin.simple

Samtidig er det lagt til en liste med tillatte formater i config.php, som en ekstra sikkerhetsforanstaltning og slik at det skal være mulig å slå formater av og på, uten å slette eller flytte filer:

$c['allowed_formats'] = array('simple', 'isbn-plain');

Denne navneendringen åpner også for at feks koden som knytter Glitre til Öppna bibliotek (neste fase i utviklingen) kan kalles en plugin, noe som faller mer naturlig enn den navnebruken som har forekommet til nå.

Advertisements

19.08.2010

API-demo

Filed under: API — magnusenger @ 11:18

Så langt har denne bloggen sagt en del om utviklingen av Glitre, men den eneste måten å se endringene på har vært gjennom kildekoden. Nå kan vi endelig avduke en «live» demo:

http://oppdrag.libriotech.no/glitre/api/

Prøv for eksempel en forespørsel som denne:

http://oppdrag.libriotech.no/glitre/api/?library=deich&q=ibsen

For å gjøre det lettere å se hvilke parametere som er obligatoriske og valgfrie, hvilke valgmuligheter som finnes format osv er det laget en «guide» til APIet her:

http://oppdrag.libriotech.no/glitre/api/guide.php

NB! Denne installasjonen brukes til aktiv utvikling, så til tider vil det være ting som ikke fungerer som de skal, og det vil helt sikkert komme endringer i navn på parametere osv. En liste over kjente feil og mangler finnes på GitHub. Etter hvert vil det bli to tilgjengelige demoer: en som kjører relativt stabil kode og en der aktiv utvikling skjer. Vi kommer tilbake med detaljer om dette etter hvert.

2.08.2010

Include eller API? Ja takk, begge deler!

Filed under: API — magnusenger @ 11:04

Tanken med Glitre var i utgangspunktet at komponenten som utvikles skulle være en «include», dvs en PHP-fil som kan inkluderes i en annen PHP-fil og gjøre en del funksjoner tilgjengelige for koden i den inkluderende fila.

Allerede tidlig i arbeidet ble det imildertid klart at det ikke vil være mye vanskeligere å bygge et API på toppen av includen, slik at Glitre får muligheten til å «snakke» med kode som ikke nødvendigvis kjører på den samme maskinen som Glitre selv. Dette er dels nyttig for å teste Glitre – man kan kjøre søk gjennom Glitre og få ut trefflista som feks XML, dels kan det gjøre det enklere å ta i bruk Glitre. Dersom man ikke har tilgang til å installere de komponentene som er nødvendige for at Glitre skal fungere på den maskinen der man trenger funksjonaliteten vil man kunne installere den på et annet, egnet sted, og så benytte APIet for å hente de dataene man trenger.

Tanken er at APIet skal kunne returnere data i ulike MARC-format, XML, JSON osv. Denne Funksjonaliteten vil bli implementert i form av «plugins» – dvs at prosjektet kanskje ikke rekker å implementere all tenkelig funksjonalitet, men at det ihvertfall skal foreligge et rammeverk som skal gjøre det så enkelt som mulig å få den på plass etter hvert.

Opprett en gratis blogg eller et nettsted på WordPress.com.