Copyright © 2023 Yves MARCOUX; dernière modification de cette page: 2023-02-20.
TP 4 – Travail en équipe
Yves MARCOUX – EBSI – Université de Montréal
Ce protocole présente la mise en situation du projet de Modélisation et stylage, réalisé en équipe, et donne les directives nécessaires à la remise de la Modélisation préliminaire. Des protocoles distincts couvriront le reste du projet (les TP 5 et 6).
modèleXML3011Vous devez modéliser en XML (c’est-à-dire créer un modèle, ou DTD) des fiches descriptives des objets d’une collection. Vous faites ce travail pour un ami collectionneur qui souhaite gérer sa collection sous la forme d’un ensemble de documents XML, sur lequel il pourra effectuer des recherches utilisant les critères habituels de recherche pour ce type d’objet. Un objectif secondaire de votre ami est de pouvoir produire à intervalle régulier un « catalogue imprimé » de sa collection en PDF, incluant des photos des objets de sa collection.
Dans une partie subséquente du projet, vous aurez à saisir une douzaine de fiches (donc, de documents XML) conformes à votre modèle, puis à préparer des feuilles de style XSLT pour en faire deux présentations différentes. Cette seconde partie du travail sera donc en quelque sorte une « preuve de concept » de votre modèle.
Types d’objet possibles
Le choix du type d’objet doit être approuvé par le professeur (voir la procédure d’approbation ci-dessous). La collection (comme l’ami) peut être fictive, mais vous avez intérêt à choisir un type d’objets que vous connaissez bien. Les critères à respecter sont :
Il ne doit pas s’agir de documents sous quelque forme que ce soit. Donc, pas de livres, fiches de recettes, partitions musicales, etc.
Il ne doit pas s’agir de personnes.
Il doit s’agir d’objets physiques qui peuvent être photographiés. Vous devrez être en mesure de fournir vous-même les photos des objets. L’idéal est d’utiliser vos propres photos, mais pour les besoins du projet de modélisation et stylage seulement, il sera permis d’utiliser sans permission explicite des images de toute provenance, puisque (1) le travail ne fera l’objet d’aucune diffusion et (2) les photos elles-mêmes ne jouent qu’un rôle très accessoire dans le travail intellectuel demandé.
Il ne doit pas s’agir de catégories d’objets, comme des « sortes » de bière ou de yogourt, des « marques » ou des « modèles » de voitures ou d’armes à feu, des « types » de pâte alimentaire, des « espèces » d’oiseau, etc., même si ces catégories d’objets possèdent des spécimens physiques que l’on pourrait photographier. Pour illustrer ce critère, disons qu’une collection de voitures spécifiques, en tant qu’objets physiques avec chacun sa couleur et ses options spécifiques, serait acceptable, mais pas une liste de modèles de voiture (par exemple les modèles produits par Ford entre 1970 et 1990 ou disponibles sur le marché en 2023). Ce critère est pour limiter la complexité de la modélisation.
Les objets doivent posséder au moins une caractéristique pouvant être exprimée par une valeur numérique et qui peut servir de critère de recherche (par exemple, trouver les objets mesurant plus de 10 cm). Cette mesure peut être une caractéristique matérielle, comme la taille ou la masse, mais ce peut être également, un prix, une date, etc.
La demande d’approbation d’un type d’objet se fait exclusivement par courriel.
Le courriel envoyé au professeur doit contenir les informations obligatoires mentionnées ci-dessous.
Assurez-vous d’abord que le type d’objet que vous proposez rencontre les critères exposés ci-dessus.
Ensuite, demandez l’approbation d’un type d’objet, en envoyant un courriel dans lequel vous :
SVP, utilisez les lettres a. à f., en référence à la liste ci-dessus, pour identifier dans votre courriel les différentes informations demandées. Allouez quelques jours pour la réponse du professeur dans la planification de votre travail.
Si plus d’une équipe propose le même type d’objet, en répondant de façon satisfaisante aux points ci-dessus dans son courriel, l’approbation se fera sur la base « premier arrivé, premier servi ». Pour éviter les déceptions, consultez la liste des types d’objet qui ne sont plus disponibles avant de proposer un type d’objet. Cette liste est mise à jour le plus régulièrement possible.
Ce travail consiste à élaborer une version préliminaire de votre modèle de fiches,
sous la forme d’un modèleXML3011.
Tel que vu en classe, une réflexion efficace sur un modèle en développement inclut la rédaction d’hypothèses de documents valides. Une hypothèse de document valide est un document XML bien formé qui constitue un exemple de document que l’on voudra valide selon le modèle en élaboration.
La plupart des hypothèses de documents valides sont des documents « jetables », qui servent ponctuellement à soutenir une partie de la réflexion. Quand la réflexion est suffisamment avancée, cependant, ils constituent une aide précieuse à la rédaction du modèle. Quand le modèle est finalisé, ces hypothèses de documents valides deviennent des exemples de documents valides.
Dans le cadre de ce travail, on vous demande de créer trois hypothèses de documents valides correspondant au niveau d’avancement du modèle que vous remettez. Ces trois documents devraient être valides selon le modèle remis; en ce sens, on pourrait les considérer comme des exemples de documents valides (plutôt que comme des hypothèses), cependant, le fait le modèle remis est préliminaire justifie l’appellation « hypothèse de document valide ».
Dans un de ces documents, toutes les informations facultatives seront absentes, dans un autre, elles seront toutes présentes et, dans le dernier, vous inscrirez au moins deux occurrences de toutes les informations répétables. Un des trois documents doit représenter un objet pour lequel il n’y a pas de photo disponible (voir le point 3 des Exigences de modélisation).
N.B.: Il sera opportun de tenir compte des Exigences de modélisation, de même que des principes de modélisation, dès la rédaction de vos hypothèses de documents valides.
modèleXML3011On vous demande de produire votre modèle sous la forme d’un modèleXML3011, et d’en tirer automatiquement :
doc:, qu’un
éditeur comme oXygen peut transformer en infobulles d’aide à la saisie.Notez que le tableau navigable est utile autant pendant la mise au point du modèle que comme documentation une fois le modèle finalisé.
Revoir le texte Travailler
avec un modèleXML3011 pour plus de détails sur comment créer un
modèleXML3011 et en dériver une DTD et un tableau navigable.
N.B.: Pour cette modélisation préliminaire, la
partie « documentation » du modèleXML3011 peut être incomplète; en
l’occurrence, le contexteDuModèle, les
descriptionPourInfobulle et les
commentairesDeModélisation peuvent être minimaux, voire absents.
À ce stade-ci, vous ne mettrez la casquette d’autrice que pour la rédaction des trois hypothèses de document valides demandées. Plus tard dans le projet, quand votre modèle sera finalisé, vous la reprendrez pour créer un plus grand nombre de documents valides.
Votre modèle doit respecter les exigences suivantes :
Votre modèle doit correspondre à la structure d’une fiche individuelle, et non de la collection au complet. Autrement dit, un document XML conforme à votre modèle correspondra à la fiche d’un objet spécifique de la collection et non à la collection au complet.
Un élément (ou attribut) dans votre modèle doit pouvoir servir
d’identifiant des fiches. Il sera obligatoire et doit être unique
pour chaque objet possible de la collection. Au moment de la saisie, plus tard
dans le projet, chaque fiche sera créée comme fichier XML nommé
id.xml, où id est l’identifiant
de la fiche. L’identifiant choisi doit donc pouvoir être utilisé comme nom de
fichier. Le mieux est de s’assurer qu’il respecte la contrainte de forme
NMTOKEN; il pourra alors être utilisé comme nom de fichier, de même que comme
valeur d’un attribut de type NMTOKEN. Le plus simple est d’utiliser un numéro
séquentiel comme identifiant (1, 2, 3, …), dont l’unicité sera assurée au moment
de la création des fiches.
Les photos des objets ne seront pas dans les fiches elles-mêmes. Elles ne
seront intégrées aux fiches qu’au moment du stylage. Le « lien » entre les
fiches et les images se fera par l’identifiant des fiches, qui sera aussi
utilisé dans la nomenclature des photos : chaque photo sera nommée
id.jpg, où id est l’identifiant
de la fiche de l’objet correspondant à la photo (l’extension .jpg
pourrait varier, mais elle doit être la même pour toutes les photos). Cette
nomenclature permet au plus une photo par objet, et on n’en
demande pas plus dans ce travail.
L’exigence, du point de vue du modèle, est ceci : il doit être possible que certains objets n’aient pas de photo correspondante. Il suffit pour cela qu’un élément ou attribut indique quelque part dans la fiche si la photo de l’objet est disponible ou non. Il s’agit donc d’une information binaire (booléenne), oui-non, à représenter quelque part dans votre modèle.
Il doit inclure deux « métadonnées de gestion » à propos de la fiche elle-même : la date de création ou de dernière modification de la fiche et identification de la personne (une seule personne) ayant effectué l’opération (création ou dernière modification). Chacune de ces métadonnées peut être modélisée comme élément ou attribut, à votre choix.
Il doit inclure un élément dont le contenu consiste en un ou plusieurs paragraphes, chacun contenant du texte en format libre (des phrases complètes, avec majuscule au début et ponctuation). Selon votre type d’objet, cet élément pourrait – par exemple – servir à consigner les commentaires du collectionneur ou l’histoire de l’objet ou de son acquisition par le collectionneur.
Les paragraphes de l’élément évoqué au point précédent doivent avoir un modèle de contenu mixte. En plus de texte, ils doivent pouvoir contenir les trois sous-éléments suivants :
Ces trois éléments auront un contenu textuel seulement (#PCDATA). Les deux qui
« pointent » à quelque chose doivent être pensés un peu comme les liens en HTML
(<a href="…">…</a>) : leur contenu joue le rôle de
texte cliquable, et un attribut identifie la destination du lien. Cela
permettra, au moment du stylage, de transformer ces pointeurs en vrais liens
HTML. Pour les éléments pointant à des ressources Web, l’attribut contiendra
l’URL de la destination; pour les éléments pointant à d’autres fiches de la
collection, il contiendra l’identifiant de la fiche cible. Évidemment, il ne
faut pas utiliser les noms XML a et href, mais plutôt
des noms qui s’insèrent dans la logique de votre modèle.
Il doit inclure au moins cinq informations descriptives des objets, dont au moins trois peuvent servir de critère de recherche usuel pour ce type d’objet (par exemple, la largeur et la hauteur pour un timbre). Une de ces informations doit correspondre à la caractéristique « mesurable » de l’objet, mentionnée ci-dessus. Au moins deux des informations descriptives doivent être facultatives.
Les éléments chapeautant doivent être utilisés selon ce qui est naturel et pertinent, en accord avec les principes de modélisation.
Les informations répétables doivent être modélisées avec des éléments répétables et non comme du texte avec un délimiteur (par exemple, la virgule).
Pragmatiquement, la remise consiste en un fichier compressé à déposer sur StudiUM à l’endroit prévu.
Le fichier compressé contiendra sept fichiers distincts :
rapport.pdf, paginé et formaté pour papier
8,5 x 11 po, dont le contenu est décrit à la section
suivante.modèleXML3011 correspondant à la version
préliminaire de votre modèle XML :modèleXML3011 lui-même. Ce fichier doit
s’appeler EPHN.xml, où vous remplacez
EPHN par le nom de l’élément de plus haut niveau de
votre modèle – éventuellement débarrassé de ses signes diacritiques, puisque
ce nom est ici utilisé comme nom de fichier.modèleXML3011. Ce fichier s’appellera
EPHN.dtd.modèleXML3011. Ce fichier s’appellera
EPHN.html.Trois documents XML valides selon le modèle préliminaire, correspondant aux trois hypothèses de documents valides mentionnées précédemment. Vous nommerez ces fichiers conformément au choix d’identifiant que vous aurez fait au point 2 de la section Exigences pour la modélisation ci-dessus.
Rappelons que dans un de ces documents, toutes les informations facultatives seront omises, dans un autre, elles seront toutes présentes et, dans le dernier, il y aura deux occurrences ou plus de toutes les informations répétables. Un des trois documents doit représenter un objet pour lequel il n’y a pas de photo disponible.
Vous n’avez aucune photo à remettre à ce stade-ci, même si deux de vos hypothèses de documents valides indiqueront qu’une photo de l’objet correspondant est disponible.
Le fichier compressé déposé sur StudiUM doit porter un nom composé à partir des noms des coéquipiers. 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.
Voici les directives pour le contenu de rapport.pdf :