Coordination Technique
Date de création : 9 Décembre2003
 
Diffusion : internet

Saisie XML des feuilles de route

But

Avoir des feuilles de route identiques en terme de contenu.
Avoir des feuilles de route avec la même mise en forme pour une meilleure lisibilité.
Pourvoir obtenir facilement un document de synthèse actualisé fusionnant le contenu des toutes les feuilles de route.

La DTD

<!ELEMENT taches (tache+) >
<!ATTLIST taches
	groupe (coor|coor-tech|1A|1B|1C|2D|2E|2F|3A|3B|3C|3D|3E|3F|3G) "coor"
>
<!ELEMENT tache (nom, description, responsable, dateDemarrage, dateFinSpecif, dateDisponibilite, moduleCVS?, URL?) >
<!ATTLIST tache
	avancement (0|10|20|30|40|50|60|70|80|90|terminee) "0"
	priorite (urgent|prioritaire|normale|souhaitable) "normale"
	dispoCVS (O|N) "N"
	dispoDoc (O|N) "N"
>
<!ELEMENT nom (#PCDATA)>
<!ELEMENT description (#PCDATA)>
<!ELEMENT responsable (#PCDATA)>
<!ELEMENT dateDemarrage (#PCDATA)>
<!ELEMENT dateFinSpecif (#PCDATA)>
<!ELEMENT dateDisponibilite (#PCDATA)>
<!ELEMENT moduleCVS (#PCDATA)>
<!ELEMENT URL (#PCDATA)>

Nommage des fichiers

Les feuilles de route sont la liste des tâches en cours ou futures pour un groupe. C'est la raison pour laquelle l'élément racine du XML est "taches".
Aussi il est proposé d'utiliser taches.xml pour le nom du fichier qui contient le XML. Il doit être dans le répertoire "private" de l'espace de chacun des groupes sur esup-portail.org
La dtd est nommée taches.dtd et est positionnée à la racine du site esup-portail.org (https://www.esup-portail.org/consortium/espace/taches.dtd)
Au moins un fichier XHTML de chaque taches.xml est enregistré sous le nom taches.html. Ce fichier est dans le répertoire "private" de l'espace de chacun des groupes sur esup-portail.org. Il est issu de l'utilisation de taches_xhtml.xsl. Il est accessible depuis un lien "feuille de route" sur la page index.html de chacun des groupes sur esup-portail.org

Saisie et utilisation du XML

Il est possible d'utiliser un simple éditeur de texte pour saisir la feuille de route en XML.
Chaque document XML doit faire référence à la dtd externe https://www.esup-portail.org/consortium/espace/taches.dtd
Il est impératif que le document soit valide avant d'être mis en ligne sur le site esup-portail.org.
Il est probable que la validation du document soit effectuée lors de la transformation xslt. Néanmoins, il semble pratique d'utiliser un éditeur XML permettant de valider le XML en cours de Saisie. Des propositions d'outils seront faites.
La génération du fichier CSV (permettant de charger l'ensemble des feuilles de route dans un seul fichier exploitable dans Excel – pour des tris par exemple) sera lancé à la discrétion de toute personne ayant besoin d'une version actualisée.

PROPOSITION D'UN OUTIL DE SAISIE XML

XXE pour XMLMind XML Editor

Installation

Télécharger XXE
Télécharger les spécificités gestion des tâches ESUP
Décompresser le fichier taches.zip dans le répertoire config de XXE préalablement installé.

Mode d'emploi

Nouveau fichier

Faire Fichier->Nouveau une fenêtre apparaît :

sélectionner le modèle de document "tache" dans le dossier "taches"

Une fois la première tache remplie, pour ajouter une nouvelle tache, plusieurs méthodes sont possibles, en voici trois:

  • Sélectionner toute la tache en cliquant sur le numéro de la tache (en Rouge) puis, par le menu Edition, choisir "insérer avant" ou "insérer après".

  • Avec la souris, en haut se trouve l'arborescence (taches*tache*nom*#text par exemple) appuyer sur "Shift" ou "Ctrl" et cliquer sur l'élément à insérer (exemple : tache). "Shift" fait une insertion avant, "Ctrl" fait une insertion après.


  • Sélectionner toute la tache en cliquant sue le numéro de la tache , faire "Maj+J" pour passer sur l'onglet "Edition". Cliquer sur "insérer avant" ou "insérer après" selon le besoin, puis cliquer sur l'élément "tache" pour insérer la tache.




    • ATTENTION : Seuls les élements obligatoires sont représentés lors de la saisie mais il est possible de rajouter les éléments optionnels (Pour notre cas, moduleCVS pour le nom du module déposé sur cvsesup et URL pour l'url de la documentation). Il suffit de se positionner sur l'élément "dateDisponibilité" et de cliquer sur "ajouter après" pour faire s'afficher les éléments optionnels.

    Valider le fichier XML en cliquant sur l'icone en bas à gauche ou taper simultanément Ctrl+Maj+V.

    Faire Fichier->Enregistrer

    Génération du html

    Quand le fichier taches.xml est ouvert dans XXE utiliser le menu "Transformation->Transformation HTML" pour générer le fichier taches.html.

    Puis remplir le formulaire d'enregistrement (attention le caractère / devant le chemin designant l'emplacement du fichier est important. Sans ce caractère il ne sera pas possible de faire "OK")

    Génération du CSV

    Quand le fichier taches.xml est ouvert dans XXE utiliser "Transformation->Transformation CSV" pour générer le fichier taches.csv

    Ensuite, la méthode est la même que pour la transformation HTML.

    Gestion des fichiers sur esup-portail.org

    Positionner un verrou sur le fichier taches.xml
    Rapatrier localement le fichier taches.xml
    Editer le fichier avec XXE et générer le HTML
    Mettre à jour le fichier XML et HTML sur le site distant
    Libérer le verrou sur le fichier taches.xml

    LES XSLT

    On peut, dans un premier temps, partir sur les deux exemples suivants.

    Exemple de rendu XHTML

    Exemple de rendu CSV

     

    Astuces : Si vous faites votre propre template pour vos besoins, decochez l'option de mise en cache des DTD dans Option -> Option -> Schéma, car en cas de modification de la DTD pour faire evoluer le template, la nouvelle DTD ne sera pas prise en compte et des erreurs apparaitrons alors qu'il n'y en a pas.

     

    Création : 9 Décembre 2003 - Sébastien Gougeon (Université de Rennes 1)

    Modifications : 19 janvier 2004 - Raymond Bourges : localisation des fichiers taches.xml et taches.html