XML / DTD / FOP -opas Internal

Transkriptio

1 XML / DTD / FOP -opas Internal Reviewed: - Status: pending approval Approved by: - Author: Sakari Lampinen Revision: 1.0 Date:

2 1 Termit DTD (data type definition) on määrittely kielelle, niinkuin HTML, WML etc. Tämä määrittely annetaan yleensä tiedostossa (meillä tripoli.dtd). Määrittelyssä kuvataan kielen rakenne, eli mitä tokeneita tai tageja voi olla missäkin kohtaa. XML (extensible Markup Language) on kieli, jolla voidaan määritellä DTD:iden avulla toisia kieliä. XML sisältää vain tiedon kuvausta, ei esitysmuotoa, kuten grafiikkaa etc. XSL (extensible Stylesheet Language) on kieli, jolla voidaan lisätä XML:ään esitysmuoto. Lisäksi XSL:n avulla voidaan muuttaa XML:n avulla ilmaistu tieto muuhun muotoon, kuten pdf:ksi tai html:ksi. FO (Formatting Objects) on XSL:n osa, jolla voidaan tarkkaan määrittää esitysasu. FOP on ohjelma, joka käyttää XML-parseria apunaan ja muuttaa XSL-tiedostossa annettujen ohjeiden avulla XML-dokumentin Acrobatiksi (pdf). 2 DTD Nykyinen DTD on seuraavanlainen: <!ELEMENT document ( internalversion, heading, phasenumber, phasename, date, reviewdate, approvedby, author, revision, status, summary?, (section extsection)*) > <!ELEMENT internalversion <!ELEMENT heading <!ELEMENT phasenumber <!ELEMENT phasename <!ELEMENT date <!ELEMENT reviewdate <!ELEMENT approvedby <!ELEMENT author <!ELEMENT revision <!ELEMENT status XML / DTD / FOP -opas 2

3 <!ELEMENT summary <!ATTLIST summary <!ELEMENT section <!ATTLIST section <!ELEMENT subsection <!ATTLIST subsection <!ELEMENT subsubsection <!ATTLIST subsubsection <!ELEMENT p <!ELEMENT image <!ATTLIST image <!ATTLIST image <!ELEMENT a <!ATTLIST a <!ELEMENT br <!ELEMENT i <!ELEMENT hl <!ELEMENT b <!ELEMENT code <!ELEMENT pbr <!ELEMENT ol <!ELEMENT ul <!ELEMENT li (p)*> (p subsection)*> (p subsubsection)*> (p)*> ANY> filename CDATA #REQUIRED> text CDATA #IMPLIED> href CDATA #REQUIRED> (li*)> (li*)> ANY> <!ENTITY Ouml "Ö" > <!ENTITY Auml "Ä" > <!ENTITY Aring "Å" > <!ENTITY auml "ä" > <!ENTITY ouml "ö" > <!ENTITY aring "å" > 3 Käytännössä 3.1 XML:n perusjuttuja Erona HTML:ään on se että XML:ssä on aina pakko sulkea kaikki tagit. Eli esimerkiksi jokainen <p> on suljettava aina, toisin kuin HTML:ssä, jos tekee huolimatonta koodia. Sulku tapahtuu samalla tavalla kuin HTML:ssä, eli esimerkiksi <p> aloittaa kappaleen ja </p> sulkee sen. XML / DTD / FOP -opas 3

4 XML:ssä on lyhennemerkintä tagille, joka suljetaan saman tien. Avaavaan tagiin merkitään kauttaviiva ennen suurempi kuin merkkiä. Tätä käytetään yleensä esimerkiksi rivinvaihdon yhteydessä, eli <br/> XML:ssä dokumentin täytyy vastata tarkalleen DTD:n määritelmää. Skandit pitää kiertää ä, ö & 3.2 Dokumentin perusrakenne Kaikki tälle DTD:lle rakennetut XML-dokumentit sisältävät seuraavan perusrakenteen, jossa summary ja subsection on vapaaehtoisia ja jossa hakasuluissa( [ ] ) olevat alueet voi täyttää k.o. dokumentin omilla tiedoilla. <?xml version='1.0' encoding='utf-8'?> <!DOCTYPE document SYSTEM '/home/tripoli/lib/tripoli.dtd'> <document> <internalversion> [. ] </internalversion> <heading> [. ] </heading> <phasenumber> [. ] </phasenumber> <phasename> [. ] </phasename> <date> [. ] </date> <reviewdate> [. ] </reviewdate> <approvedby> [. ] </approvedby> <author> [. ] </author> <revision> [. ] </revision> <status> [. ] </status> <summary title="[. ]"> <p> [. ] </p> </summary> <section title="[. ]"> <subsection title"[. ]"> <p> [. ] </p> </subsection> </section> </document> 3.3 DTD:n määrittämät tagit internalversion Ei tällä hetkellä käytössä: varattu CVS:n käyttöön. XML / DTD / FOP -opas 4

5 3.3.2 heading Dokumentin otsikko, tässä 'Internal' phasenumber Vaiheen numero, esim 'Phase 1'. Tässä luovasti väärinkäytetty, eli 'XML / DTD / FOP -opas' phasename Vaiheen nimi, esim 'elaboration and planning'. Kansilehdessä vaiheen numeron alla. Tässä dokumentissa tyhjä date Dokumentin päiväys, tässä dokumentissa Kansilehdessä oikeassa alanurkassa reviewdate Päivä jolloin k.o. dokumentti on katselmoitu approvedby Kuka hyväksyi dokumentin katselmoinnissa (virallisesti) author Kuka kirjoitti tai on vastuussa k.o. dokumentin muotoilusta revision Mikä dokumenttiversio on kyseessä status Dokumentin status. Jokin seuraavista: draft ( = vedos, ei valmis ) approval pending ( = valmis katselmoitavaksi ) approved ( = hyväksytty ) summary Tiivistelmä k.o. dokumentista. Attribuuttina otsikko tiivistelmälle. Esim. summary title="tiivistelmä">. Voi sisältää ainostaan elementin <p> section Osa. Attribuuttina title, eli osan otsikko. Esim. <section title="osa">. Voi sisältää ainostaan elementin <p> tai aliosan <subsection> subsection Aliosa. Attribuuttina title, eli osan otsikko. Esim. <subsection XML / DTD / FOP -opas 5

6 . Voi sisältää ainostaan elementin <p> tai alialiosan <subsubsection> subsubsection Alialikappale. Attribuuttina title, eli osan otsikko. Esim. <subsubsection title="alialiosa">. Voi sisältää ainostaan elementin <p> p Tripoli Kappale, joka erotetaan kappalevälille sekä ylhäältä että alhaalta. Kappale voi sisältää seuraavia elementtejä: <image> Kuva. Sisältää attribuutit filename ja text. Filename on kuvan sisältävän tiedoston nimi. Text on kuvateksti. Esim: <image filename="ankka.gif" text="ankka lammessa"/> <a> Linkki, kuten HTML:ssä. Sisältää attribuutin href kuten HTML:ssä. Esim: <a href=" <br> Rivinvaihto, käytännössä aina <br/> <hl> Korostus (punaisella). Esim: <hl>korostettu teksti</hl> <b> Tukevoitus(bold). Esim: <b>tukevoitu teksti</b> <code> Ohjelmakoodia, rivinvaihdot säilyy, fontti tasavälistä. Esim: code>for (;;;) printf("hello");</code> <pbr> Sivunvaihtosuositus. Voi olla ainoastaan osioiden välissä. Esim: <pbr/> <li> Listan elementti. Voi olla vain <ol> tai <ul> sisällä. Esim: <li>3 kananmunaa</li> <ol> ja <ul> Listat, joista ensimmäinen numeroitu ja jälkimmäinen numeroimaton. Esim: <ol> <li>jotain</li> <li>jotain muuta</li> </ol> 4 Runkotiedoston tuottaminen Aiemmin näytetyn runkotiedoston voi tuottaa käskyllä tp-template argumenttina haluttu tiedostonimi. Esim: tp-template nimi.xml 5 Validointi Jokaisen XML:n dokumentin pitää olla hyvin muotoiltu (eli kaikki avatut tagit suljettu oikeassa sisennyksesä) ja validi (noudattaa DTD:tä), XML / DTD / FOP -opas 6

7 ennenkuin FOP voi tehdä niistä Acrobat-tiedostoja. Validoinnin voit suorittaa ajamalla tp-check argumenttina tiedostonimi ryhmätunnuksella tripoli. Esim: tp-check projectplan.xml Jos käsky palauttaa jotain muuta kuin rivillisen statistiikkaa, niin koodissa on vikaa. Valitettavasti virheilmoitukset eivät ole aina kovin valaisevia. Kannattaa olla tarkka kun tekee koodia. 6 FOP:in käyttö FOP toimii ryhmätunnuksella tripoli ajamalla tp-make skripti argumentilla tiedostonimi, ilman xml määrettä. Eli esim: tp-make projectplan 7 Lisäys Kaikki kolme edellä mainittua käskyä saa käyttöönsä muillakin käyttäjillä laittamalla hakemiston /home/tripoli/bin polkuunsa, tai kutsumalla käskyä suoraan k.o. hakemistosta. XML / DTD / FOP -opas 7