L’objectif principal de ce travail est de vous familiariser avec le concept de
modèleXML3011 comme approche à la création d’un modèle XML. C’est
sous la forme d’un modèleXML3011 que vous créerez votre modèle dans le
cadre des travaux de modélisation préliminaire (TP 4) et de modélisation et stylage
(TP 5).
Un objectif secondaire est de vous familiariser avec le processus concret de
création des trois différents fichiers qui composent un
modèleXML3011.
Un autre objectif secondaire est de vous exercer à la rédaction de modèles de
contenu en vous amenant à en transcrire quelques-uns aux endroits appropriés dans un
modèleXML3011.
Aperçu
Un modèleXML3011 est une description d’un modèle XML suffisamment
précise pour qu’on puisse en tirer automatiquement :
La DTD du modèle.
Une documentation du modèle.
La DTD inclut non seulement les déclarations des différents éléments et attributs
du modèle, mais également les commentaires doc: qui permettront à un
éditeur XML (comme oXygen) de présenter aux auteurs des infobulles d’aide à la
saisie.
La documentation produite est pour consommation humaine et prend la forme d’un
tableau HTML navigable (i.e., contenant des liens internes) qui présente de façon
conviviale chaque élément et chaque attribut du modèle. Chaque élément ou attribut
est accompagné de sa définition, telle qu’on la retrouve dans sa déclaration
ELEMENT ou ATTLIST, du texte de son infobulle d’aide à
la saisie et d’un éventuel commentaire de modélisation, qui peut par exemple servir
à justifier une décision de modélisation.
Concrètement, un modèleXML3011 est un document XML valide, conforme à
une DTD spécifique, dans lequel la modélisatrice décrit et documente de façon
précise chaque élément et chaque attribut de son modèle. Les dérivations de la DTD
et du tableau de documentation s’effectuent en appliquant à ce document XML deux
transformations XSLT distinctes.
Les trois fichiers composant un modèleXML3011 complet sont donc :
Le fichier XML valide du modèleXML3011, créé directement par la
modélisatrice (fichier .xml).
La DTD (fichier .dtd) dérivée automatiquement de ce fichier.
Le tableau HTML navigable de documentation (fichier .html), lui
aussi dérivé automatiquement.
Ce travail vise à familiariser la participante avec le processus concret de
création d’un modèleXML3011 et n’inclut donc pas la conception
d’un modèle XML. Il consiste simplement à traduire un modèle existant en
modèleXML3011, puis à en dériver automatiquement la DTD et le fichier
HTML de documentation.
Quoi faire ?
Création du modèle
Vous devez créer un modèleXML3011 répondant aux caractéristiques
suivantes :
L’élément de plus haut niveau est mémo.
Le modèle comporte 5 éléments, dont les nom, modèle de contenu et description
pour infobulle sont comme suit :
Nom de l’élément
Modèle de contenu
Description pour infobulle d’aide à la saisie
mémo
(de, à, corps)
Mémo pour envoi par courriel.
de
(#PCDATA)
Nom de l’auteur du mémo, forme : Prénom Nom
à
(#PCDATA)
Nom du destinataire du mémo, forme : Prénom Nom
corps
(para+)
Le texte du mémo; doit contenir au moins un paragraphe.
para
(#PCDATA)
Un paragraphe de texte.
L’élément mémo a un attribut facultatif nommé date,
de type NMTOKEN. La description pour infobulle d’aide à la saisie pour cet
attribut est :
Date de rédaction du mémo, forme AAAA-MM-JJ
Les éléments de et à ont chacun un attribut
obligatoire nommé courriel, de type CDATA. La description pour
infobulle d’aide à la saisie est le même pour ces deux attributs, et se lit
ainsi :
Adresse courriel complète de la personne.
Il n’y a aucun autre attribut que ceux mentionnés ci-dessus.
La façon de créer un modèleXML3011 est détaillée dans le texte Travailler avec un modèleXML3011. Suivez attentivement les
directives données dans ce texte, de même que les consignes suivantes, qui sont
spécifiques au présent TP :
Comme contexteDuModèle, inscrivez simplement « TP 3 ».
Pour les éléments de, à et para,
composez des exemples de contenu attendu (sous-éléments exemple de
exemplesContenuAttendu) plausibles, compte tenu du type de
documents (des mémos) et de la description pour infobulle d’aide à la saisie de
l’élément.
Ne donnez pas d’exemples de contenu attendu pour les éléments
mémo et corps.
Pour les trois attributs, composez des exemples de valeur attendue
(sous-éléments exemple de exemplesValeurAttendue)
plausibles, compte tenu du type de documents (des mémos) et de la description
pour infobulle d’aide à la saisie de l’attribut.
N’inscrivez aucun commentaire de modélisation (élément
commentairesDeModélisation), ni pour les éléments, ni pour les
attributs.
N.B.: Ces consignes sont spécifiques au TP 3, elles ne
s’appliqueront pas aux TP 4 et 5.
Une fois le modèle entièrement décrit dans votre fichier memo.xml,
assurez-vous que ce dernier est valide, puis passez à l’étape suivante.
Dérivation de la DTD et du tableau navigable
Suivez les instructions données dans le texte Travailler avec un modèleXML3011 pour produire les fichiers
dérivés du modèleXML3011 : la DTD et le tableau navigable en HTML.
Cette opération créera deux nouveaux fichiers dans le dossier de votre modèle :
memo.dtd et memo.html, qui seront respectivement ouverts
automatiquement dans un nouvel onglet d’oXygen et de votre navigateur Web.
Prenez la peine de consulter le tableau navigable et de parcourir certains des
liens internes qu’il contient. S’il y a des messages d’erreur en rouge dans le
tableau ou si oXygen signale une erreur, c’est qu’un modèle de contenu (ou plus) est
en erreur; voir Travailler avec un modèleXML3011.
Mise en œuvre du modèle
Maintenant que vous disposez d’une DTD, reprenez temporairement la casquette de
l’encodeur et créez avec oXygen un nouveau document conforme à cette DTD :
Faites Fichier → Nouveau → Document XML.
Cochez la boîte Enregistrer sous et, comme
emplacement de sauvegarde, inscrivez l’URL (dérivée du chemin d’accès) du
dossier de votre modèle, suivie du nom de fichier
exempleMemo.xml :
Cliquez sur Personnaliser.
Vis-à-vis URL du schéma, inscrivez l’URL (dérivée du
chemin d’accès) de la DTD dans le dossier de votre modèle, puis choisissez
mémo comme Élément racine. Assurez-vous
aussi que la boîte Ajouter du contenu optionnel est
décochée et que Ajouter la première particule de choix
est cochée :
Cliquez sur Créer.
Inventez des contenus plausibles pour les différents éléments et attributs du
document. Vous pouvez mettre un para ou plus dans le
corps, à votre choix.
Observez comment les descriptions pour infobulle que vous avez spécifiées dans
votre modèleXML3011 sont mises en œuvre par oXygen lorsque votre
curseur survole un nom d’élément ou d’attribut.
Quand le mémo est complet, assurez-vous qu’il est valide, puis faites une
sauvegarde finale.
À remettre
Vous effectuez la remise dans l’espace prévu à cet effet sur la page StudiUM du
cours.
Vous devez remettre un unique fichier compressé (.zip) contenant
quatre fichiers :
Les trois fichiers qui composent le modèleXML3011 créé.
L’exemple de mémo exempleMemo.xml conforme à votre DTD.
Le fichier compressé déposé sur StudiUM doit porter un nom composé à partir du nom
de l’étudiante. Assurez-vous cependant que tous les fichiers remis – autant le
fichier compressé que les fichiers qu’il contient – portent un nom sans espace,
caractère accentué, ni caractère spécial.
