STIC:STIC II - exercice 10 (Aegir)

De EduTech Wiki
Aller à : navigation, rechercher

Cette page fait partie des cours STIC I et STIC II

1 Introduction

1.1 Objectifs de cet exercice

Cet exercice vous permet de relier 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.

1.2 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.

1.3 Prérequis et installation d'un éditeur XML

Prérequis techniques :

  • Notions de base de XML/DTD/XSLT (i.e ce que vous avez réalisé en MINIT avec votre page travaux MALTT)

Installation d'un éditeur XML

  • Le logiciel conseillé est Exchanger XML Editor, téléchargeable sous https://code.google.com/archive/p/exchangerxml/downloads
  • Le logiciel fonctionne sous Windows et sous Mac. Cependant, sur Mac, vous aurez peut être besoin d'installer JavaLauncher.app. Dans ce cas, pour lancer Exchanger XML editor, rendez vous dans le dossier de l'application xngr-editor, faites un clic droit et ouvrir avec JavaLauncher.app (cf. image ci-dessous)

Xml-exchanger-launcher.jpg

2 Activités synchrones

Les activités synchrones comportent 3 parties : une présentation, une démonstration/ prise en main de XML editor et un exercice d'application.

2.1 Présentation XML / DTD / XSLT

  • diapo[1]
    de présentation.

2.1.1 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 (donc un métalangage).

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 
 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <root>
 4   <level-1>
 5     <level-2>Content</level-2>
 6     <level-2>Content</level-2>
 7   </level-1>
 8   <level-1>
 9     <level-2>Content</level-2>
10     <level-2>Content</level-2>
11   </level-1>
12 </root>
Exemple sémantique
 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <countries>
 4   <country>
 5     <name>Switzerland</name>
 6     <abbr>CH</abbr>
 7   </country>
 8   <country>
 9     <name>Italy</name>
10     <abbr>I</abbr>
11   </country>
12 </countries>

2.1.2 DTD

Étant donné qu'on peut créer un nombre infini de langages XML, qu'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 pour cela 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érentes notations (on en verra plus), par exemple :

  • <!ELEMENT countries (country+)> se traduit par L'élément countries contient un élément ou plusieurs éléments 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 ;

2.1.3 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 navigateur 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 chercher et remplacer des éditeurs de texte : chaque fois qu'il y a l'occurrence X remplace la 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
 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 4 
 5   <xsl:output method="html"
 6 	              doctype-system="about:legacy-compat"
 7 	              encoding="UTF-8"
 8 	              indent="yes" />
 9 
10   <xsl:template match="root">
11 		<html>
12 			<head>
13 				<title>This is the title of the page</title>
14 			</head>
15 			
16 			<body>
17 				
18 				<xsl:apply-templates/>
19 				
20 			</body>
21 		</html>
22   </xsl:template>
23 
24   <xsl:template match="level-1">
25                 <p>This is the transformation of level 1</p>
26                 <ul>
27                         <xsl:apply-templates/>
28                 </ul>
29   </xsl:template>
30 
31 
32   <xsl:template match="level-2">
33                 <li><xsl:apply-templates/></li>
34   </xsl:template>
35 
36 </xsl:stylesheet>
Exemple sémantique
 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 4 
 5   <xsl:output method="html"
 6 	              doctype-system="about:legacy-compat"
 7 	              encoding="UTF-8"
 8 	              indent="yes" />
 9 
10   <xsl:template match="countries">
11 		<html>
12 			<head>
13 				<title>A list of countries and their abbreviations</title>
14 			</head>
15 			
16 			<body>
17 				<h1>A list of countries and their abbreviations<h1>
18                                 <p>List:</p>
19                                 <ul>
20 				    <xsl:apply-templates/>
21 				</ul>
22 			</body>
23 		</html>
24   </xsl:template>
25 
26   <xsl:template match="country">
27                 <li>
28                         <xsl:apply-templates/>
29                 <li>
30   </xsl:template>
31 
32 
33   <xsl:template match="name">
34                 <strong><xsl:apply-templates/></strong> abbreviated as 
35   </xsl:template>
36 
37   <xsl:template match="abbr">
38                 <em><xsl:apply-templates/></em>
39   </xsl:template>
40 
41 </xsl:stylesheet>

2.1.4 Synthèse

Combiner les trois composantes
Articulation des 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
 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <!DOCTYPE root SYSTEM "document-type-definition.dtd">
 4 <?xml-stylesheet type="text/xsl" href="xslt-transformation.xsl"?>
 5 
 6 <root>
 7   <level-1>
 8     <level-2>Content</level-2>
 9     <level-2>Content</level-2>
10   </level-1>
11 </root>


Articulation des trois composantes

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

2.2 Démonstration/prise en main

2.2.1 Télécharger les fichiers depuis GitHub

2.2.2 Ouvrir Exchanger XML Editor et créer un projet

La manière la plus simple pour travailler sur les différentes fichiers dans Exchanger XML Editor consiste à créer un projet et ajouter un dossier virtuel.

Pour créer un projet :

  1. Menu principal Project > New Project
  2. Donner un nom au projet, par exemple Workshop ex10, le projet s'ajoute à la liste (à gauche)
  3. Clic droit sur le projet et choisissez Add virtual folder...
    Ajouter un dossier virtuel
  4. Pointer vers le dossier que vous avez dezippé et l'ajouter. En réalisant cette manipulation, vous avez accès à tous les fichiers directement à l'intérieur de l'interface
    Structure d'un projet avec un dossier virtuel

2.2.3 Prise en main XML Exchanger Editor

  1. Ouvrez le fichier warm-up/addressBook.dtd
  2. Ouvrez le fichier warm-up/welcome.xml
  3. Cliquez sur View > Split vertically
  4. Placez votre curseur à l'intérieur des balises <addressBook> </addressBook>
  5. Sélectionnez le tab "Helper" (voir capture d'écran)
    Tab "Helper" de Exchanger XML Editor, avec un fichier DTD et un fichier XML ouverts
  6. Vérifiez que vous avez plus au moins la même chose sur votre écran et demandez de l'aide si ce n'est pas le cas

2.2.4 DTD, XML, XSL et CSS

Grammaire DTD

Pour rappel, il existe deux manières de réaliser une DTD : en interne ou en externe. Avant de commencer à remplir votre fichier XML à partir de votre grammaire DTD, vous pouvez vérifier que votre DTD est valide en avec le menu Schema -> Validate DTD.

XML
  1. Commencez à remplir le document XML en suivant les guidelines de la DTD, par exemple :
    • Mettre le <name> avant <email> à l'interieur de <person>
    • Mettre le <family> avant <given> à l'intérieur de <name>
  2. Aidez-vous des outils suivants :
    • Bouton Validate (V en vert) pour valider par rapport aux guidelines de la DTD et,
    • Bouton Check for well-formedeness (V en rouge) pour valider par rapport aux balises XML
    • Commande Edit > XML > Format pour bien formater/indenter les balises XML
  3. Quand vous avez inséré au moins un contact (i.e. une balise <person> avec les sous-balises), cherchez le fichier welcome.xml dans le gestionnaire des fichiers de votre ordinateur et ouvrez-le avec Firefox ou Microsoft Edge (pas Chrome)
    • En alternative vous pouvez ouvrir directement Firefox et puis utilisez le menu Open > File et pointez vers le fichier welcome.xml

Important

  • Remarquer le lien vers le fichier DTD, notamment la mention de l'élément racine "addressbook". Lier ce fichier au fichier XML pour qu'il "connaisse" les règles,
  • Remarque le lien vers le fichier XSL pour le fichier XML connaisse les règles de transformation.
XLS
  1. Cliquer sur File > Open et pointez vers le fichier warm-up/transformation.xsl.
  2. Voici la déclaration de transformation
    	<xsl:output method="html"
    	              doctype-system="about:legacy-compat"
    	              encoding="UTF-8"
    	              indent="yes" />
    
  3. Regarder la construction des règles de transformation
    <xsl:template match="person">
    	<!-- Insertion d'une transformation d'une balise <li>, nous insérons un template à l'intérieur de cette balise -->
    		<li>
    			<xsl:apply-templates/>
    		</li>
    
  4. Transformation du document en HTML et visualisation dans le navigateur
    • Ouvrir le fichier XML et se positionner sur ce fichier.
    • Cliquer sur le menu Transform -> Execute Advanced XSLT > . Il y a 3 éléments à régler :
      • Input : current document
      • Processor, sélectionner Saxon (XSLT 2.0). C'est le seul processeur qui fonctionne dans l'édition V3.3.1.
      • Output : To new document
  5. Enregistrer ensuite le nouveau document en HTML et tester ensuite en ouvrant le fichier dans un navigateur
CSS (option)

Pour ajouter du CSS, il suffit d'inclure la référence à un fichier *.css dans le template du fichier *.xsl qui s'occupe de transformer la racine.

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <!-- Define the XSL transformation element -->
 4 <xsl:stylesheet version="1.0" 
 5 	xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 6 
 7 	<!-- Define the type of output as HTML -->
 8 	<xsl:output method="html" doctype-system="about:legacy-compat" encoding="UTF-8" indent="yes" />
 9 
10 	<!-- 
11 		Start by defining the transformation of each element that can be found in the DTD.
12 		We start with the root element "page".
13 		Since this is the root element, we will use it to inject an HTML5 simple template
14 	-->
15 
16 	<xsl:template match="page">
17 		<html>
18 			<head>
19 				<title>Simple set-up of XML, DTD and XSLT</title>
20 				<!-- WE ADD THE CSS REFERENCE HERE, AS IN A NORMAL HTML5 FILE -->
21 				<link rel="stylesheet" href="style.css"/>
22 			</head>

2.3 Consignes exercice synchrone

1) Imaginer et documenter une grammaire DTD qui puisse aider la professeure Pâquerette à rédiger un document XML permettant de formaliser les travaux de ses élèves (rapports, exercices …). Appuyez-vous sur 2.4.1. Créer une DTD et associer au XML

Contraintes DTD :

  • Un élément parent comportant un ou plusieurs sous-éléments enfants obligatoires de type <!ELEMENT parent (element-enfant, ...)>
  • Un élément parent comportant un/des élément(s) enfant(s) optionnel(s) de type <!ELEMENT parent (element-enfant?)> ou  <!ELEMENT parent (element-enfant*)>  (justifier et documenter ce choix)
  • Un élément parent pouvant comporter un ou plusieurs éléments enfant de type <!ELEMENT parent (element-enfant+)>
  • BONUS : un élément à choix de type  <!ELEMENT parent (element-1 | element-2)>

2) Créer un fichier XML et le remplir en suivant la DTD. Chaque balise doit être au moins utilisée une fois.

3) Transformer vos balises XML en HTML utilisant le langage XSL. Appuyez-vous sur le point 2.4.2 Combiner avec XSLT de cette page wiki. A minima, dans votre fichier, définissez le type d’output et réaliser une transformation sur au moins deux balises de votre fichier XML.

4) BONUS Lier une feuille de style *.css. Appuyez vous sur le point 2.4.3 Ajouter du CSS si besoin. Refaire dans ce cas, la transformation.

Conseils et temps indicatif de chaque étape

  • Conseils
    • Etape 1 : commencer par modéliser votre DTD sur papier ou sur un logiciel de mind mapping avant de vous lancer.
    • Etape 2 : attention au pointage vers le fichier *.dtd et l’élément racine !
  • Temps indicatif : 65’ + 10' de temps de révision de l'ensemble.
    • DTD : 25' soit 15' pour réaliser un prototype papier et 10' implémenter dans XML Exchanger Editor
    • XML : 20’
    • XSLT : 10’
    • CSS : 10’ (ne soyez pas trop ambitieux!, il s'agit uniquement de voir si cela fonctionne).

2.4 Ressources exercice synchrone et projet à distance

2.4.1 Créer une DTD et associer au XML

Références principales :

Activité conceptuelle

On commence rarement par définir directement le formalisme d'une grammaire. On commence plutôt par essayer de modéliser des arborescences prototypiques pour avoir une idée des éléments dont on peut avoir besoin et de la manière de les combiner.

  1. Imaginez un domaine à modéliser à travers un langage de marquage
  2. Esquissez ses éléments sur papier ou en utilisant un logiciel de mind mapping
  3. Essayez déjà de déterminer (indépendamment de la notation que vous utilisez) des éléments récursifs, optionnels ou alternatifs. Par exemple :
    • Une personne peut avoir plusieurs adresses emails
    • Une personne peut avoir un deuxième nom ou pas
    • Une personne peut avoir un numéro de portable ou un numéro fixe
Activité pratique

Essayez de formuler votre grammaire dans un fichier .dtd en procédant de la manière suivante :

  1. Définissez votre élément racine et identifiez tous les éléments/tags différents qui peuvent se trouver au premier niveau d’emboîtement (les children)
       <!ELEMENT votre-racine (child-1, child-2, ...)>
    
  2. Répétez cette opération pour chaque child de premier niveau.
    • Si l'élément peut contenir d'autres sous-éléments, il faudra les lister à l'intérieur des parenthèses, par exemple :
         <!ELEMENT child-1 (sub-element-1, sub-element-2, ...)>
      
    • Si l'élément ne contient pas des sous-éléments mais directement la valeur souhaitée, il faudra l'indiquer en utilisant #PCDATA ou #CDATA à l'intérieur des paranthèses, par exemple :
         <!ELEMENT child-1 (#PCDATA)>
      
  3. Répétez l'opération précédente pour des éventuels descendants de deuxième/troisième/.../n-ième niveau
  4. Une fois définit tous les éléments, vous pouvez ajouter les notations pour mieux spécifier votre grammaire. Voici quelques possibilités (pour une liste plus exhaustive voir le Tutoriel DTD :
    • element (sans notation supplémentaire) : l'élément est obligatoire et il ne peut être utilisé qu'une seule fois (par rapport à l'élément parent)
         <!ELEMENT parent (element)>
      
    • element? : l'élément est optionnel. S'il est utilisé, il ne peut être utilisé qu'une seule fois (par rapport à l'élément parent)
         <!ELEMENT parent (element?)>
      
    • element+ : l'élément est obligatoire, il en faut au moins un, mais on peut en avoir aussi plusieurs
         <!ELEMENT parent (element+)>
      
    • element* : l'élément est optionnel, si on l'ajoute on peut en avoir un ou plusieurs
         <!ELEMENT parent (element*)>
      
    • element-1 | element-2 : il faut choisir entre element-1 et element-2
         <!ELEMENT parent (element-1 | element-2)>
      
    • element-1, element-2 : element-1 doit être suivi par element-2
         <!ELEMENT parent (element-1, element-2)>
      
    • La notation peut être faite de manière distributive, par exemple (element-1*, element-2*) est équivalent à (element-1, element-2)*

Une fois satisfait de votre grammaire (même de manière provisoire), créez un fichier *.xml dans le même dossier de votre DTD et commencez à le remplir en respectant la grammaire. Vous pouvez partir de ce template qui doit être adapté selon votre cas spécifique (i.e. pointage au fichier *.dtd et element racine) :

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE your-root-element SYSTEM "path-to-your-grammar.dtd">

<your-root-element>

</your-root-element>

2.4.2 Combiner avec XSLT

Références principales :

Exemple XSLT de base

Voir example/01-set-up dans les fichiers GitHub

Transformation du code XML suivant :

<?xml version="1.0" encoding="UTF-8"?>

<!-- 
    Link to the DTD so that the XML files "knows" the rules !
    You must indicate the name of the root element for the DTD to apply to your document.
    In our case, the root element is the element "page" 
-->
<!DOCTYPE page SYSTEM "document-type-definition.dtd">

<!--
	Link to the XSLT file so that the XML "knows" how to be transformed in HTML
-->
<?xml-stylesheet type="text/xsl" href="xslt-transformation.xsl"?>

<!--
    Since the "page" element is our root, we must start from it.
    It will contain all the other children
-->

<page>
    <header>This is the content of the header element</header>
    <main>This is the content of the main element</main>
    <footer>This is the content of the footer element</footer>
</page>

En utilisant le XSLT suivant :

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <!-- Define the XSL transformation element -->
 4 <xsl:stylesheet version="1.0"
 5                 xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 6                 
 7 	<!-- Define the type of output as HTML -->
 8 	<xsl:output method="html"
 9 	              doctype-system="about:legacy-compat"
10 	              encoding="UTF-8"
11 	              indent="yes" />
12 	
13 	<!-- 
14 		Start by defining the transformation of each element that can be found in the DTD.
15 		We start with the root element "page".
16 		Since this is the root element, we will use it to inject an HTML5 simple template
17 	-->
18 	
19 	<xsl:template match="page">
20 		<html>
21 			<head>
22 				<title>Simple set-up of XML, DTD and XSLT</title>
23 			</head>
24 			
25 			<body>
26 				
27 				<!-- Since here we want our three children, we tell XSLT to apply other templates -->
28 				<xsl:apply-templates/>
29 				
30 			</body>
31 		</html>
32 	</xsl:template>
33 	
34 	<!-- 
35 		Then we define a match for each child element	
36 	-->
37 	
38 	<!-- Define the header transformation -->
39 	<xsl:template match="header">
40 		<header>
41 			<!-- We want the content inside an h1 tag, so we inject the apply-template inside it -->
42 			<h1>
43 				<xsl:apply-templates/>
44 			</h1>
45 		</header>
46 	</xsl:template>
47 	
48 	<!-- Define the main transformation -->
49 	<xsl:template match="main">
50 		<main>
51 			<!-- We want the content inside a generic div tag, to which we will give a class for later use, so we inject the apply-template inside it -->
52 			<div class="css-reference">
53 				<xsl:apply-templates/>
54 			</div>
55 		</main>
56 	</xsl:template>
57 	
58 	<!-- Define the footer transformation -->
59 	<xsl:template match="footer">
60 		<footer>
61 			<!-- We want the content inside a p tag, so we inject the apply-template inside it -->
62 			<p>
63 				<xsl:apply-templates/>
64 			</p>
65 		</footer>
66 	</xsl:template>
67 	
68 </xsl:stylesheet>

Pour inspecter l'HTML utilisez les outils développeurs de Google Chrome :

  • F12
  • Cliquez sur le tab Elements

2.4.3 Ajouter du CSS

Voir examples/02-add-css dans les fichiers GitHub

Pour ajouter du CSS, il suffit d'inclure la référence à un fichier *.css dans le template du fichier *.xsl qui s'occupe de transformer la racine.

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <!-- Define the XSL transformation element -->
 4 <xsl:stylesheet version="1.0" 
 5 	xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 6 
 7 	<!-- Define the type of output as HTML -->
 8 	<xsl:output method="html" doctype-system="about:legacy-compat" encoding="UTF-8" indent="yes" />
 9 
10 	<!-- 
11 		Start by defining the transformation of each element that can be found in the DTD.
12 		We start with the root element "page".
13 		Since this is the root element, we will use it to inject an HTML5 simple template
14 	-->
15 
16 	<xsl:template match="page">
17 		<html>
18 			<head>
19 				<title>Simple set-up of XML, DTD and XSLT</title>
20 				<!-- WE ADD THE CSS REFERENCE HERE, AS IN A NORMAL HTML5 FILE -->
21 				<link rel="stylesheet" href="style.css"/>
22 			</head>
23 
24 			<body>
25 
26 				<!-- Since here we want our three children, we tell XSLT to apply other templates -->
27 				<xsl:apply-templates/>
28 
29 			</body>
30 		</html>
31 	</xsl:template>
32 
33 	<!-- 
34 		Then we define a match for each child element	
35 	-->
36 
37 	<!-- Define the header transformation -->
38 	<xsl:template match="header">
39 		<header>
40 			<!-- We want the content inside an h1 tag, so we inject the apply-template inside it -->
41 			<h1>
42 				<xsl:apply-templates/>
43 			</h1>
44 		</header>
45 	</xsl:template>
46 
47 	<!-- Define the main transformation -->
48 	<xsl:template match="main">
49 		<main>
50 			<!-- We want the content inside a generic div tag, to which we will give a class for later use, so we inject the apply-template inside it -->
51 			<div class="css-reference">
52 				<xsl:apply-templates/>
53 			</div>
54 		</main>
55 	</xsl:template>
56 
57 	<!-- Define the footer transformation -->
58 	<xsl:template match="footer">
59 		<footer>
60 			<!-- We want the content inside a p tag, so we inject the apply-template inside it -->
61 			<p>
62 				<xsl:apply-templates/>
63 			</p>
64 		</footer>
65 	</xsl:template>
66 
67 </xsl:stylesheet>

Selon le même principe on peut ajouter :

  • d'autres fichiers CSS
  • des fichiers JavaScript
  • en général, tout ce qu'on peut avoir dans une page HTML5

2.4.4 Réutiliser un élément de deux manières différentes

Ce qu'il faut bien comprendre dans la transformation XSLT est qu'on déclare un élément une seule fois, mais on peut le réutiliser à différents endroits. Dans l'exemple examples/03-instruction-for-objective, la DTD propose une simple manière pour définir des objectifs et les instructions pour les atteindre. Ces instructions peuvent être soit sous forme de liste non ordonnée ou de séquence ordonnée :

 9 <!-- The objective contains a title, a description and either a sequence or a list -->
10 <!ELEMENT objective (title, description, (sequence | list))>

Dans les deux cas, une séquence ou une liste contiennent une instruction :

18 <!-- A sequence contains one or more instructions -->
19 <!ELEMENT sequence (instruction+)>
20 
21 <!-- Also a list contains one more more instructions -->
22 <!ELEMENT list (instruction+)>

Dans la transformation XSLT on peut traduire ce mécanisme de manière à ce que :

  • La séquence soit traduite en ol
  • La liste soit traduite en ul
  • L'instruction soit traduite en li

Voici un extrait du code :

44     <xsl:template match="sequence">
45         <!-- Since it is ordered, we transform in ol -->
46         <ol>
47             <xsl:apply-templates/>
48         </ol>
49     </xsl:template>
50 
51     <xsl:template match="list">
52         <!-- Since it is unordered, we transform in ul -->
53         <ul>
54             <xsl:apply-templates/>
55         </ul>
56     </xsl:template>
57 
58     <xsl:template match="instruction">
59         <!-- All instruction will be li, and will inherit a number or a bullet depending on where they are inserted -->
60         <li>
61             <xsl:apply-templates/>
62         </li>
63     </xsl:template>

De cette manière, l'instruction va être associée à un chiffre ou à un bullet selon qu'elle se trouve à l'intérieur d'un élément XML list ou sequence, car les deux sont traduites respectivement dans une liste ordonnée ou non-ordonnée en HTML5.

3 Activités à distance - projet

3.1 Lectures et ressources

Ressources indispensables :

Les articles Edutech Wiki ci-dessus proposent les contenus utiles aux finalités pédagogiques du cours. Pour compléter l'exercice ou atteindre les objectifs spécifiques à votre dispositif, d'autres ressources peuvent être nécessaires.

3.2 Dispositif

Le dispositif se compose de trois tâches :

  1. Imaginez et documentez une grammaire DTD qui puisse aider un-e auteur-e à rédiger des documents XML avec des données intéressantes pour un public cible
  2. Proposez un exemple concret 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

3.2.1 Contraintes

  • Contenu selon vos envies mais en rapport avec les thématiques MALTT
  • La DTD doit aider un-e auteur-e à 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 validations, 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, ...) mais vous devez citer vos sources.

3.2.2 Conseils

  • Ne soyez pas trop ambitieux dans le nombre d'éléments différents car chaque élément doit être déclaré dans la DTD et puis traduit dans le XSL !
  • Privilégiez des templates récursifs plutôt que des longues listes d'élément séparés
  • Soyez plutôt flexibles dans votre DTD : ne mettez les éléments obligatoires que s'ils sont vraiment fondamentaux, sinon mettez-les en options - cela réduit aussi le nombre d'erreurs de validation !
  • XML/DTD/XSLT sont beaucoup plus stricts que HTML5, la moindre erreur de syntaxe peut tout compromettre
  • Cet exercice nécessite beaucoup de concentration, ne faites pas les choses à la hâte!

3.3 Critères d'évaluation

Lisez bien cette partie car la composition de l'exercice nécessite 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 uniquement des lettres minuscules sans caractères spéciaux ;
    • Utilisez un - si vos noms de balises sont composées de plusieurs mots (par exemple first-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)

3.4 Rapport

Faites un rapport selon les guidelines habituelles :

En particulier pour cet exercice :

  • Dans la section Liens, insérer les liens  :
    • 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
    • Vers le fichier *.css
  • Dans la section Objectifs :
    • Identifiez clairement quel est l'auteur-e-type qui pourrait bénéficier de votre DTD
    • Identifiez clairement quel est le/la destinateur/trice-type qui pourrait bénéficier du résultat final de la transformation (i.e. de la page web)
  • Dans la section Design :
    • Documentez brièvement votre DTD (la documentation principale peut être faite dans le fichier même ou à travers une autre page HTML ou fichier pdf)
    • Expliquez vos choix de transformation XSL, comment avez-vous pensé la mise en page et pourquoi ?

3.5 Contribution Wiki

Contribution pour la période selon les guidelines habituelles :

Quelques suggestions :

3.6 Délai

Dimanche 23 Mai 2021 à 23h59

4 Environnement 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 :

4.1 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)

4.2 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

4.3 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.

5 Ressources

5.1 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.

5.2 Liens

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