STIC:STIC II - exercice 10 (Yoshi)

De EduTech Wiki
Aller à la navigation Aller à la recherche

Cette page fait partie des cours STIC I et STIC II

STIC

Cet article est en construction: un auteur est en train de le modifier.

En principe, le ou les auteurs en question devraient bientôt présenter une meilleure version.


Introduction

Cet exercice relie trois concepts importants: (1) la notion de (méta)langage ; (2) le concept de grammaire ou patron ; et (3) la transformation de données dans d'autres formats.

Connaissances/compétences envisagées

À l'issue de cet exercice vous devez avoir acquis les connaissances/compétences suivantes :

  • Comprendre XML en tant que (méta)language ;
  • Savoir définir et implémenter une grammaire ou patron qui détermine une structure de données muti-dimensionnelle avec un fichier DTD
  • Renforcer la notion de structure qui détermine la forme (et non pas le contraire) à travers la création d'une transformation XSLT qui permet d'afficher des données XML dans un autre format (e.g. HTML5, SVG, ...)
  • Savoir réfléchir sur l'utilité de déterminer une grammaire/structure commune de données dans le domaine pédagogique

Prérequis

Prérequis techniques :

  • Notion de base de XML/DTD/XSLT (c.f. page travaux MALTT)
  • Avoir installé le logiciel Exchanger XML Editor ou équivalent

Activité en salle de classe

Survol/Rappel des composantes de l'exercice

XML

XML est l'acronyme de eXtended Mark-up Language. Un language de marquage est un langage qui permet de structurer de l'information à travers des balises. Les balises servent deux objectifs principaux :

  1. Donner une connotation plus précise au contenu, surtout dans la perspective du transfert de l'information à un autre agent (personne ou ordinateur)
  2. Appliquer une structure qui facilite le parsing de l'information, c'est-à-dire :
    • Faciliter la décomposition de l'information en unités ;
    • Définir la relation entre unités (e.g. hiérarchique, séquentielle, ...)
XML est un méta-language car, contrairement par exemple à HTML ou SVG pour lesquels les balises sont pré-déterminées, on peut créer sa propre liste de balises et déterminer les relations entre elles.

En d'autres termes, XML n'existe pas en tant que langage, mais existe exclusivement en tant que formalisme pour créer un language.

Un document XML simple se compose de deux parties principales :

  1. L'entête
    elle détermine qu'il s'agit d'un document XML et fourni généralement des informations supplémentaires, par exemple la version et l'encodage
  2. L'arborescence des balises
    à partir d'un élément racine individuel, les balises peuvent s’emboîter sur plusieurs niveaux
Exemple abstrait
<?xml version="1.0" encoding="UTF-8"?>

<root>
  <level-1>
    <level-2>Content</level-2>
    <level-2>Content</level-2>
  </level-1>
  <level-1>
    <level-2>Content</level-2>
    <level-2>Content</level-2>
  </level-1>
</root>
Exemple sémantique
<?xml version="1.0" encoding="UTF-8"?>

<countries>
  <country>
    <name>Switzerland</name>
    <abbr>CH</abbr>
  </country>
  <country>
    <name>Italy</name>
    <abbr>I</abbr>
  </country>
</countries>

DTD

Vu qu'on peut créer un nombre infini de langages XML, si on veut partager un langage particulier avec d'autres ou garantir une cohérence si on applique le même langage à plusieurs fichiers, il est nécessaire de formaliser des règles de structuration d'un document XML. On utilise à ce propos une grammaire (ou patron). On peut penser à une grammaire de deux manières :

  • Restrictive : une suite de règles qu'il faut respecter
    Cette conception d'une grammaire est particulièrement utile dans l'utilisation de XML pour l'échange/stockage de données.
  • Générative : des patterns de coopération entre balises qui optimisent la structuration de l'information
    Cette conception d'une grammaire est plus difficile à concevoir, car elle présuppose une fonction du langage qui va au-delà d'un ordre pré-établi des données. La fonction d'une grammaire générative s'applique à la structuration de la pensée, à la puissance combinatoire pour créer des patterns différents, etc.

Il existe différentes manières pour déterminer une grammaire XML. Nous utiliserons le format Document Type Definition (DTD). Une DTD définit la structure et les éléments admis dans un document XML qui applique cette grammaire.

En principe, la DTD définit deux choses :
  1. Quels sont les balises et les attributs admis (fonction restrictive)
  2. Comment ces balises peuvent s'organiser/s’emboîter pour produire un document XML intéressant à une finalité donnée (fonction générative)

Un fichier DTD est une liste de définition des éléments et attributs qu'on peut trouver dans le document XML qui applique la grammaire donnée.

Exemple abstrait
<!ELEMENT root (level-1+)>
<!ELEMENT level-1 (level-2+)>
<!ELEMENT level-2 (#PCDATA)>
Exemple sémantique
<!ELEMENT countries (country+)>
<!ELEMENT country (name, abbr)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT abbr (#PCDATA)>

Pour faciliter la compréhension, vous pouvez lire un document DTD en remplaçant les parenthèses avec "contient" et en spécifiant les différents notations (on en verra plus), par exemple :

  • <!ELEMENT countries (country+)> se traduit par L'élément countries contient un élément ou plusieurs élément country ;
  • <!ELEMENT country (name, abbr)> se traduit par L'élément country contient un élément name suivi par un élément abbr ;
  • <!ELEMENT name (#PCDATA)> se traduit par L'élément name contient du contenu ;
  • <!ELEMENT abbr (#PCDATA)> se traduit par L'élément abbr contient du contenu ;

XSLT

XML n'a pas une grammaire spécifique et par conséquent il est impossible de déterminer à l'avance une apparence standard des éléments XML comme c'est le cas pour HTML. En HTML le browser sait comment traduire la balise <img ...> parce que tous les développeurs sont forcés d'utiliser celle-ci s'ils veulent inclure une image. En XML, au contraire, rien n'empêche au créateur du langage d'utiliser d'autres balises à cette finalité, par exemple :

  • <image>...</image>
  • <picture>...</picture>
  • <photo>...</photo>
  • ...

Pour donner "une forme" à un document XML on utilise le eXtensible Stylesheet Language (XSL). Il s'agit d'un véritable langage de programmation, avec des structures de contrôle, boucles, etc. Mais pour cet exercice nous nous limiterons à des transformations plus simples, générée à partir d'un mécanisme de match entre un élément et un modèle de transformation.

On peut imaginer ce mécanisme comme une version plus avancée du Find and replace des éditeurs de texte : chaque fois qu'il y a l'occurrence X remplace là par Y. Dans notre cas :

  • X est un pattern XML, notamment le nom d'une balise
  • Y sera une transformation en code HTML pour que notre document XML puisse s'afficher graphiquement dans un navigateur

En termes formels selon le principe de la programmation F(X) = Y on aura donc : 

XSLT(XML) = HTML5

Il est important de bien comprendre que ceci n'est que l'une des transformations possible qu'on peut faire avec XSLT. On pourrait très bien avoir des transformations en d'autres formats, par exemple :

  • XSLT(XML) = SVG
  • XSLT(XML) = PDF
  • ...

Un fichier XSL se compose d'une liste de règles de transformation qui déterminent :

  • Quel élément XML est visée par la transformation (i.e. le match)
  • Quel sera le output après la transformation
La transformation XSL se fait automatiquement de manière récursive, c'est-à-dire que le document XML est traversé à partir de la racine jusqu'aux niveaux les plus profonds (ceux qui contient du contenu et pas d'autres balises)
Exemple abstrait
<?xml version="1.0" encoding="UTF-8"?>

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

  <xsl:output method="html"
	              doctype-system="about:legacy-compat"
	              encoding="UTF-8"
	              indent="yes" />

  <xsl:template match="root">
		<html>
			<head>
				<title>This is the title of the page</title>
			</head>
			
			<body>
				
				<xsl:apply-templates/>
				
			</body>
		</html>
  </xsl:template>

  <xsl:template match="level-1">
                <p>This is the transformation of level 1</p>
                <ul>
                        <xsl:apply-templates/>
                </ul>
  </xsl:template>


  <xsl:template match="level-2">
                <li><xsl:apply-templates/></li>
  </xsl:template>

</xsl:stylesheet>
Exemple sémantique
<?xml version="1.0" encoding="UTF-8"?>

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

  <xsl:output method="html"
	              doctype-system="about:legacy-compat"
	              encoding="UTF-8"
	              indent="yes" />

  <xsl:template match="countries">
		<html>
			<head>
				<title>A list of countries and their abbreviations</title>
			</head>
			
			<body>
				<h1>A list of countries and their abbreviations<h1>
                                <p>List:</p>
                                <ul>
				    <xsl:apply-templates/>
				</ul>
			</body>
		</html>
  </xsl:template>

  <xsl:template match="country">
                <li>
                        <xsl:apply-templates/>
                <li>
  </xsl:template>


  <xsl:template match="name">
                <strong><xsl:apply-templates/></strong> abbreviated as 
  </xsl:template>

  <xsl:template match="abbr">
                <em><xsl:apply-templates/></em>
  </xsl:template>

</xsl:stylesheet>

Combiner les trois composantes

Les trois composantes de l'exercice se combinent au niveau du fichier .xml qui contient :

  1. Une référence au fichier .dtd
  2. Une référence au fichier .xsl
  3. L'arborescence des données
<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE root SYSTEM "document-type-definition.dtd">
<?xml-stylesheet type="text/xsl" href="xslt-transformation.xsl"?>

<root>
  <level-1>
    <level-2>Content</level-2>
    <level-2>Content</level-2>
  </level-1>
</root>

Synthèse

On peut synthétiser l'articulation des trois composantes de l'exercice de la manière suivante :

  1. La DTD formalise la grammaire de tous les documents XML possibles qui peuvent être générés à partir de cette grammaire
  2. Chaque document XML est l'une des instances appliquées de la grammaire, avec des données spécifiques au cas particulier
  3. Chaque document XML généré à partir de la DTD peut être transformé dans des formats différents selon le type de transformation appliqué à travers le XSLT
Synthèse graphique des trois composantes de l'exercice

Projet 10 / Tâche

Dispositif

Le dispositif se compose de trois tâches :

  1. Imaginez et documentez une grammaire DTD qui puisse aider un auteur à rédiger des documents XML avec des données intéressantes pour un public cible
  2. Proposez un exemple concrèt de l'application de votre grammaire dans un document XML que vous devez implémenter en respectant votre DTD
  3. Créez des règles XSLT qui transforment vos données XML dans une page HTML5 stylisée avec un fichier CSS

Votre dispositif doit donc se composer au moins des fichiers suivants :

  • Un fichier *.dtd
  • Un fichier *.xml
  • Un fichier *.xsl
  • Un fichier *.css

Contraintes

  • Contenu selon vos envies et possibilités, mais en rapport avec les thématiques MALTT
  • La DTD doit aider un auteur à rédiger un type de texte pour un public cible (apprenant, enseignant, concepteur, etc.)
  • Ne faites pas :
    • une spécification pour un fichier d'échange de données (genre SVG, DocX, etc.)
    • une application administrative (e.g. gestion des étudiants dans une classe, etc.)
    • une simple base de données de type tableau, liste, etc. (e.g. catalogue de CD, programmes, ...)
  • Vous pouvez soit définir une nouvelle DTD, soit adapter une DTD existante (que vous devez citer)
  • Vos fichiers doivent passer toutes les validatios, c'est-à-dire :
    1. Votre fichier .dtd doit être valide
      Dans Exchanger XML editor choisir Schema > Validate DTD
    2. Votre fichier .xml doit être doublement valide
      Dans Exchanger XML editor utilisez :
      • Le bouton de validation vert (Validate) pour contrôler le respect de la DTD
      • Le bouton de validation rouge (Check for well-formadness) pour contrôler que votre XML est bien formaté (e.g.ouverture-clôture des balises)
    3. La transformation en HTML5 avec votre fichier .xsl doit s'afficher correctement dans le navigateur
      Pas besoin de valider le HTML5 avec le validateur Unicorn
  • Vous devez associer à votre résultat HTML5 un fichier CSS externe
    • Vous pouvez utiliser un framework CSS (e.g. Bootstrap, ...)

Critères d'évaluation

Lisez bien cette partie car la composition de l'exercice nécessite de quelques indications plus spécifiques que d'habitude

Par rapport à la grille d'évaluation utilisée habituellement dans les cours STIC, pour cet exercice veuillez noter que :

  • La documentation interne sera évalué sur la base de la DTD :
    • Choix de noms de balises sémantique par rapport au contenu
    • Utilisation d'une syntaxe cohérente en utilisant que des lettres minuscules sans caractères spéciaux ;
    • Utilisez un - si vos noms de balises sont composés par plusieurs mots (par exemple fist-name, personne-de-contact, ...)
    • Règles d'emboîtement
    • Flexibilité (e.g. éléments obligatoires/facultatifs)
  • La scénarisation pédagogique et les objectifs seront évalués en fonction du type de grammaire créée, par exemple :
    • Vous pouvez viser que l'utilisation de la DTD soit l'objectif/scénario pédagogique (e.g. fournir à des étudiants une DTD pour créer des histoires). Dans ce cas il faudra tenir compte du niveau technique des utilisateurs (connaissance XML, etc.)
    • Vous pouvez viser que le résultat HTML5 soit l'objectif/le scénario pédagogique (e.g. bien afficher les composantes principales d'une histoire pour que les étudiants puissent s'en souvenir)
    • Définissez bien quel est l'objectif primaire de la DTD (utilisation vs. résultat) dans vos rapports !
  • L'expérience utilisateur se réfère exclusivement au résultat HTML5 (i.e. si votre grammaire est difficile à utiliser mais votre page HTML5 est excellente d'un point de vue ergonomique, vous aurez 0.6 sur le critère)

Rapport

Faites un rapport selon les guidelines habituelles :

En particulier pour cet exercice :

  • Dans la section Liens insérez un link :
    • Vers le fichier *.dtd
    • Vers le fichier *.xml (vous pouvez l'appeler index.xml ou welcome.xml pour l'afficher avec l'URL du dossier, mais ne le mettez pas dans le même dossier du rapport !)
    • Vers le fichier *.xsl
  • Dans la section Objectifs :
    • Identifiez clairement qui est l'auteur-type qui pourrait bénéficier de votre DTD
    • Identifiez clairement qui est le destinateur-type qui pourrait bénéficier du résultat finale de la transformation (i.e. de la page web)
  • Dans la section Design :
    • Documentez brièvement votre DTD (la documentation principale vous pouvez la faire soit en commentaire dans le fichier même ou à travers une autre page HTML ou fichier pdf)
    • Illustrez les choix de transformation XSL, comment avez-vous pensé la mise en page et pourquoi ?

Contribution Wiki

Contribution pour la période selon les guidelines habituelles :

Quelques suggestions :

Activités en classe

Introduction à STIC II

Inscription à l'espace du cours sur Moodle (utilisé pour gérer l'évaluation)

Attention : espace différent de STIC I !!!

À mettre à jour pour Yoshi

Inscription à l'espace projets étudiant-e-s sur Moodle (il faut juste vérifier que vous avez un accès enseignant)

Tour d'éditeurs XML

  • On vous rappelle que c'est utile d'avoir Java si ce n'est pas déjà fait. Plusieurs programmes que nous allons utiliser en ont besoin.
  • Installez / utilisez un éditeur XML si c'est pas déjà fait. Voici quelques choix (signalez d'autres solutions intéressantes SVP):
Éditeur XML - Choix 1
Éditeur XML - Choix 2
  • epcEdit (Linux, Windows). Lien original cassé, mais peut-être on peut retrouver ce logiciel ailleurs
  • Le plus convivial à utiliser (mais pas à installer)
XML Copy editor - Choix 3 PC
  • XML Copy Editor
  • Download: XML Copy editor (Linux, windows)
  • Le plus facile à installer ! Assez facile à utiliser, mais moins puissant !.
  • Peut valider toutes sortes de schémas.
XML Mind editor - Choix 3 Mac
  • XmlMind
  • A vérifier. Dans le passé cet éditeur a bien fonctioné
Editeur XML - autres choix
  • C.f. XML editor
  • Il est impératif que l'éditeur puisse valider des DTDs et des schémas
  • Il est important qu'il puisse assister à l'édition, valider et exécuter XSLT avec un débogage.

Introduction à XML

Déjà faite dans le séminaire d'initiation. Pour rappel:

Warm-up - éditer une DTD de cuisine (pour ceux/celles qui veulent s'exercer un peu ...)

Copiez ces cinq fichiers:

ATTENTION: il faut "enregistrer les lien sous" / "save link as" ! Pas afficher dans le navigateur et sauver ensuite ...

Avec votre éditeur XML, ouvrez le document cuisine-template.xml. Essayez de compléter ce document. Que faut-il faire pour comprendre la logique du modèle ?

Entrez une recette ...

Créer une DTD

  • Tutoriel DTD (exposé)
  • Démo XML Exchanger lite: en:Exchanger XML Editor
    • Attention (petit bug): une fois introduit le doctype plus l'élément racine, il faut fermer/ouvrir le fichier XML !
  • Créez une DTD
    1. Imaginez un domaine à modéliser
    2. Esquissez ses éléments sur papier
    3. Créez le fichier DocType.

Exemple que vous pouvez copier/coller si vous sentez le besoin de vous exercer avec qc. qui a déjà été fait. 

 <!ELEMENT addressBook (person)+>
 <!ELEMENT person (name,email*)>
 <!ELEMENT name (family,given)>
 <!ELEMENT family (#PCDATA)>
 <!ELEMENT given (#PCDATA)>
 <!ELEMENT email (#PCDATA)>
  • Enregistrez la DTD dans un fichier qui s'appelle addressBook.dtd ou un autre nom de votre choix.
  • Faites un fichier XML avec cette DTD en partant du patron suivant:
<?xml version="1.0"?>
<!DOCTYPE addressBook SYSTEM "addressBook.dtd">

<addressBook>

</addressBook>

Explications:

  • "addressBook" est le nom de l'élément racine. La DTD ne l'indique pas, il faut donc l'indiquer à XML dans la ligne qui définit le Doctype. C'est pareil pour XHTML ou SVG ...
  • Remplacez "addressBook" et "addressBook.dtd" avec votre élément racine et votre nom de fichier.

Introduction à XSLT (exposé)

Activité XSLT

(1) Regardez d'abord des exemples, notamment la recette de cuisine ci-dessus !

Sinon, fouillez par exemple ces exemples simples: http://tecfa.unige.ch/guides/xml/examples/xsl-simple/

(2) Pour votre XML/DTD faites une simple feuille de style XSLT

Copiez/collez le patron ci-dessous si vous voulez et remplacez "VOTRE_RACINE, "UN_ELEMENT" par vos éléments. Sinon, la plupart des éditeurs XML offrent une assistance XSLT.

Chablon XSLT à copier dans un nouveau fichier *.xsl 

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">

  <xsl:output method="html"/>

  <xsl:template match="VOTRE_ELEMENT_RACINE">
    <html>
      <body bgcolor="#FFFFFF">
        <xsl:apply-templates/>
      </body>
    </html>
  </xsl:template>

  <xsl:template match="UN_ELEMENT">
    
  </xsl:template>

  <xsl:template match="UN_ELEMENT">
    
  </xsl:template>
</xsl:stylesheet>

Patron fichier XML avec XSLT 

<?xml version="1.0" ?>
<!DOCTYPE VOTRE_RACINE SYSTEM "VOTRE_DTD.dtd">
<?xml-stylesheet href="VOTRE_STYLE.xsl" type="text/xsl"?>

<VOTRE_RACINE>

</VOTRE_RACINE>

Utilisation de Exchanger

  • Lire Exchanger XML Editor ou en:Exchanger XML Editor. Au moins regarder les images dans les sections qui concernent XSLT.
  • Il est impératif de choisir Saxon (XSLT 2.0) comme engin XSLT. Les autres ont disparu dans l'installation ..... . Configurez l'éditeur: File->Preferences; XML Tab; Choisir Saxon 2.

Environement de travail/test en local

Le développement de cet exercice peut soulever quelques difficultés dans l'environnement de travail en local, car les browser ne gèrent pas tous la transformation automatique XML+XSLT en HTML de la même manière lorsqu'on ouvre le fichier (e.g. C://user/documents/etc/welcome.xml) et on utilise pas un serveur web. Voici quelques solutions :

Solution simple

Pour Windows

Normalement il n'y a pas de problème si vous utilisez

  • Microsoft Edge ou Microsoft Explorer.
  • Firefox
Pour Mac
  • Utilisez Firefox

Chrome a un bug (voulu, et ne marchera pas avec un fichier en local)

Utiliser le serveur/live preview de Brackets

Une alternative un peu brouillon est de :

  • Utilisez Exchanger pour coder/valider le XML et la DTD
  • Ouvrir le dossier de votre projet comme un projet Brackets
  • Ajouter une page qui ne sert à rien, style page.html
  • L'ouvrir en live preview (symbole du tonnerre)
  • Le browser qui s'ouvre pointe vers quelque chose de similaire à http://127.0.0.1:55152/page.html
  • Remplacez dans l'URL page.html par le nom de votre fichier XML, normalement welcome.xml
  • Laissez Brackets en arrière plan et modifier le XML/XLST avec Exchanger. Attention : il faudra mettre à jour la page du browser (F5 ou bouton update) pour voir les changements
  • À la limite vous pouvez utiliser Brackets pour le CSS, c'est mieux que Exchanger pour ça, mais faites attention que avoir ouvert les mêmes fichiers avec deux logiciels différents requièrent une certaine attention pour éviter d'écraser des changements d'une parte ou de l'autre

Lancer un serveur en local avec Node.js

Si vous avez installé Node.js, vous pouvez installer un module globalement qui vous sert de server web. Depuis la ligne de commande : 

npm install -g live-server

Puis pointer au dossier de votre projets, e.g. : 

cd /ma/grammaire/xml/

Lancez le serveur avec : 

live-server .

Pointer vers le nom de votre fichier .xml pour voir le résultat.

Normalement ce type de serveur met à jour le navigatuer après les changements, mais j'ai testé et cela n'a pas l'air de le faire avec XML+XSLT. Il faudra mettre à jour manuellement.

Ressources

Transparents
TECFA's XML page
Introduction à XML et DOM - PDF file , (transparents)
Introduction technique à XML - PDF file , (transparents)
Introduction technique à XSLT - PDF file , (transparents)
Manuels électroniques (PDF et dPUB sur XML)
[docs protégés]
Exemples de DTD
http://tecfa.unige.ch/guides/xml/examples/dtd-examples/
http://tecfa.unige.ch/guides/xml/examples/xsl-simple/
Informations sur les DTD
Structurez vos données avec XML (Open Classroom)
Pages wiki fr
XML (survol conceptuel)
Tutoriel DTD (important, comprend les éléments pour réussir l'exercice)
Encodage de caractères
Tutoriel XSLT débutant
XML Schema
Exchanger XML Editor
Pages wiki en anglais
en:Editing XML tutorial (tutoriel pour utiliser un schéma XML)
en:DTD tutorial
XML (en, mini-tutoriel + liens)
XML editor (on conseille Exchanger light, si vous n'arrivez pas à l'installer, essayez d'autres comme epcedit)
XSLT (en, liens)
XSLT Tutorial (en, mini-tutoriel)
Character encoding (en, liens encodage)
Cours COAP
La catégorie XML
en:Exchanger XML Editor
Récupérée de « https://edutechwiki.unige.ch/fmediawiki/index.php?title=STIC:STIC_II_-_exercice_10_(Yoshi)&oldid=106835 »