Il formato XML. Versione Aprile Roberto Tua. Hyperfilm - Il formato XML pag. 1 di 25

Transcript

1 Il formato XML Versione Aprile 2013 Roberto Tua Hyperfilm - Il formato XML pag. 1 di 25

2 Indice generale Glossario...3 Introduzione La struttura del documento Il nodo <info> Il nodo <media> Il nodo <hyperlinks>...8 Il nodo <hyperlink>...8 Il nodo <label>...9 Il nodo <resources>...10 Il nodo...10 Il nodo <hotspot>...12 Il nodo <shape>...13 Il nodo <vertex>...13 Il nodo <resources> dell'elemento <hotspot> Funzionalità estese...15 Il glossario iperfilmico...15 Il formato XML del glossario...15 Le funzionalità di tracking Convenzioni sui nomi Il contenuto di tipo slideshow...18 Il formato XML della risorsa slideshow Il formato della risorsa htmltext Caratteri riservati XML Formato dei valori esadecimali Esempio di documento iperfilmico XML...22 Hyperfilm - Il formato XML pag. 2 di 25

3 Glossario XML Tag xml Elemento o nodo Attributo Hyperlink Link iperfilmico Documento XML ben formato Sistema numerico esadecimale L'XML, acronimo di extensible Markup Language, ovvero «linguaggio di marcatura estensibile» è uno standard del World Wide Web Consortium (W3C). Non è un linguaggio di programmazione ma un meta-linguaggio che permette di creare la grammatica necessaria a descrivere un qualunque insieme di dati alfanumerici strutturati. Elemento semantico basilare del linguaggio XML e dei cosiddetti linguaggi di marcatura (HTML, XHTML, SGML, ). Un tag è formato da un termine identificativo racchiuso tra i segni < e >. Ogni tag deve essere completato dalla sua chiusura, ovvero lo stesso tag con il termine preceduto dal carattere /. Esempi di tags: <marca>fiat</marca> <modello>panda</modello> I nomi dei tags non possono iniziare con numeri o caratteri speciali e non possono contenere spazi. Unità informativa definita da un tag di apertura e da un tag di chiusura. Un elemento ne può contenere altri a piacere, rispettando il principio di bilanciamento dei tags. Esempio: elementi nome e cognome. <nome>luigi</nome> <cognome>rossi</cognome> Gli elementi sono anche detti nodi. Informazione accessoria che può essere associata a un elemento delimitato da tag. Assume la forma di nome_attributo= valore attributo all interno del tag di apertura. Esempio di attributo: <nome soprannome= Gino >Luigi</nome> <cognome>rossi</cognome> In informatica abbreviazione di hypertext link o collegamento ipertestuale; è caratteizzato da una àncora, una o più parole sensibili e variamente evidenziate (colore, sottolineatura...), e una destinazione, ovvero un altro contenuto ad essa correlato che sarà visualizzato in seguito all'azione dell'utente. Si riferisce alla interpretazione di Hyperfilm del concetto di hyperlink applicato al video. Sostanzialmente un link iperfilmico utilizza, quale àncora dell'hyperlink, un valore temporale riferito alla linea temporale del video, e fornisce una struttura per organizzare le destinazioni relative (l'elenco dei link a fianco del video). È un documento XML che rispetta le regole definite dallo standard e non contiene errori di sintassi. Basilarmente un documento XML è ben formato (well-formed) quando ha un solo nodo radice, tutti i tags rispettano le regole grammaticali imposte, sono bilanciati e senza errori di annidamento. Il sistema numerico esadecimale (spesso abbreviato come esa o hex) è un sistema numerico posizionale in base 16, che utilizza cioè 16 simboli invece dei 10 del sistema numerico decimale tradizionale. Per il sistema numerico esadecimale si usano i simboli da 0 a 9 e poi le lettere da A a F, per un totale di 16 simboli. Hyperfilm - Il formato XML pag. 3 di 25

4 Introduzione La struttura del documento XML usato da Hyperfilm è piuttosto semplice e di facile editing. Questa guida ha lo scopo di illustrarne le caratteristiche, documentare i tags utilizzati e mettere in relazione i dati associati ai tags con il loro utilizzo da parte di Hyperfilm Player. Per la creazione e l editing dei documenti XML è sufficiente un semplice programma per l elaborazione di testi, come NotePad o WordPad. Si consiglia tuttavia l utilizzo di un XML editor specifico, in grado di rendere più semplice l'intervento sulla struttura del documento. Xml visualizzato con Microsoft NotePad Xml visualizzato con Microsoft XML NotePad L'uso di alcuni caratteri nei valori di attributi ed elementi XML è riservato. Per una descrizione dei caratteri riservati e delle relative entità di sostituzione vedi il capitolo 9 - Caratteri riservati XML. Hyperfilm - Il formato XML pag. 4 di 25

5 1. La struttura del documento La struttura di un documento iperfilmico è una struttura ad albero formata dal nodo radice <hyperfilm> e tre nodi subordinati di primo livello: <info>, <media> e <hyperlinks>. La struttura di base del documento iperfilmico <?xml version="1.0" encoding="utf-8"?> <hyperfilm> <info> sezione info </info> <media> sezione media </media> <hyperlinks> sezione hyperlinks </hyperlinks> <hyperfilm> Il nodo <header> contiene le informazioni descrittive riguardanti il documento, come il titolo e un numero opzionale di altre informazioni ritenute indispensabili dall'autore o dall'editore. Il nodo <media> contiene il nome del video oggetto di iperfilmizzazione e le preferenze dell'autore o dell'editore relative alle modalità di utilizzo permesse. Il nodo <hyperlinks> contiene un numero arbitrario di elementi di tipo <hyperlink>; costituisce il corpo principale del documento iperfilmico. Hyperfilm - Il formato XML pag. 5 di 25

6 2. Il nodo <info> <?xml version="1.0" encoding="utf-8"?> <hyperfilm> <info> <info_0 label="titolo"> Titolo iperfilm </info_0> <info_1 label="nome informazione"> testo </info_1> <info_2 label="nome informazione"> testo </info_2> </info> <hyperfilm> <info_n label="nome informazione"> testo </info_n> Nella sezione <info> solo il primo elemento è obbligatorio perchè utilizzato come titolo del documento. Tutti gli altri elementi sono opzionali e possono essere aggiunti in numero arbitrario allo scopo di fornire informazioni sullo specifico documento. I diversi elementi <info> sono caratterizzati dall attributo label che ha lo scopo di fornire il nome della proprietà informativa descritta. Struttura del nodo <info> Elemento Valore Attributo Valore info_0 info_1 Il titolo dell iperfilm L'informazione da comunicare label label info_n L'informazione da comunicare label Il testo visualizzato come nome della proprietà. Il testo visualizzato come nome della proprietà. Il testo visualizzato come nome della proprietà. Nella figura a lato un esempio dell'utilizzo della sezione <info> nelle Informazioni sul documento di Hyperfilm Player. Si notano in blu i valori degli attributi label, mentre sotto, in nero, i valori degli elementi <info>. Hyperfilm Player è in grado di riconoscere nei valori dei tags della sezione <info>, eventuali indirizzi Internet e renderli automaticamente attivi. Hyperfilm - Il formato XML pag. 6 di 25

7 3. Il nodo <media> Il nodo <media> raccoglie i dati riguardanti il video principale e le opzioni ammesse nell'esecuzione del documento iperfilmico. Vengono inoltre definiti alcuni elementi opzionali associati al video quali il glossario e il tracciamento dell'utilizzo dell'iperfilm in ambienti di e-learning; vedi Cap. 5 Funzionalità estese. <?xml version="1.0" encoding="utf-8"?> <hyperfilm> <media> <video> </video> <autostart> </autostart> <stoponlink> </stoponlink> <mappointsize> </mappointsize> <glossaryid> </glossaryid> <trackingurl> </trackingurl> <trackingid> </trackingid> </media> <hyperfilm> Riepilogo elementi nodo <media> Elemento Tipo Valore/Descrizione video autostart stoponlink mappointsize glossaryid trackingurl trackingid String Boolean Boolean Number String URL String Il nome o il percorso del video principale (vedi Cap. 6 - Convenzioni sui nomi). Valore ammesso: true o false. Indica al Player se il video principale deve essere eseguito automaticamente o aspettare l'azione dell'utente sul pulsante Play. Valore ammesso: true o false. Indica se il video principale deve fermarsi alla nascita di un nuovo link oppure continuare l'esecuzione. Valore minimo e di default: 4. Valore massimo: 12. Il raggio in pixel dei marker circolari sulla barra del video che indicano la presenza di link. Il nome o il percorso del documento XML che contiene i dati del glossario associato al video (vedi Cap. 5.1 Il glossario iperfilmico). L'indirizzo della pagina PHP che contiene l'interfaccia per ricevere i dati che il Player invia per il tracciamento dell'utilizzo del documento da parte dell'utente. Richiede l'esistenza di una piattaforma server-side in grado di gestire i dati inviati. Il nome identificativo che rappresenta l'iperfilm corrente all'interno della piattaforma serverside. Hyperfilm - Il formato XML pag. 7 di 25

8 4. Il nodo <hyperlinks> <hyperfilm> <hyperlinks> <hyperlink> </hyperlink> <hyperlink> </hyperlink> <hyperlink> </hyperlink> </hyperlinks> <hyperfilm> Il nodo <hyperlinks> contiene un numero arbitrario di elementi <hyperlink>. Ogni elemento <hyperlink> descrive i dati di un singolo collegamento iperfilmico. La sezione può essere vuota (non contenere alcun elemento <hyperlink>), ma va dichiarata ugualmente.; in questo caso Hyperfilm Player tratta il video come semplice contenuto da eseguire e non viene generata la lista dei link laterali. Di seguito il dettaglio degli elementi costitutivi di un nodo <hyperlink> Il nodo <hyperlink> Ogni nodo <hyperlink> contiene le informazioni necessarie al Player per gestire uno specifico link iperfilmico in rapporto alla timeline del video principale, nonché per gestire i contenuti del link e permetterne l'accesso e l'utilizzo da parte dell utente. Ogni nodo <hyperlink> è costituito da quattro elementi semplici e due nodi subordinati, <label> e <resources>. <hyperlinks> <hyperlink> <type> </type> <time> </time> <title> </title> <description> </description> <label> </label> <resources> </resources> </hyperlink> </hyperlinks> Hyperfilm - Il formato XML pag. 8 di 25

9 Riepilogo elementi nodo <hyperlink> Elemento Tipo Valore/Descrizione type time string number title string Il titolo del link description label resources string XML node XML node Il nodo <label> Valore di default: slink. È, per ora, l'unico tipo di link gestito. Il tempo a cui compare il link sulla timeline del video principale. È espresso in secondi e formato da una parte intera e una decimale fino alla terza cifra (millesimi di secondo). Ad esempio è 12 secondi e 325 millesimi di secondo dall inizio del video. Il tempo 3 min e 12 sec è uguale a secondi ovvero 3 x secondi. Le frazioni decimali possono essere omesse se uguali a zero; può diventare La descrizione sintetica, visibile nel pannello del link una volta selezionato dall'utente, e posizionata tra il titolo e la lista dei contenuti. Nodo che contiene informazioni riguardanti alcuni aspetti visuali del link (vedi paragrafo successivo). Nodo che contiene le informazioni sui contenuti associati al link e visualizzabili dall utente in diverse modalità. Contiene le informazioni per gestire l'aspetto del link al momento della sua generazione e poi nella nella lista dei link. È possibile utilizzare qualunque combinazione di colori per caratterizzare l'aspetto dei link. <hyperlink> <type> </type> <time> </time> <title> </title> <description> </description> <label> <type> </type> <box_color> </box_color> <text_color> </text_color> </label> Elementi nodo <label> Elemento Tipo Valore/Descrizione type box_color text_color integer hex number hex number Valore obbligatorio: 1. Rappresenta il tipo di animazione con la quale il Player genera visualmente il link. Il colore di sfondo del link. Il colore del testo del link. Hyperfilm - Il formato XML pag. 9 di 25

10 Il nodo <resources> Il nodo <resources> è il nodo in cui sono registrati i dati dei contenuti associati al link (nella terminologia ipertestuale la destinazione del link) e disponibili attraverso il Player. Nel caso del link iperfilmico la destinazione non è unica ma multipla e costituita un numero arbitrario di destinazioni, ognuna rappresentata da un nodo di tipo oppure <hotspot>. Sia l'elemento che l'elemento <hotspot> sono a loro volta nodi xml che contengono le specifiche informazioni riguardanti il singolo contenuto collegato oppure una struttura più complessa, l'<hotspot>, dedicata a documentare una specifica area del fotogramma nel video corrispondente al tempo del link. <resources> <hotspot> </hotspot> <hotspot> </hotspot> </resources> Il nodo I nodi rappresentano le informazioni necessarie per referenziare ogni singolo contenuto associato a un link. Poichè è possibile associare contenuti anche agli <hotspot> la stessa struttura sarà anche utilizzata nella definizione di questi particolari elementi (vedi Il nodo <hotspot>). <type> </type> <content> </content> <caption> </caption> Elementi del nodo Elemento Tipo Valore/Descrizione type string Valori ammessi: htmltext image slideshow video audio exercise catalog Il tipo di contenuto puntato dal link. Eccetto i tipi url e file tutti gli altri sono gestiti internamente dal Player. Per una descrizione dettagliata dei vari tipi di contenuto e sulle modalità di interazione permesse vedi il Manuale del Player Hyperfilm. url file hotspot content string Il nome del file o l'url del contenuto. caption string Il nome descrittivo del contenuto, visualizzato dal Player. Hyperfilm - Il formato XML pag. 10 di 25

11 Formati di files supportati nel tag <content> del nodo Type Content Valore/Descrizione htmltext image slideshow video audio ASCII text file image file XML file video file audio file Il nome del file ASCII contenente il testo con i tag HTML supportati. Estensione file: txt. Per un approfondimento sui tag HTML supportati vedi l'addendum HTML Text. Il nome del file dell'immagine da visualizzare. Formati supportati: jpg, gif, png. Il nome del file con il codice XML rappresentante lo slideshow di immagini. Estensione file: xml. Il nome del file video da riprodurre. Formati supportati: flv, f4v. Il nome del file audio da riprodurre. Formati supportati: mp3. url web url Ogni indirizzo Internet valido. file hotspot file generico XML node Il nome di un file in qualunque formato, da visualizzare all'interno del browser Internet dell'utente. Per alcuni file è necessario che l'utente abbia installate nel proprio sistema le risorse necessarie alla visualizzazione. Nodo XML contenente le informazioni per disegnare una forma geometrica sul fotogramma del video corrispondente al tempo del link. Alla forma geometrica è assegnata una propria lista di elementi. Esempi di nodi <type>video</type> <content>console.flv</content> <caption>come si usa una console</caption> <type>slideshow</type> <content>presentazione.xml</content> <caption>i diversi tipi di leve</caption> <type>url</type> <content> <caption>un punto di vista interessante sull argomento</caption> Hyperfilm - Il formato XML pag. 11 di 25

12 Il nodo <hotspot> Un nodo <hotspot> è costituito da un certo numero di elementi che descrivono le sue proprietà spazio-visuali e da due nodi subordinati: un nodo <shape>, contenente le informazioni sulla forma geometrica e un nodo <resources> contenente una lista, di lunghezza arbitraria, di elementi. <hotspot> <title> </title> <description> </description> <fill_color> </fill_color> <stroke_color> </stroke_color> <stroke_width> </stroke_width> <loc_horiz> </loc_horiz> <loc_vert> </loc_vert> <rotation> </rotation> <fill_alpha> </fill_alpha> <stroke_alpha> </stroke_alpha> <shape> </shape> <resources> </resources> </hotspot> Elementi del nodo <hotspot> Elemento Tipo Valore/Descrizione title string Il nome o titolo dell'hotspot. description string Il testo della descrizione dell'hotspot. fill_color stroke_color stroke_width loc_horiz loc_vert hex number hex number integer integer integer Il colore di riempimento dell'hotspot (es. 0x00004F). Il colore del bordo dell'hotspot (es. 0xFF0000). Lo spessore del bordo in pixel. Il valore 0 (zero) indica l'assenza di bordo. La posizione orizzontale rispetto al fotogramma del video. Indica la distanza in pixel dal bordo sinistro del video al centro dell hot spot. La posizione verticale dell hot spot rispetto al fotogramma del video. Indica la distanza in pixel dal bordo superiore del video al centro dell hot spot. rotation integer La rotazione dell'hotspot da 0 a 360. fill_alpha stroke_alpha integer integer shape XML node resources XML node La trasparenza del riempimento dell hot spot da 0 a 100 (0: trasparenza completa, 100: opacità completa). La trasparenza del bordo dell hot spot da 0 a 100 (0: trasparenza completa, 100: opacità completa). Nodo che contiene informazioni riguardanti la forma e le dimensioni dell'hotspot. Nodo che contiene le informazioni sui contenuti associati all'hotspot. Hyperfilm - Il formato XML pag. 12 di 25

13 Il nodo <shape> Il nodo <shape> contiene un elenco di lunghezza arbitraria di nodi <vertex> utili, nel loro insieme, per descrivere la forma geometrica dell'hotspot. Ogni nodo <vertex> comprende a sua volta due elementi <point> e <handle> che descrivono le coordinate del punto e la curvatura del segmento corrispondente. <shape> <vertex> <vertex> </shape> Il nodo <vertex> Il nodo <vertex> è formato da due elementi che descrivono la posizione del vertice in forma di coordinate x,y rispetto all'angolo superiore sinistro della forma, posto al valore 0,0. Attualmente l unico elemento utilizzato è il tag <point>, mentre il tag <handle> è riservato per future implementazioni secondo il modello di curva quadratica di Bèzier. <vertex> <point> </point> <handle> </handle> Elementi del nodo <vertex> Elemento Tipo Valore/Descrizione point handle point point Esempio di notazione di hot-spot rettangolare La posizione del vertice rispetto all'angolo superiore sinistro dell'hot-spot stesso. È espressa in pixel come coppia di coordinate x,y separate da una virgola (es. 3,4). Letteralmente maniglia. Corrisponde al punto di controllo di una curva quadratica di Bèzier per quel vertice. È espressa in pixel come coppia di coordinate x,y separate da una virgola (es. 24,- 66). Al momento il suo valore è inutilizzato ma esiste per usi futuri. Utilizzare sempre il valore di default 0,0. ➊ ➍ 0,0 100,0 ➋ ➌ x <vertex> ➊, <point> 0,0 </point> <handle> 0,0 </handle> <vertex> ➋, <point> 100,0 </point> <handle> 0,0 </handle> <vertex> ➌, <point> 100,80 </point> 0,80 100,80 <handle> 0,0 </handle> y <vertex> ➍, <point> 0,80 </point> <handle> 0,0 </handle> Hyperfilm - Il formato XML pag. 13 di 25

14 Il nodo <resources> dell'elemento <hotspot> Il nodo <resources> è il nodo in cui sono registrati i dati dei contenuti utilizzati per documentare il particolare visivo nel fotogramma, delimitato dalla forma dell'hotspot. È lo stesso tipo di elemento già visto nel capitolo 3.1.2, solo questa volta non associato direttamente al link ma a un elemento subordinato <hotspot>. Contiene un elenco di lunghezza arbitraria di elementi e si utilizza nello stesso modo visto precedentemente (vedi il capitolo Il nodo <resources>). <resources> </resources> Esempio di link con hot-spot Si può notare come sia possibile utilizzare più elenchi di contenuti all'interno dello stesso link. Un primo elenco è quello standard, associato al link e che in questo caso comprende una sola voce: Scheda Giovanni Pisano. Altri due elenchi sono associati ai due hot-spot sul fotogramma del video (uno per il quadrato rosso e uno per quello giallo). Gli elenchi di contenuti (nel caso del quadrato rosso una sola voce: Ingrandimento ), compaiono al passaggio del mouse sull'area interessata. Hyperfilm - Il formato XML pag. 14 di 25

15 5. Funzionalità estese Hyperfilm Player è in grado di gestire alcune funzionalità ulteriori rispetto alla gestione dei link iperfilmici associati a un video. Le funzionalità in questione riguardano la gestione di un glossario associato al video e la la possibilità di dialogare con una piattafoma di e-learning, allo scopo di tracciare l'utilizzo di un iperfilm da parte dell'utente Il glossario iperfilmico Il glossario è uno strumento opzionale che ha lo scopo di fornire un supporto informativo ulteriore alla visione del video. Raccoglie e organizza un numero arbitrario di glosse. Le glosse pur essendo concettualmente diverse dai normali link iperfilmici, possono anch'esse essere sincronizzate alla esecuzione del video, con una loro specifica modalità: Hyperfilm Player è in grado di segnalare visivamente la pronuncia vocale di un termine presente nel glossario e facilitare l'accesso alla glossa corrispondente Il formato XML del glossario <?xml version="1.0" encoding="utf-8"?> <glossary> <glosses> <item time="0" title=" " text=" "/> <item time="0" title=" " text=" "/> <item time="0" title=" " text=" "/> </glosses> </glossary> Il formato xml è formato dal nodo radice <glossary> e dal nodo subordinato <glosses> quale contenitore di un numero arbitrario di nodi <item>. Ogni nodo <item> è caratterizzato da tre attributi che organizzano i dati relativi alla singola glossa. Riepilogo struttura di elemento <item> Attributo Tipo Valore/Descrizione time integer Il tempo, riferito al video principale, al quale viene pronunciato il termine del glossario. È espresso in secondi e formato da una parte intera e una decimale fino alla terza cifra (millesimi di secondo). Ad esempio è 12 secondi e 325 millesimi di secondo dall inizio del video. Il tempo 3 min e 12 sec è uguale a secondi ovvero 3 x secondi. Le frazioni decimali possono essere omesse se uguali a zero; può diventare title string Il nome della glossa text string Il testo descrittivo della glossa Hyperfilm - Il formato XML pag. 15 di 25

16 5.2. Le funzionalità di tracking Hyperfilm Player è in grado di comunicare a un database remoto le informazioni essenziali riguardo l'utilizzo dell'iperfilm da parte dell'utente. La funzionalità richiede l'esistenza di una piattaforma in grado di gestire il database e l'interfaccia necessaria allo scambio dei dati. Il meccanismo è regolato dai due elementi <trackingurl> e <trackingid> della sezione <media> nel documento iperfilmico. Hyperfilm Player, all'apertura del documento, esamina il tag <trackingurl>: se questo è diverso da "no" ed è presente un indirizzo valido ad una pagina PHP di interfaccia verso il database che accoglierà i dati, la funzionalità viene attivata. (es. <trackingurl> La funzionalità integra le normali attività di registrazione delle modalità di utilizzo dei propri contenuti da parte di una piattaforma di e-learning. Tra queste l'ora e la data di apertura e chiusura di un certo contenuto, allo scopo di registrare il tempo speso dall'utente nel suo utilizzo. Hyperfilm Player permette di dettagliare ulteriormente la dunzionalità di tracciamento, segnalando alla piattaforma di e-learning l'ora e la data di apertura e chiusura di ogni link del documento iperfilmico eseguito. Come per gli altri contenuti formativi la piattaforma provvede poi a incrociare i dati relativi all'utilizzo di un iperfilm con i risultati dei test associati al modulo formativo; in caso di risultati negativi l'analisi delle modalità di utilizzo potrebbe fornire utili indicazioni per il recupero. In particolare, Hyperfilm Player invia, all'apertura e alla chiusura di ogni link, le informazioni riportate nella tabella sottostante utilizzando il metodo POST. Riepilogo variabili inviate via HTTP col metodo POST Variabile Tipo Valore hfid string Il nome convenzionale assegnato nel tag <trackingid> della sezione <media> e utilizzato nel database per riconoscere l'iperfilm. linkid integer Il numero (ordinale) del link linkname string Il titolo del link linkop string Il tipo di azione dell'utente (può essere OPEN o CLOSE ) timestamp string Data e ora nel formato aaaa-mm-gg hh-mm-ss (es :12:31) Hyperfilm - Il formato XML pag. 16 di 25

17 6. Convenzioni sui nomi I nomi dei files utilizzati per il video principale, nonché quelli inseriti nei <content> degli elementi sono generalmente utilizzati come percorsi di file relativi, adottando la convenzione che la radice principale sia la cartella che raccoglie tutti i contenuti dell'iperfilm. Un iperfilm è convenzionalmente costituito dal file xml che organizza le informazioni relative ai link e dall'esistenza dei diversi contenuti, compreso il video priincipale, esistenti localmente o posizionati in rete. La cartella (directory) che contiene tutti i diversi file di un iperfilm è indicata: nella flashvar docid della pagina html che pubblica l'iperfilm. In questo caso l'iperfilm è eseguito dal Player in forma di plugin del browser Internet (hfpwrplayer.swf); nel file hfpid.txt che accompagna l'iperfilm nel caso questo sia eseguito dal Player in forma di applicazione stand-alone (hfpwrplayer.exe oppure hfpwrplayer.app) in entrambi i casi il valore di docid, cioè il nome della cartella nella quale si trova il documento xml (e tutti gli altri contenuti dell'iperfilm), deve essere relativo alla posizione corrente del Player, sia esso nel formato.swf oppure.exe. Ulteriore convenzione vuole che il nome della cartella corrisponda anche al nome del documento iperfilmico (in formato xml) in essa contenuto. Ad esempio, se nella flashvar della pagina html compare il nome mioiperfilm significa che esiste una cartella di nome mioiperfilm nella stessa posizione in cui si trova il Player e che all'interno di quella cartella esiste un documento mioiperfilm.xml con i dati attesi. <param name="flashvars" value="docid=mioiperfilm"> Nell'esempio seguente nomevideo.flv senza altre indicazioni significa che il file nomevideo.flv è nella radice principale della cartella dell'iperfilm. <media> <video>nomevideo.flv</video> </media> Se il nome del video fosse stato notato come segue il Player avrebbe cercato il file nomevideo.flv all'interno della cartella video, a sua volta interna alla cartella dell'iperfilm. <media> <video>video/nomevideo.flv</video> </media> Sono accettati indirizzi Internet (http, https, ftp e rmtp), fatte salve le restrizioni di sicurezza legate all'accesso a contenuti esterni alla sandbox in cui è posizionato l'iperfilm. <media> <video> </media> Hyperfilm - Il formato XML pag. 17 di 25

18 7. Il contenuto di tipo slideshow La risorsa slideshow serve per organizzare un gruppo di immagini in modalità presentazione. A ogni singola immagine possono essere associati un file audio (generalmente una registrazione vocale) e un file da scaricare (generalmente la stessa immagine in alta risoluzione). Tutte le informazioni riguardanti uno slideshow sono organizzate in un file XML il cui nome costituisce il valore del tag <content> dell'elemento. <type>slideshow</type> <content>uso_acqua.xml</content> <caption>le dieci regole per l'uso dell'acqua</caption> 7.1. Il formato XML della risorsa slideshow La struttura XML di uno slideshow è formata dal nodo radice <Slides> che comprende una lista di lunghezza arbitraria di elementi <slide>. Ogni elemento <slide> non ha un valore definito ma possiede diversi attributi che raccolgono e organizzano i dati di tutti gli elementi costitutiti della slide. <?xml version="1.0" encoding="utf-8"?> <Slides> <slide title=" " media=" " audio=" " autoplay=" " filetodownload=" " audiotext=" " /> <slide title=" " media=" " audio=" " autoplay=" " filetodownload=" " audiotext=" " /> <slide title=" " media=" " audio=" " autoplay=" " filetodownload=" " audiotext=" " /> </Slides> Riepilogo attributi elemento <slide> Variabile Tipo Valore title string Il titolo della slide. media string Il nome dell'immagine in formato jpg, gif o png. audio string Il nome del file audio associato alla slide in formato mp3. autoplay string Indica se il file audio deve essere eseguito all'apertura della slide o attendere l'azione dell'utente. Valori ammessi: yes, no. filetodownload string Il nome del file da scaricare, associato alla singola slide. Deve essere un file compresso in formato zip. audiotext Un testo descrittivo o il testo letto nel file audio. Hyperfilm - Il formato XML pag. 18 di 25

19 8. Il formato della risorsa htmltext La risorsa htmltext ha lo scopo di permettere l'utilizzo di pagine in grado di supportare la formattazione basilare del testo nonché le sue spaziature, l'utilizzo di immagini, tabelle ed elenchi puntati o numerati, direttamente all'interno del Player, senza utilizzare il browser Internet. Anche in questo caso il valore del tag <content> dell'elemento descrive il nome del file di testo utilizzato. <type>htmltext</type> <content>mio_documento.txt</content> <caption>il titolo del documento</caption> È importante notare che il documento referenziato non è una pagina in formato HTML ma semplicemente di un file di testo con alcuni tags html utili per la sua formattazione. Non includere headers o altri elementi tipici della struttura di un file HTML. Esempio di formattazione del testo nella risorsa htmltext. <font face="times" size="14" color="#111111"> <b>titolo della pagina</b> <font face="verdana" size="12" color="#666666"> <b>sottotitolo</b> Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation <a href=" target="_blank"><font color="#0f00cc"><u>nome SITO</u></font></a> ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</br></br><img src="htmlnotes/img.jpg" id='img0' width="167" height="48"></img><font face="times" size="14" color="#093360"> Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet...</br> Hyperfilm - Il formato XML pag. 19 di 25

20 Html tags supportati in htmltext Tipo tag Sintassi Attributi Descrizione Àncora <a> href target Crea un link ipertestuale. Esempio: <a href=' target='_blank'>visita il sito</a> Formatta il testo come grassetto. Grassetto <b> Esempio: <b>lorem ipsum..</b> Interruzione di riga <br> Interruzione di riga. Il tag di chiusura </br> è opzionale. Esempio: "Prima riga di testo.<br>seconda riga di testo..." face Usato per specificare un font o una lista di font nel disegno del testo. Carattere <font> color size Esempio: <font size= 24 color= #0000FF face= Arial Black >Testo blu in Arial Bold</font> Immagine <img> src id width height Carica una immagine esterna e la posiziona nel testo. Esempio: <img src="hyperfilmdir/images/img1.jpg" id='img0' width="167" height="48"></img> align hspace vspace È necessario specificare il pathname dell'immagine a partire dalla posizione del Player, comprendendo il nome della cartella dell'iperfilm. Formatta il testo come corsivo. Corsivo <i> Esempio: <i>lorem ipsum..</i> Elemento di lista <li> Permette di creare liste di elementi posizionando un bullet davanti al testo. Esempio: <li>uno</li> <li>due</li> Paragrafo <p> align class Crea un nuovo paragrafo. Esempio: <p align= center class= h1 >Paragrafo centrato</p>. Span <span> Utilizzato per definire aree di testo particolari generalmente in associazione a un foglio di stile (CSS). Formato testo <textformat> blockindent indent leading leftmargin rightmargin Permette di creare un sottoinsieme di proprietà di paragrafo secondo la classe textformat di Flash. Consultare la documentazione Adobe Flash per maggiori dettagli. tabstops Formatta il testo come sottolineato. Sottolineato <underline> Esempio: <u>lorem ipsum..</u> Hyperfilm - Il formato XML pag. 20 di 25

21 9. Caratteri riservati XML Nel testo xml che costituisce il valore di elementi e attributi non sono ammessi alcuni caratteri riservati che, se utilizzati impropriamente, potrebbero causare errori nell'interpretazione del documento da parte del Player. Utilizzare, soprattutto se si procede all'editing del file xml con un semplice text editor, le corrispondenti entità di sostituzione al posto dei caratteri non ammessi. Per entità di sostituzione si intende un gruppo di caratteri, preceduti dal carattere & e chiusi dal carattere ;. Caratteri riservati Carattere Entità di sostituzione Descrizione < < Minore di > > Maggiore di & & e commerciale ' &apos; Apostrofo " Doppie virgolette E' necessario specificare che differentemente dai caratteri <, > e &, che sono sempre vietati all'interno di tutto il documento XML, i caratteri ' e " devono essere obbligatoriamente sostituiti dalle rispettive entità solo se presenti nel valore di un attributo delimitato dallo stesso carattere, come nel seguente esempio: <nodo attributo='l'apostrofo'/> diventa <nodo attributo='l&apos;apostrofo'/> 10. Formato dei valori esadecimali Nei tag <box_color>, <text_color>, <fill_color> e <stroke_color> il valore immesso deve essere espresso in formato esadecimale secondo la notazione 0x000000, dove i primi due caratteri sono il prefisso e i restanti sei definiscono a coppie il valore numerico delle componenti del colore, secondo lo standard RGB. Ogni coppia di numeri esadecimali può dunque rappresentare un valore qualunque tra 0 e 255 in formato decimale. Al valore 0x corrisponde il nero mentre 0xFFFFFF è il bianco. Notazione esadecimale dei colori RGB 0x da 00 a FF da 00 a FF da 00 a FF prefisso rosso verde blu Esempio colore arancione: 0x Per ricavare i valori numerici esadecimali dei colori da utilizzare può essere utile sfruttare la color wheel di un qualunque programma grafico. Hyperfilm - Il formato XML pag. 21 di 25

22 11. Esempio di documento iperfilmico XML <?xml version="1.0" encoding="utf-8"?> <hyperfilm> <header> <info0 label="titolo">exempla. LA RINASCITA DELL'ANTICO NELL'ARTE ITALIANA.</info0> <info1 label="video copyright"> Copyright Associazione Meeting per l'amicizia fra i popoli - Via Flaminia 18, Rimini, Italia</info1> <info2 label="autore">workshop</info2> <info3 label=" ">meeting@meetingrimini.org</info3> <info4 label="sito Web"> <info5 label="note">il presente materiale è stato realizzato a scopo puramente dimostrativo e finalizzato alla didattica del formato XML di Hyperfilm.</info5> <info8 label="licenza d'uso">creative Common: Attribution, Non-commercial, No Derivatives</info8> </header> <media> <video>exempla.flv</video> <autostart>true</autostart> <stoponlink>false</stoponlink> <mappointsize>6</mappointsize> <glossaryid>no</glossaryid> <trackingurl>no</trackingurl> <trackingid>none</trackingid> </media> <hyperlinks> <hyperlink> <type>slink</type> <time>9</time> <title>presentazione della mostra</title> <description>la mostra esamina alcuni aspetti del grandioso fenomeno della ripresa dei modelli classici nell arte italiana medievale, partendo dall epicentro della cultura federiciana di Castel del Monte.</description> <label> <animation_type>1</animation_type> <box_color>0xcc6600</box_color> <text_color>0xffffff</text_color> </label> <resources> <type>file</type> <content>presentazione.pdf</content> <caption>presentazione</caption> <type>file</type> <content>servizi_scuole/servizi.pdf</content> <caption>i servizi per le scuole</caption> <type>video</type> <content>serviziotv.flv</content> <caption>il servizio TV</caption> </resources> </hyperlink> <hyperlink> <type>slink</type> <time>25</time> <title>de arte venandi cum avibus</title> Hyperfilm - Il formato XML pag. 22 di 25

23 <description>de arte venandi cum avibus ('Sull'arte di cacciare con gli uccelli') è un trattato dell'imperatore Federico II del Sacro Romano Impero sull'arte venatoria.</description> <label> <animation_type>1</animation_type> <box_color>0xcc6600</box_color> <text_color>0xffffff</text_color> </label> <resources> <type>htmltext</type> <content>sintesi_arte_venandi.txt</content> <caption>sintesi storica</caption> <type>slideshow</type> <content>arte_ven.xml</content> <caption>esempi di immagini delle pagine del trattato</caption> </resources> </hyperlink> <hyperlink> <type>slink</type> <time>29</time> <title>i ritratti marmorei di Giovanni Pisano</title> <description>esempi dell'arte di Giovanni Pisano, figlio di Nicola Pisano</description> <label> <animation_type>1</animation_type> <box_color>0x0073ff</box_color> <text_color>0xffffff</text_color> </label> <resources> <type>file</type> <content>giovanni_pisano.pdf</content> <caption>scheda Giovanni Pisano</caption> <hotspot> <title>ritratto marmoreo 1</title> <description>descrizione del ritratto</description> <fill_color>0xffffff</fill_color> <stroke_color>0xff0000</stroke_color> <stroke_width>1</stroke_width> <locx>200</locx> <locy>180</locy> <rotation>0</rotation> <fill_alpha>0</fill_alpha> <stroke_alpha>100</stroke_alpha> <shape> <vertex> <point>0,0</point> <handle>0,0</handle> <vertex> <point>120,0</point> <handle>0,0</handle> <vertex> <point>120,120</point> Hyperfilm - Il formato XML pag. 23 di 25

24 <handle>0,0</handle> <vertex> <point>0,120</point> <handle>0,0</handle> </shape> <resources> <type>image</type> <name>gp3456.png</name> <caption>ingrandimento</caption> </resources> </hotspot> <hotspot> <title>ritratto marmoreo 2</title> <description>descrizione del ritratto</description> <fill_color>0xffffff</fill_color> <stroke_color>0xaacc00</stroke_color> <stroke_width>1</stroke_width> <loc_horiz>480</loc_horiz> <loc_vert>200</loc_vert> <rotation>0</rotation> <fill_alpha>0</fill_alpha> <stroke_alpha>100</stroke_alpha> <shape> <vertex> <point>0,0</point> <handle>0,0</handle> <vertex> <point>120,0</point> <handle>0,0</handle> <vertex> <point>120,120</point> <handle>0,0</handle> <vertex> <point>0,120</point> <handle>0,0</handle> </shape> <resources> <type>image</type> <content>trinityfineart t jpg</content> <caption>ingrandimento</caption> </resources> </hotspot> </resources> </hyperlink> <hyperlink> <type>slink</type> <time>34</time> <title>cristo e l Animula della Vergine</title> <description>tra le opere più famose di Arnolfo di Cambio è un marmo proveniente da una facciata del Duomo di Firenze.</description> Hyperfilm - Il formato XML pag. 24 di 25

25 <label> <animation_type>1</animation_type> <box_color>0xcc6600</box_color> <text_color>0xffffff</text_color> </label> <resources> <type>image</type> <content>arnolfo_di_cambio/arnolfo.jpg</content> <caption>statua marmorea dello scultore</caption> <type>slideshow</type> <content>arnolfo.xml</content> <caption>alcune opere di Arnolfo di Cambio esposte nella mostra</caption> </resources> </hyperlink> </hyperlinks> </hyperfilm> Hyperfilm - Il formato XML pag. 25 di 25