T.P. d initiation à XML

T.P. d initiation à XML Axe ISI - Philippe Beaune Vendredi 21 octobre 2005 matin / 3h00 Résumé Ce T.P. consiste en la découverte de XML et de quelques outils de base permettant la manipulation de fichiers XML. Dans ce T.P., nous commencerons par découvrir la validation et la transformation de fichiers XML. Ensuite, avec l IDE eclipse vous découvrirez le format DocBook et les transformations classiques que l on peut opérer dessus. Ce T.P. pourra être prolongé en utilisant la fonctionnalité CVS d eclipse pour réaliser un ouvrage à plusieurs auteurs (le co-authoring). 1 Objectif et moyens À l issue de ce T.P., vous devrez savoir utiliser les outils xmllint et xsltproc, les DTD, les fichiers XSL, ainsi que le format DocBook, et générer aussi bien des fichiers HTML, que des fichiers PostScript ou PDF, à partir d un (ou plusieurs) fichier(s) DocBook, dans l environnement eclipse. Le logiciel eclipse est déjà installé dans les salles de T.P. (aussi bien sous Linux, sous Solaris, que sous Windows). En revanche les logiciels xmllint et xsltproc devront être installés sous Linux. La première partie du T.P. sera donc réalisée sous Linux. Pour la deuxième partie, vous choisirez le système d exploitation qui vous convient le mieux. Pour cette deuxième partie, vous devrez aussi installer plusieurs plugins nécessaires à eclipse pour la manipulation de fichiers XML, et du format DocBook. Une troisième partie du T.P. pourrait consister en la réalisation d un document DocBook à plusieurs auteurs, mais puisqu aucun serveur CVS ne sera disponible en salle de T.P., cette troisième partie sera simulée par des échanges classiques de fichiers. 2 Vérification de syntaxe, validation et transformation de fichiers XML 2.1 Installation des logiciels La distribution Linux des machines à votre disposition ne contient plus tous les outils requis pour ce T.P. Vous allez donc les installer. A cette adresse : http://www.emse.fr/~beaune/docnum/softs vous pouvez trouver soit les deux outils, déjà compilés, dont vous avez besoin : 1

xmllint et xmlproc, soit le code source permettant de re-créer ces deux outils. Il est possible que les deux outils déjà compilés fonctionnent directement sur votre machine. Pour cela rien à faire : créez un répertoire adéquat (par exemple bin à la racine de votre espace utilisateur) et copiez y les deux softs compilés. Si cela pose problème, voici la démarche à suivre pour recompiler ces deux softs (pas d inquiétude, c est rapide). Créez un répertoire de travail (myxsltproc par exemple), copiez y les deux archives compressées (libxml2-2.6.22.tar.gz et libxslt-1.1.15.tar.gz). Décompressez-les avec gzip -d, puis désarchivez avec tar xvf. Rendez-vous dans le sous-répertoire concernant libxml2, puis :./configure prefix=$home/myxsltproc make make install Rendez-vous ensuite dans le deuxième sous-répertoire (celui relatif à libxslt) puis :./configure prefix=$home/myxsltproc with-libxml-prefix=$home/myxsltproc make make install Des sous-répertoires divers ont dû être créés dont l un est bin. S y trouvent quatre softs dont les deux dont vous avez besoin : xmllint et xmlproc. Lorsque vous souhaiterez les utiliser, veillez bien à indiquer le chemin pour les trouver. 2.2 L inévitable HelloWorld, bien formé puis valide Créez un nouveau fichier xml (nommé hello.xml) contenant ceci : <?xml version="1.0"?> <greeting> Hello, World! </greeting> Première chose à faire : vérifier qu il est bien formé. xmllint hello.xml Pas très explicite comme réponse, a priori. Introduisez donc une erreur de syntaxe dans le fichier hello.xml et recommencez. Au vu du résultat il semble donc que le fichier d origine était bien formé. Ré-essayez (avec toujours l erreur) en testant certaines options (qui vous semblent pertinentes) de xmllint. Pour connaitre ces options : xmllint --help Par exemple, l option - -recover permet d obtenir, parfois, une proposition intéressante de correction du fichier mal formé. Écrivez maintenant la DTD correspondant à ce fichier hello.xml et testez la validité : xmllint --dtdvalid hello.dtd hello.xml Introduisez des erreurs pour voir comment se comporte xmllint. 2

2.3 Transformation de HelloWorld En reprenant le fichier hello.xml d origine, écrivez une feuille de style XSL-T permettant de générer un fichier HTML où Hello, World! s afficherait en style h1. Une version basique peut être : <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/xsl/transform" version="1.0"> <xsl:output method="html"/> <xsl:template match="/"> <xsl:apply-templates select="greeting"/> </xsl:template> <xsl:template match="greeting"> <html> <body> <h1> <xsl:value-of select="."/> </h1> </body> </html> </xsl:template> </xsl:stylesheet> NB : la règle <xsl:output method="html"/> permet d indiquer que le processeur XSL-T devra générer du HTML. Testez que votre fichier XSL-T est bien formé. Pour appliquer la transformation, utilisez xsltproc : xsltproc -o hello.html hello.xsl hello.xml Testez le fichier obtenu hello.html dans un navigateur. Mais si vous transformez le fichier hello.xml pour qu il contienne deux greetings (un en anglais et un en français), le tout englobé dans une balise truc, alors votre DTD ne fonctionnera plus (modifiez la) et votre hello.xsl ne fonctionnera pas non plus : modifiez le de façon à ce qu il sorte du bon HTML (pas 2 ensembles de balises html par exemple). 2.4 Histoires de recettes Dans ce répertoire : http://www.emse.fr/~beaune/docnum/2005_2006/recettes/ se trouvent un fichier XML et sa DTD décrivant des recettes de cuisine (fichiers issus du cours de Jean-Jacques Girardot, merci à lui). Chargez ces deux fichiers sur votre machine. Vérifiez que le fichier XML est bien formé et valide. Notez que puisque le fichier recettes.xml contient l URL de sa DTD, la commande suivante est suffisante pour vérifier la validité : 3

xmllint --valid --noout recettes.xml Pour bien comprendre le contenu de recettes.xml, ajoutez une recette et revérifiez. Maintenant on va piocher dans ces recettes. Pour extraire toutes les recettes faciles, avec cette règle, ça devrait aller : <xsl:apply-templates select="/*/*[difficulte= Facile ]"/> Incluez la dans une feuille de style et testez la. Pour vous entrainer avec les formules XPATH, vous pouvez le faire en ligne avec xmllint : xmllint --shell recettes.xml Essayez du, puis cat. Avec cat /*/*[difficulte= Facile ] vous sélectionnez les seules recettes prétendues faciles. Si vous ne voulez que les titres de ces recettes dites faciles : cat /*/*[difficulte= Facile ]/titre Et avec : cat //*[@cout="faible"]/../difficulte que sélectionnez-vous? Continuez ces slélections à votre convenance. Pour aller plus loin, vous pourrez essayer les T.P. de Jean-Jacques Girardot : http://kiwi.emse.fr/dn/ 3 Découverte de DocBook sous eclipse À partir d ici, vous allez travailler sous eclipse. Mais il vous faut d abord installer quelques plugins ainsi que quelques DTD et feuilles de style. 3.1 Installation Tous ces fichiers se trouvent à l url : http://www.emse.fr/~beaune/eclipse/ Avant de télécharger quoi que ce soit, créez-vous un nouveau répertoire dans lequel vous allez placer tous ces éléments. Ils sont tous compressés au format zip, et vous devez tous les décompresser dans ce répertoire nouvellement créé, surtout sans en changer le contenu : les arborescenses décompressées doivent rester telles qu elles vous sont fournies. la DTD de DocBook : docbook-xml-4.2.zip qui vous permettra de valider syntaxiquement vos réalisations DocBook, et vous fournira aussi une aide syntaxique dans l éditeur d eclipse ; les fichiers XSL de DocBook : docbook-xsl-1.66.1.zip qui permettront, à partir de fichiers DocBook, de générer du HTML ou du XSL-FO (principalement) ; le plugin transclipse : transclipse-0.20.0.zip qui permet de transformer des fichiers XML (avec XSL-T) ; la bibliothèque FOP : fop-0.20.5.zip qui vous permettra de générer du PDF ou du PostScript (principalement) à partir du format XSL-FO dans transclipse ; 4

le plugin XML-Buddy : xmlbuddy-2.0.9.zip qui offre une nouvelle perpective à eclipse (et des fonctionnalités associées!), pour manipuler des fichiers XML ; le plugin netacess : netacess-1.0.0.zip qui règle les problèmes de proxy ; et enfin la bibliothèque SAXON : saxon-6.5.3.zip qui contient les classes Java nécessaires à transclipse pour manipuler les fichiers XSL. Vous remarquerez qu à cette url (http://www.emse.fr/~beaune/eclipse/), se trouve une dernière archive (tdg-en-html-2.0.10.zip) : il s agit d une version HTML du célèbre livre : DocBook : The Definitive Guide qui contient (à quelques erreurs près!) la définition de toutes les balises DocBook. Pas besoin d installer ce livre sur votre machine dans l immédiat : vous pouvez y accéder directement à l url : http://www.docbook.org/tdg/en/html/docbook.html. 3.2 Configuration d eclipse Pré-requis : vous avez téléchargé les 7 archives.zip, vous les avez décompressées, et vous avez lancé eclipse. Installation des plugins de base : cette installation peut se faire sans toucher à l installation d eclipse. D ailleurs, n étant pas vous-mêmes Administrateur de la machine qui vous est confiée, vous ne pourriez pas le faire. On va donc se contenter d indiquer à eclipse où aller chercher des plugins supplémentaires (et cela ne vaudra que pour vous, et ne modifiera pas le comportement d eclipse pour d autres utilisateurs sur cette machine : génial! Non?). menu Help, sous-menu Software Updates, item Manage Configuration... : choisissez Add an Extension Location ; allez retrouver le plugin XML-buddy là où vous l avez déposé (sélectionnez le répertoire xmlbuddy) ; et acceptez le redémarage d eclipse. menu Help, sous-menu Software Updates, item Manage Configuration... : choisissez Add an Extension Location ; allez retrouver le plugin transclipse là où vous l avez déposé (sélectionnez le répertoire transclipse) ; et acceptez à nouveau le redémarage d eclipse (c est un peu long, mais il faut en passer par là. Patience...). Configuration de ces plugins : menu Window, item Preferences : XMLBuddy devrait être ok. choisissez donc l autre : transclipse ; ajoutez une XSLT processor en allant chercher le fichier saxon.jar là où vous aviez déposé l archive saxon ; sélectionnez ce nouveau XSLT processor : SAXON 6.5.3 from... toujours dans cette fenêtre de transclipse, pour la XSL Stylesheet detection method, choisissez No detection..., et sélectionnez le fichier docbook du répertoire fo de l archive docbook-xsl-1.66.1 ; cela vous permettra de fabriquer du XSL-FO à partir de DocBook (pour fabriquer du HTML, il vous faudra revenir ici et choisir le même fichier mais dans le répertoire html). toujours dans cette fenêtre de transclipse, indiquez où se trouve l archive fop.jar : choisissez impérativement celle qui se trouve dans le répertoire lib du dossier fop-0.20.5. 5

Configuration de votre environnement : pour voir ce qui se passe (notamment les inévitables erreurs de syntaxe, mais aussi les erreurs de configuration), ouvrez les vues Error Log et Problems (menu Window, sous-menu Show View). Choix de la perspective : aucune hésitation, vous devez choisir... XML. Vous voila (enfin!) prêt à rédiger... 3.3 L inévitable HelloWorld, en DocBook Commencez par créer un nouveau projet et choisissez-le dans XML > Project. Donnez-lui un nom original (à vous de voir). Voila, déjà ça de fait. Maintenant, créez un nouveau fichier XML, dans ce projet, en lui donnant un nom intéressant (suffixé par.xml). Là, il vous faut choisir la DTD que vous allez utiliser : choisissez le fichier docbookx.dtd, dans le répertoire où se trouve le contenu de l archive docbook-xml-4.2.zip. Cela vous donne accès à toutes les balises de DocBook. Choisissez section comme racine de votre document. N indiquez aucun Namespace. Cochez DTD in DOCTYPE et éventuellement corrigez le chemin de la DTD (si ce chemin passe par un répertoire contenant un espace, alors celui-ci est traduit par %20 et ça met la pagaille : remplacez-le par un espace et tout devrait aller pour le mieux). Dans la dernière fenêtre, cochez Generate <?xml declaration. Vous devriez obtenir un fichier XML, avec un début de DocBook dedans, et notamment la balise racine de votre document, à savoir section. À vous maintenant d insérer quelque chose entre <section> et </section>. Saisissez juste le début d une nouvelle balise, à savoir <. L éditeur syntaxique devrait vous venir en aide, en vous proposant les balises candidates. Heureusement, il y en a peu! Pour savoir pourquoi, rendez-vous dans le livre cité ci-dessus, dans sa partie II, cliquez sur le lien section : là vous découvrez qu une section peut commencer par une sectioninfo, et qu ensuite il faudra impérativement un title (avec en option un subtitle, et/ou un titleabbrev). Donc tant que vous n aurez pas inséré une balise title, l éditeur ne vous proposera rien d autre. Choisissez donc pour l instant une sectioninfo. Avec la même opération, vous découvrez qu en revanche cette fois-ci il y a beaucoup de candidats. Choisissez seulement author. Toujours pareil : vous découvrez tous les candidats. Prenez firstname puis surname et inscrivez-y vos prénoms et noms, sans aller voir les balises candidates, elles sont encore nombreuses. Passez ensuite en-dessous de /sectioninfo, et insérez le fameux title. Inscrivez ici la première phrase qui vous passe par la tête. Passez ensuite en-dessous de /title et entrez la balise <para> (elle délimite un paragraphe). Inscrivez ici la phrase choc : Hello World. Enregistrez les modifications apportées à ce fichier. Puis, avec le menu contextuel associé à ce fichier (dans la vue Navigator), choisissez l item (tout en bas) Transform XML. Vous venez de franchir un grand pas : votre document DocBook est en train de se transformer en XSL-FO. Vous ne voyez rien apparaitre? Normal : il faut raffraichir le contenu de votre projet dans la vue Navigator : menu contextuel associé au nom de votre projet. Miracle! Vous pouvez maintenant transformer ce nouveau fichier (qui contient du XSL-FO) en PDF, PostScript... 6

Pour cela utilisez, dans le menu contextuel de votre fichier, puis dans le sousmenu Transform XSL-FO to, l item de votre choix. Vous pouvez visualiser ce deuxième nouveau fichier avec l outil de votre choix, en dehors d eclipse. Petits conseils : toujours sauvegarder son fichier avant de tenter une opération, sinon l opération risque d être effectuée sur la version précédente du fichier, et ne jamais oublier de fermer le fichier PDF (ou autre) qu on vient d admirer, avant de tenter de générer un autre : le processus FOP doit détruire ce fichier avant d en faire un autre. Vous pouvez aussi obtenir la même page, au format html, en allant changer le fichier XSL utilisé (cf. chapitre Configuration d eclipse ). Pas mal?! Maintenant pouvez exercer votre curiosité en essayant d inclure dans le document des listes à puces : allez voir les balises <itemizedlist>, <listitem>. Vous pouvez aussi ajouter <email> dans <author> de la <sectioninfo>. Essayez <address> après </title>. Si votre nom apparait plusieurs fois dans votre document, vous pouvez l associer à une entité : pour cela allez à la fin de la ligne commençant par <!DOCTYPE...>. Juste avant le > de la fin de ligne : insérez [< et regardez ce que vous propose l éditeur. Choisissez <!ENTITY et entrez ceci : <!ENTITY nom "Beaune">] Là où vous écriviez votre nom, vous pouvez maintenant écrire plus simplement &nom ;. 3.4 Mon premier vrai document, en DocBook Le but maintenant est que chacun d entre vous construise son propre CV de son côté. Ensuite dans le chapitre suivant de ce TP, vous mettrez en commun votre travail pour faire un recueil de CV. Vous allez donc ouvrir un nouveau projet XML. Puisque le coeur de votre document devra être utilisé aussi bien seul que dans un ouvrage collectif, vous allez séparer votre travail en deux fichiers : l un ayant pour racine la balise section, et l autre ayant pour racine la balise article. Le premier fichier (section) contiendra votre CV. Le deuxième contiendra des titres, auteurs, etc., et un appel au premier. Le premier ne devra pas comporter l entête <!DOCTYPE...>. Si eclipse l ajoute automatiquement, alors supprimer-le. À l intérieur de la section principale, ce premier fichier contiendra : une sectioninfo, avec auteur, email, etc. un titre (obligatoire) une adresse des sections (en fait <section> est récursif, et lorsqu on inclut une section dans une autre section, c est une sous-section, et ainsi de suite... Les différentes sous-sections de votre CV pourront être : études antérieures, exprériences en entreprises, axes choisis au premier semestre, axes souhaités au second, thème de votre projet (activité conduite de projet ) de l an passé, activités dans des clubs, etc. Si voulez faire une liste à puces avec par exemple des dates au lieu de simples puces : allez voir la balise <segmentedlist>. Dans le second fichier (dont la racine est article), vous devrez inclure : une entité pour désigner le premier fichier : {<!ENTITY moncv SYSTEM "nomdufichier.xml">} 7

en indiquant bien le chemin absolu et complet du fichier nomdefichier.xml. d autres entités si nécessaire un titre une rubrique articleinfo une rubrique warning où vous informerez le lecteur qu il ne s agit que d un brouillon, pas quelque chose d abouti l inclusion du premier fichier (en guise de section) : il suffit d écrire &moncv ; et enfin une rubrique ackno Vous devez remarquer que le warning est justement annoncé par warning. Qu une Table of Contents apparait. Par terrible dans un papier en français! Alors à la place de <article> vous allez tenter ceci : <article lang="it"> C est pas mieux? Si vous voulez encore plus exotique vous pouvez essayer : <article lang="ru"> mais pas sûr que les polices de caractères soient trouvées. 3.5 Mon premier livre DocBook, en co-rédaction Ou comment supporter les erreurs des autres... À partir de là, il aurait fallu avoir accès à un référentiel CVS et pouvoir partager des fichiers. Mais puisque nous n avons pas de référentiel CVS et que vous savez déjà utiliser celui-ci, vous allez vous contenter d échanger vos CV. Il va falloir s organiser. Je vous propose de vous regrouper entre collègues qui faites partie d un même groupe pour les projets XML. Vous allez rédiger le chapitre qui correspond à votre groupe. Puis tous les chapitres seront regroupés dans un livre. Puisque vous allez mettre en commun tous vos fichiers, autant se mettre d accord au préalable sur les noms de fichiers. La feuille CV créée précédemment doit avoir pour nom : votre nom, suffixée par.xlm. Pour votre groupe vous construirez un fichier contenant un seul chapitre : ce fichier devra avoir pour nom : le nom du projet. Le fichier global, regroupant le tout s appellera CVaxeISI.xml. Commencez par créer le fichier chapitre. Ce fichier contiendra les balises suivantes : chapter, avec un titre, et l inclusion des CV des membres du groupe. Lorsque ce fichier est bien au point, vous le donnez aux membres des autres groupes qui le veulent bien. Pour l ensemble de la promo, il vous faut créer le fichier CVaxeISI.xml. Il devra contenir les balises : book (avec lang= fr ), dedication (avec dedans un title, un caution, un tip, un warning), un bookinfo (avec title, author, date), un preface (avec title et para), puis l inclusion des fichiers des groupes contenants chacun un chapitre, et enfin, éventuellement un index. Avec cette première expérience, et connaissant déjà CVS, il vous est assez facile d imaginer comment co-rédiger un document plus conséquent, tout cela sous eclipse, bien sûr. FIN 8