Skip to topic | Skip to bottom
Home
TechWeb06
TechWeb06.ProtocolloACDFv5r1.3 - 30 May 2006 - 18:18 - GioeleBarabuccitopic end

Start of topic | Skip to actions

Protocollo AC-DF versione 5

Questo documento descrive il protocollo AC-DF versione 5 (24 maggio 2006).

I cambiamenti dalle versioni precedenti sono riassunti in un'apposita sezione alla fine di questo documento.


5 Catalogo DF

Il catalogo DF contiene le metainformazioni relative al formatter stesso.

Il catalogo di un formatter si ottiene attraverso una richiesta HTTP GET del documento disponibile all'URL stabilito e reso pubblico da ogni gruppo al momento della registrazione (nella sezione 8 sono riportate le regole per la registrazione dei data-source e dei formatter).

Si assuma ad esempio che nel wiki sia registrato il seguente formatter:

Nome Catalogo XML Catalogo HTML
TWFormatter http://tw.web.cs.unibo.it/catalogo-formatter.xml http://tw.web.cs.unibo.it/catalogo-formatter.html

L'URL che gli AC devono utilizzare per la richiesta del catalogo Ŕ appunto http://tw.web.cs.unibo.it/catalogo-formatter.xml.

Si noti che il catalogo Ŕ un documento XML (application/xml) e pu˛ essere statico o dinamico. Inoltre Ŕ necessario fornire anche una versione human-readable (HTML o XHTML) dello stesso.

Come per il DS, anche nel caso del DF il ruolo del catalogo Ŕ fondamentale: per ogni richiesta l'AC deve consultare il catalogo del DF e recuperare l'URL completo degli script attraverso i quali richiedere l'elenco dei layout o la formattazione di un documento. Sebbene sia possibile implementare meccanismi di caching, Ŕ obbligatorio recuperare dinamicamente gli URL degli script dal catalogo.

5.1 Formato del catalogo DF

All'interno del catalogo DF le metainformazioni sul formatter sono espresse tramite i sequenti elementi:

  • nome: il nome del formatter
  • tipo: il tipo di output prodotto. Ogni formatter dichiara il content-type del risultato che produce, specificando un tipo MIME. Valori possibili: text/html per le pagine HTML, application/pdf per i file PDF, application/xhtml+xml per documenti XHTML, etc. ╚ possibile personalizzare il tipo di dato prodotto ed aggiungere altri tipi a questo elenco.
  • descrizione: una descrizione human-readable del formatter, del tipo di dati che produce, eventualmente note su autori, implementazione o altre informazioni.
  • urlElenco: l'URL al quale richiedere l'elenco dei layout disponibili (vedi sezione 6.1)
  • urlFormattazionePagina: l'URL al quale POSTare un elenco di dati da formattare, (vedi sezione 6.2)
  • urlFormattazioneFrammento: l'URL al quale POSTare i dati da formattare in frammenti utilizzabili dall'AC client-side (vedi sezione 6.3)
  • variabileDatiFormattazione: il nome della variabile da POSTare agli script specificati in urlFormattazionePagina e urlFormattazioneFrammento (vedi sezione 6.2 e 6.3)

Gli URL contenuti in urlElenco, urlFormattazionePagina e urlFormattazioneFrammento non devono contenere la parte di query (?var1=xxx&var2=yyy).

Di seguito Ŕ riportato un esempio di catalogo di un formatter:

<catalogoFormatter>
  <nome>TWformatter</nome>
  <tipo>application/pdf</tipo>
  <descrizione>Un efficiente e ricco formatter PDF</descrizione>
  <urlElenco>http://tw.web.cs.unibo.it/elenco-layout.php</urlElenco>
  <urlFormattazionePagina>http://tw.web.cs.unibo.it/formatter-pagina.php</urlFormattazionePagina>
  <urlFormattazioneFrammento>http://tw.web.cs.unibo.it/formatter-frammento.php</urlFormattazioneFrammento>
  <variabileDatiFormattazione>dati_da_formattare</variabileDatiFormattazione>
</catalogoFormatter>

5.2 Schema Relax NG del catalogo DF

I cataloghi XML devono essere validati dal seguente schema Relax NG (disponibile online in sintassi compatta all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/catalogoFormatter.rnc ed in sintassi XML all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/catalogoFormatter.rng):

start = catalogoFormatter

catalogoFormatter = element catalogoFormatter {
        element nome { text },
        element tipo { text },
        element descrizione { testo.cmSemplice },
        element urlElenco { xsd:anyURI },
        element urlFormattazionePagina { xsd:anyURI },
        element urlFormattazioneFrammento { xsd:anyURI },
        element variabileDatiFormattazione { xsd:NMTOKEN }
}

6 Richieste al data formatter

Come specificato alla sezione 2, l'applicazione pu˛ inoltrare tre tipi di richieste al formatter:

  • elenco dei layout disponibili;
  • formattazione di dati in un unico documento (si noti che tutti i documenti devono essere formattati dal DF);
  • formattazione di dati in un frammento di documento (si noti che tutti i frammenti di documenti devono essere formattati dal DF).

Nelle sottosezioni successive sono riportate le specifiche dettagliate e complete del protocollo AC-DF.

6.1 Elenco dei layout

L'elenco dei layout contiene la lista dei layout resi disponibili dal formatter e delle skin associate ad ogni layout.

L'elenco dei layout si ottiene attraverso una richiesta HTTP GET del documento il cui URL Ŕ specificato dall'elemento urlElenco del catalogo del formatter. Si rimanda alla sezione 5 per una descrizione dettagliata del catalogo.

Prendendo ad esempio il catalogo descritto nella sezione 5.1, per ottenere l'elenco dei layout, l'applicazione richiede la risorsa http://tw.web.cs.unibo.it/elenco-layout.php ed il formatter risponde con l'elenco dei layout disponibili, in un documento XML secondo le specifiche riportate nella sezione 7.1.

6.2 Formattazione di dati XML in un documento completo

La richiesta di formattazione di dati XML in documento completo Ŕ realizzata tramite un POST HTTP allo script indicato nel catalogo col tag urlFormattazionePagina. L'applicazione spedisce in una variabile, il cui nome Ŕ specificato dal tag del catalogo variabileDatiFormattazione, un documento XML dal quale il formatter estrae sia i dati da formattare che i parametri di formattazione.

Si consideri il catalogo di esempio riportato nella sezione 5.1: l'applicazione fa un POST HTTP allo script http://tw.web.cs.unibo.it/formatter-pagina.php e spedisce nella variabile dati_da_formattare la richiesta XML.

Si ricorda che i formatter deve essere utilizzati anche per generare tutte le pagine del progetto, ad eccezione dei cataloghi. Questo significa che la pagina iniziale, la pagina della ricerca e le altre pagine devono essere formattate da un formatter.

6.2.1 Dati da formattare

La richiesta Ŕ suddivisa in due parti:

  • info: contiene le informazioni relative al layout scelto ed al meccanismo di iniezione del codice dell'AC client-side nell'output;
  • dati: sono i dati da formattare.

Le informazioni passate in info sono tre:

  • layout: l'attributo id di questo elemento indica quale layout utilizzare tra quelli messi a disposizione dal formatter nel catalogo;
  • skin: l'attributo id di questo elemento indica quale skin usare per decorare il layout scelto;
  • ajax: contiene le informazioni sull'URL del codice dell'AC client-side (nel sotto-elemento urlAC) e su quale metodo gestisce l'avvio dell'AC (nel sotto-elemento codiceIniziale).

L'id del layout deve essere selezionato dall'AC tra i layout disponibili ottenuti con la richiesta catalogo. Allo stesso modo l'id della skin deve essere scelto tra gli id delle skin associate al layout selezionato.

L'elemento ajax pu˛ essere omesso se l'AC server-side ritiene che lo user-agent non sia in grado di supportare la tecnologia Ajax.

I dati da formattare contenuti in dati possono essere di vari tipi:

  • elenco, scheda: i dati ottenuti dall'output del data-source. Possono essere anche un sottoinsieme o una versione modificata dei dati restituiti dai DS. Ad alcuni elementi possono essere aggiunti degli attributi per contenere collegamenti ad altre risorse, come descrito nella sezione 6.2.2;
  • titolo: un testo che descrive la pagina da formattare;
  • query: degli elementi che descrivono una maschera con la quale interrogare l'AC;
  • menuContestuale: una serie di elementi correlati ad una risorsa presente all'interno degli elementi elenco e scheda;
  • menuStatico: una serie di elementi (testo o link) che formano un menu con contenuti statici non legati ai dati presenti in elenco o scheda;
  • contenutoStatico: alcuni elementi che forniscono informazioni statiche aggiuntive (credit, link alle pagine di aiuto, ecc).

Ogni elemento query indentifica una form con la quale l'utente pu˛ contattare l'AC. L'unico elemento ammesso in query Ŕ l'elemento HTML form (senza gli attributi presentazionali come id e style). Attraverso l'attributo tipo dell'elemento query si pu˛ indicare al formatter che tipo di query Ŕ contenuta. Oltre alla query generica, in cui l'attributo tipo non Ŕ specificato, esistono due tipi di query noti: ricercaVeloce e sceltaLayout.

In un menuContestuale possono essere inserite delle informazioni aggiuntive su una risorsa. Queste informazioni possono essere:

  • elementiCorrelati: gli stessi elementi presenti in elenco e scheda a cui stato aggiunto l'attributo href;
  • navigazione: una lista di link precedente=/=successivo che descrivono un percorso di navigazione a partire da quella risorsa;
  • altriLink: una serie di link arbitrari.
Nella sezione 6.2.2 ci sono alcuni esempi sull'utilizzo di questo elemento.

Gli elementi contenutoStatico possono essere usati per indicare degli elementi statici spesso utilizzati per decorare le pagine statiche. All'interno di contenutoStatico possono essere utilizzati questi elementi, praticamente identici ai corrispettivi HTML:

  • testo: un blocco di testo decorato con altri elementi come em o span;
  • link: un link ad una risorsa esterna;
  • img: un'immagine;
  • ul e ol: liste in cui l'ordine degli elementi non conta (ul) e liste in cui l'ordine conta (ol);
  • table: una tabella.

Per gli elementi menuStatico e menuContestuale Ŕ possibile indicare il titolo del menu stesso tramite l'attributo titolo di questi elementi.

Di seguito Ŕ riportato un esempio di richiesta: l'applicazione chiede al formatter di applicare ai dati contenuti nel nodo dati il layout con id=12 ed aggiungere la skin indicata da id=cool.

<formatta>
    <info>
        <layout id="12"/>
        <skin id="cool"/>
    </info>
    <dati>
        <elenco>
          <voce>
            ...
          </voce>
          <voce>
            ...
          </voce>
        </elenco>
        <query>
            <form>
                <label for="cognome">Cognome :</label>
                <input name="cognome" type="text"/>
                <input type="submit" value="Ricerca"/>
            </form>
        </query>
        <contenutoStatico>
          ...
        </contenutoStatico>
    </dati>
</formatta>

Il formatter risponde a tale richiesta e spedisce il documento finale (pronto per la visualizzazione), secondo le specifiche riportate nella sezione 7.2.

6.2.2 Aggiunta di informazioni contestuali ai dati di scheda e elenco

╚ possibile arricchiere i dati ricevuti dai DS con informazioni aggiuntive.

Per fare questo si possono aggiungere vari attributi ai sotto-elementi di scheda e elenco.

Questi attributi aggiuntivi sono tre:

  • href: un URL che contiene una risorsa strettamente collegata all'elemento d'appartenenza;
  • descrizione: un testo che descrive l'URL contenuta in href;
  • altreInfo: il valore dell'attributo codice dell'elemento menuContestuale che contiene altre informazioni correlate all'elemento d'appartenenza.

Un esempio dell'uso di questi attributi Ŕ

<formatta>
    <info>...</info>
    <dati>
        <scheda>
            <dati>
                <titolo altreInfo="infoFrancesca">Si chiama Francesca questo romanzo</titolo>
                <autore href="http://ltw.web.cs.unibo.it/query.php?autore=Paolo+Nori"
                        descrizione="Altri libri di Paolo Nori"
                        altreInfo="infoNori">Paolo Nori</autore>
            </dati>
        </scheda>

        <menuContestuale codice="infoNori">
            <altriLink>
                <link href="http://clarence.com">Il sito preferito da Paolo Nori</link>
            </altriLink>
            <navigazione>
                <precedente href="http://ltw.web.cs.unibo.it/query.php?pi¨_giovane_di=Paolo+Nori">
            </navigazione>
        </menuContestuale>

        <menuContestuale codice="infoFrancesca">
            <elementiCorrelati>
                <autore href="http://ltw.web.cs.unibo.it/query.php?autore=Julio+Cortßzar">Julio Cortßzar</autore>
            </elementiCorrelati>
            <navigazione>
                <precedente href="http://ltw.web.cs.unibo.it/scheda.php?id=17">Le cose non sono le cose</precedente>
                <precedente href="http://ltw.web.cs.unibo.it/scheda.php?id=1928">Grandi Ustionati</precedente>
                <successivo href="http://ltw.web.cs.unibo.it/scheda.php?id=2973">Gli Scarti</successivo>
            </navigazione>
            <altriLink>
                <link href="http://paolonori.it">Sito ufficiale</link>
            </altriLink>
        </menuContestuale>
    </dati>
</formatta>

6.2.3 Esempi di richieste di formattazione dati

Un esempio di richiesta Ŕ

<formatta>
<info>
    <layout id="completo"/>
    <skin id="primavera"/>
</info>
<dati>
    <scheda>
        <info>
            <id>scheda20</id>
            <team>LTW</team>
            <originale>originale</originale>

        </info>
        <dati>
            <titolo>Brillano nel buio</titolo>
            <anno>2005</anno>
            <autore href="http://www.lorenzo.it"
                    descrizione="Sito ufficiale di Lorenzo Bartoli">Lorenzo Bartoli</autore>
            <autore>Roberto Recchioni</autore>
            <genere href="http://ltw.web.cs.unibo.it/r.php5?genere=fumetti"
                    descrizione="Altri fumetti">fumetti</genere>
            <testo>
                <trama>
                    <personaggio href="http://it.wikipedia.org/John_Doe"
                                 descrizione="Wikipedia su John Doe"
                                 altreInfo="collanaJohnDoe">John
                    Doe</personaggio> finisce a
                    <luogo altreInfo="luogoHartford">Hartford</luogo> per
                    cercare una vecchia conoscenza.
                </trama>
            </testo>
        </dati>
    </scheda>
    <titolo>Scheda di <em>John Doe - Brillano nel buio</em></titolo>
    <query>
        <form action="http://ltw.cs.unibo.it/r.php5" method="post">
            <label for="titolo">Titolo :</label>
            <input type="text" name="titolo"/>
            <input type="submit" value="Cerca"/>
        </form>
    </query>
    <menuContestuale codice="collanaJohnDoe">
        <elementiCorrelati>
            <!-- il prossimo elemento si legge "al <personaggio>John Doe</>
                 Ŕ collegata la <ricerca> intitolata 'Tutti i volumi della
                 collana John Doe' che si trova all'URL
                 'http://ltw.cs.unibo.it/r.php5?collana=John+Doe'" -->
            <ricerca href="http://ltw.cs.unibo.it/r.php5?collana=John+Doe">
                Tutti i volumi della collana John Doe
            </ricerca>

            <!-- il prossimo elemento si legge "al <personaggio>John Doe</>
                 Ŕ collegato il <genere>noire</> che si trova all'URL
                 'http://ltw.cs.unibo.it/r.php5?genere=Noir'" -->
            <genere href="http://ltw.cs.unibo.it/r.php5?genere=Noir">noir</genere>

            <!-- il prossimo elemento si legge "al <personaggio>John Doe</>
                 Ŕ collegato il <personaggio>Dylan Dog</> che si trova
                 all'URL 'http://ltw.cs.unibo.it/r.php5?personaggio=Dylan+Dog'" -->
            <personaggio href="http://ltw.cs.unibo.it/r.php5?personaggio=Dylan+Dog">
                Dylan Dog
            </personaggio>
        </elementiCorrelati>
        <altriLink>
            <link href="http://ltw.cs.unibo.it/r.php5?iniziaCon=J">Altri libri che iniziano con J</link>
        </altriLink>
    </menuContestuale>
    <menuContestuale codice="luogoHartford">
        <altriLink>
            <link href="http://maps.google.com/q=Hartford">Cerca Hartford su Google Maps</link>
        </altriLink>
    </menuContestuale>
    <contenutoStatico>
        Stai usando l'AC del gruppo
        <link href="http://ltw.web.cs.unibo.it">LTW</link>
    </contenutoStatico>
</dati>
</formatta>

6.2.4 Schema Relax NG della richiesta di formattazione dati

I dati spediti ai formatter per richiedere la formattazione di dati provenienti dal DS devono essere validati dal seguente schema Relax NG (disponibile online in sintassi compatta all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/formatta.rnc ed in sintassi XML all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/formatta.rng):

start = formatta

formatta = element formatta {
        element info { info.cm },
        element dati { dati.cm }
}

info.cm =
        element layout { attribute id { xsd:NMTOKEN } },
        element skin { attribute id { xsd:NMTOKEN } },
        element ajax { ajax.cm }?

        ajax.cm =
                element urlAC { xsd:anyURI },
                element codiceIniziale { text }

dati.cm =
        elencoConHRefEAltreInfo?,
        schedaConHRefEAltreInfo?,
        (
          element titolo { testo.cmSemplice }? &
          element query { query.cm }* &
          element menuContestuale { menuContestuale.cm }* &
          element menuStatico { menuStatico.cm }* &
          element contenutoStatico { contenutoStatico.cm }*
        )

        elencoConHRefEAltreInfo = element elenco { ANY }

        schedaConHRefEAltreInfo = element scheda { ANY }

        query.cm =
                attribute tipo { xsd:NMTOKEN }?,
                form

        menuContestuale.cm =
                attribute codice { xsd:NMTOKEN }?, (
                element elementiCorrelati { elementiCorrelati.cm }* &
                element navigazione { navigazione.cm }* &
                element altriLink { altriLink.cm }* )

                elementiCorrelati.cm =
                        schedaConHRef.element* &
                        element ricerca { link.cm }*

                navigazione.cm =
                        element precedente { link.cm }*,
                        element successivo { link.cm }*

                altriLink.cm = link*

        menuStatico.cm =
                attribute titolo { text }?,
                link*

        contenutoStatico.cm =
                attribute titolo { text }?, (
                testo.cmSemplice &
                link* &
                img* &
                ul* & ol* &
                table* )

schedaConHRef.element = element * - ricerca { ANY }

ANY =
        attribute * { text }* &
        element * { ANY }* &
        text

6.3 Formattazione di dati XML in un frammento di documento

La richiesta di formattazione di dati XML per un frammento Ŕ simile alla richiesta che viene effettuata per la formattazione in un intero documento descritta nella sezione 6.2. L'unica differenza Ŕ che l'URL dello script da utilizzare Ŕ quello contenuto nell'elemento urlFormattazioneFrammento del catalogo.

Il formatter risponde alle richieste di formattazione di dati XML in un frammento di documento con una porzione di documento pronta per essere inserita dall'Ajax Engine nel documento visualizzato all'utente in quel momento, secondo le specifiche riportate in sez. 7.3.

7 Output del formatter

Il formatter produce tre tipi di output: l'elenco dei layout disponibili, documenti completi formattati e porzioni di documento formattate.

7.1 Elenco dei layout

L'elenco dei layout racchiude informazioni sui layout messi a disposizione dal formatter.

Le informazioni relative ad ogni layout sono espresse tramite l'attributo id e gli elementi nome, urlEsempio, descrizione e skin:

  • id: l'identificatore del layout. ╚ utilizzato nella richiesta di formattazione (sezioni 6.2 e 6.3) per specificare il tipo di layout da applicare al documento;
  • nome: il nome del layout;
  • urlEsempio: l'URL di un documento di esempio che mostra il layout e la sua resa grafica finale;
  • descrizione: una descrizione human-readable del layout, del tipo di formattazione che produce, dell'organizzazione della pagina, della divisione in blocchi, etc;
  • skin: il nome di una skin che specifica lo stile grafico da applicare al layout. L'attributo url contiene l'URL della skin in formato CSS.

Si noti che id e nome sono obbigatori, urlEsempio e descrizione sono facoltativi e ogni layout deve fornire almeno una skin.

Di seguito Ŕ riportato un esempio di elenco di layout:

<elencoLayout>
        <layout id="1">
                <nome>Normale</nome>
                <urlEsempio>http://tw.web.cs.unibo.it/esempi-formatter/normale.pdf</urlEsempio>
                <descrizione>Un layout con le sole informazioni</descrizione>
                <skin id="1" url="http://tw.web.cs.unibo.it/skin/layout1-giallo.css">Giallo</skin>
                <skin id="2" url="http://tw.web.cs.unibo.it/skin/layout1-verde.css">Verde</skin>
        </layout>
        <layout id="2">
                <nome>Informazioni essenziali</nome>
                <skin id="1" url="http://tw.web.cs.unibo.it/skin/layout2-bn.css">Bianco e nero</skin>
        </layout>
        <layout id="3">
                <nome>TUTTO!</nome>
                <urlEsempio>http://tw.web.cs.unibo.it/esempi-formatter/tutto.png</urlEsempio>
                <descrizione>Un layout semplicemente folle, c'Ŕ tutto! Vi lascerÓ a bocca aperta!</descrizione>
                <skin id="gothic" url="http://tw.web.cs.unibo.it/skin/layout3-gothic.css">Stile goth</skin>
                <skin id="puppy" url="http://tw.web.cs.unibo.it/skin/layout3-puppy.css">Cagnolini</skin>
                <skin id="train" url="http://tw.web.cs.unibo.it/skin/layout3-trainspotting.css">Trainspotting</skin>
        </layout>
</elencoLayout>

7.1.1 Le skin

Un documento formattato Ŕ composto da due parti, chiamate per semplicitÓ layout e skin. Il layout specifica i blocchi di testo, le immagini, le parti fisse e variabili di una pagina, ecc. La skin specifica le proprietÓ tipografiche della pagina come font, colore, dimensioni, ecc.

In ODALISK il formatter deve correttamente applicare la skin al documento, come specificato dall'applicazione attraverso la richiesta di formattazione descritta nelle sezioni 6.2 e 6.3. L'attributo url del nodo skin specifica l'URL della skin.

Il comportamento del formatter Ŕ diverso nel caso di supporto diretto dei CSS da parte dello user-agent o meno. In altri termini: in un documento HTML Ŕ possibile semplicemente aggiungere il riferimento al CSS ma ad esempio in un PDF Ŕ necessario esprimere in modo alternativo le stesse proprietÓ. Di conseguenza il formatter, se produce documenti HTML (o XHTML o XML) associa al documento direttamente il CSS e lo rispedisce all'applicazione, altrimenti recupera questa risorsa, interpreta le regole ed assegna la stessa formattazione (se possibile) al documento che sta producendo.

Si consideri ad esempio un formatter che produce file PDF utilizzando XSL-FO e riceve questa richiesta:

<formatta>
    <info>
        <layout id="12"/>
        <skin url="http://tw.web.cs.unibo.it/skins/cool.css"/>
    </info>
    <dati>
    ...
    </dati>
</formatta>

Il CSS indicato contiene la regola:

p { font-family: Arial; }

Il formatter applica il layout con id="12" e, per applicare la skin, legge il CSS, trasforma questa regola in sintassi XSL-FO, la applica ad un blocco

<fo:block font-family="Arial">Contenuto del paragrafo</fo:block>

e genera il risultato tramite un convertitore. Nel PDF finale il testo del paragrafo sarÓ di tipo Arial come richiesto dall'applicazione.

7.1.2 Schema Relax NG dell'elenco dei layout

Gli elenchi dei layout devono essere validati dal seguente schema Relax NG (disponibile online in sintassi compatta all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/elencoLayout.rnc e in sintassi XML all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/elencoLayout.rng):

start = elencoLayout

elencoLayout = element elencoLayout {
        element layout { layout.cm }+
}

layout.cm =
        attribute id { xsd:NMTOKEN },
        element nome { text },
        element urlEsempio { xsd:anyURI }?,
        element descrizione { testo.cmSemplice }?,
        element skin { skin.cm }+

skin.cm =
        attribute id { text },
        attribute url { text },
        testo.cmSemplice

7.2 Formattazione di dati XML in un documento completo

Quando al formatter viene richiesto di formattare dei dati XML in un documento completo, il formatter risponde con un documento formattato e decorato secondo il layout e la skin richiesti.

Nell'header HTTP della risposta, il formatter deve indicare il MIME type del documento prodotto.

L'output di questo formatter Ŕ un documento completo e pronto per la visualizzazione, per cui l'AC deve semplicemente inoltrarlo allo user-agent ed aggiungere le informazioni necessarie per una corretta visualizzazione. Solitamente l'unica informazione da aggiungere Ŕ il content type, che specifica il tipo di documento prodotto ed Ŕ suggerito dal formatter.

Fondamentalmente i formatter possono generare due tipi di output: output testuali (ed XML) e output binari. In entrambi i casi Ŕ il ruolo dell'AC Ŕ marginale: si limita a impostare l'header HTTP Content-Type al MIME type suggerito dal formatter e consegnare i dati che formano il documento stesso.

╚ importante ribadire che tutte le pagine, anche quelle accessorie come home, ricerca ed help, devono essere formattate da un formatter.

7.3 Formattazione di dati XML in un frammento di documento

Se al formatter viene chiesto di formattare dei dati XML in un frammento di documento, il formatter risponde con una porzione di documento formattata e decorata secondo il layout e la skin richiesti.

L'output di questo formatter Ŕ un documento XML che ha come radice l'elemento frammenti. ╚ compito dell'AC Ŕ integrare questi frammenti con il documento finale.

Gli elementi discendenti diretti di frammenti devono avere l'attributo id. L'attributo id servirÓ all'AC client-side per capire quale elemento andare a rimpiazzare nel documento attualmente visualizzato.

╚ possibile richiedere la formattazione in un frammento di documento delle pagine accessorie (home, ricerca, ecc.).

7.3.1 Scheda dell'output del formatter di frammenti

I dati ricevuti dal formatter in seguito ad una richiesta di formattazione di dati XML in un frammento di documento devono essere validati dal seguente schema Relax NG (disponibile online in sintassi compatta all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/frammenti.rnc e in sintassi XML all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/frammenti.rng):

start = frammenti

frammenti = element frammenti { ANYConID* }

ANYConID =
        element * {
                attribute * - id { text }*,
                attribute id { xsd:NMTOKEN },
                mixed { element * { ANY }* }
        }

ANY =
        attribute * { text }*,
        mixed { element * { ANY }* }

7.4 Gestione degli errori

Le richieste inoltrate al formatter possono generare diversi errori. Per gestirli il protocollo AC-DF prevede un messaggio di errore che riporta un codice ed una descrizione human-readable dell'errore. Il messaggio deve essere validato dal seguente schema Relax NG (disponibile online in sintassi compatta all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/errori.rnc ed in sintassi XML all'URL http://ltw06_01.web.cs.unibo.it/wg-df/schema_formatter-5/errori.rng):

start = errori

errori = element errori {
        element errore { errore.cm }*
}

errore.cm =
        element codice { text },
        element descrizione { testo.cmSemplice }

Il seguente frammento XML riporta un esempio di messaggio di errore:

<errori>
    <errore>
        <codice>00</codice>
        <descrizione>Formatter non disponibile</descrizione>
    </errore>
</errori>

Viene riportata di seguito una tabella con i possibili errori e relative descrizioni:

Codice errore Descrizione errore
00 Formatter non disponibile
01 Dati in input errati
02 Layout richiesto inesistente
03 Skin richiesta inesistente


Differenze con le versioni precedenti

Cambiamenti da versione 4 a versione 5

Formattazione di dati

  • Corretto lo schema di scheda e elenco con gli attributi aggiuntivi.
  • Cambiato l'attributo che identifica un menuContestuale da id a codice.
  • Cambiato il content model di menuStatico per contenere solo link.
  • Corretto l'errore nello schema di formatta che rendeva l'attributo titolo obbligatorio.
  • Aggiunti degli esempi di dati formattare.
  • Modificato lo scheda dell'output del formatter per frammenti di documenti.

Gestione errori

  • Aggiunto un nuovo errore per le skin inesistenti.

Cambiamenti da versione 3 a versione 4

Generale

  • Riscritti i DTD in schema Relax NG in sintassi compatta.

Formattazione di dati

  • Ampliata la descrizione degli elementi contenuti in dati.
  • Aggiunto l'elemento contenutoStatico
  • Aggiunto l'attributo tipo a query
  • Aggiunto l'attributo titolo a menuStatico e menuContestuale

Cambiamenti da versione 2 a versione 3

Formattazione di dati

  • Aggiunto l'elemento ajax alle info da passare al formatter per richiedere la formattazione di dati.
  • Rimossi pagina e navigazione in favore degli elementi con pi¨ significato menuContestuale, query e menuStatico.
  • Aggiunti nuovi attributi href, descrizione e altreInfo agli elementi di scheda ed elenco.

Cambiamenti da versione 1 a versione 2

Generale

  • Corretto qualche refuso.
  • Riscritti tutti i nomi degli elementi da lowercase-dashed a camelCase.

Catalogo DF

  • Rinominati gli elementi name e type in nome e tipo.

Formattazione di dati

  • Cambiato il content model di dati da ANY a (elenco|scheda)?, pagina?, navigazione?.

Cambiamenti da 0.9 a Protocollo AC-DF versione 1

Generale

  • Riordinati i capitoli e riscritta in parte la descrizione del protocollo.

Catalogo DF

  • Riscritto il DTD del catalogo per rendere catalogo_formatter un contenitore di elementi e non di attributi.
  • Rimosso il vincolo che obbliga url-elenco, url-formattazione-pagina e url-formattazione-frammento a riferirsi ad un unico script.
  • Aggiunto il vincolo che impedisce di avere una parte di query negli URL di url-elenco, url-formattazione-pagina e url-formattazione-pagina.

Elenco dei layout

  • Aggiunto l'elemento skin a layout per permettere di pubblicare le skin disponibili per un dato layout.

Gestione degli errori

  • Aggiunto il contenitore esterno errori per uniformare il protocollo AC-DF al protocollo AC-DS.

  • Set ALLOWTOPICVIEW =
  • Set ALLOWTOPICCHANGE =

to top

You are here: TechWeb06 > ProtocolloACDFv5

to top

Copyright © Fabio Vitali + TechWeb students 2006