Feuille de route XML - fdr.xml

Un article de ScriptdigitalWiki.

Jump to: navigation, search

Sommaire

Introduction

Feuille de route XML - Fichier XML - Documentation technique - Routines externes

VERSION 0.2 
En cours d'implantation

Le fichier XML de la feuille de route représente la hiérarchie suivante montrée ici avec les balises XML correspondantes.

Description commentée

En-tête XML et élément feuille de route

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

ATTENTION A L'ENCODAGE!

Bloc informations

<informations>
    <cours>
      <titre>Recherche d'information</titre>
      <sigle>W-COMP-024</sigle>
      <langue>fr</langue>
    </cours>
    <datecreation>2005-07-14</datecreation>
    <version>0.1</version>
    <auteur>Yves Otis</auteur>
    <daterevision>2005-07-14 </daterevision>
  </informations>

Ce premier bloc contient les informations générales sur la description de la feuille de route (métadonnées).


informations 
description à venir
cours 
description à venir
titre 
description à venir
sigle 
description à venir
langue 
description à venir
datecreation 
description à venir
version 
description à venir
auteur 
description à venir
daterevision 
description à venir

Bloc donnees

 <donnees>
    <donnee id="donnee_statique" />
    <donnee id="donnee_statique">constante</donnee>
    <donnee id="donne_saisie" 
        routine="inputdate|inputnote|inputcommentaire|valeurchamp|
                 datechamp|datecommentaire" />
		
    <donnee id="donnee_systeme" routine="routineexterne" />
 </donnees>

Toutes les variables (c'est à dire, toutes les informations qui sont susceptibles de changer selon l'état de la feuille de route ou le statut de l'utilisateur) présentes dans une feuille de route doivent être déclarées à l'aide de ce bloc.

Ces données peuvent provenir 3 sources distinctes:

  • du concepteur - lors de l'élaboration des gabarits : un titre de section, une durée suggérée)
  • de l''utilisateur (formateur ou apprenant) : une date de fin prévue, une note, un commentaire
  • du système ou des données contenus dans la base de données du cours : la réussite ou le résultat d'un quiz, l'avancement du travail, etc.

Ces 3 situations sont prises en charge par la librairie FDR et documentées dans la description XML dans le bloc DONNÉES.

Données statiques (1er bloc de l'exemple)
On déclare l'existence de variables statiques dans la feuille de route par la forme :
<donnee id="donnee_statique"/>
Pour spécifier une donnée globale (défaut) pour l'ensemble de la feuille de route, on utilise la syntaxe
<donnee id="donnee_statique">constante</donnee>

Données saisies par l'utilisateur (deuxième groupement dans l'exemple)
Les actions les plus communes d'un utilisateur d'une feuille de route consistent à saisir des informations pour planifier et pour communiquer la progression des apprentissages et des évaluations.
Pour faciliter ces opérations, la librairie FDR fournit plusieurs routines de base pour la saisie, la validation et l'extraction de données à partir de la base de données unifiée FDR. Elles sont :
  • inputdate (stockage et extraction)
  • inputnote (stockage et extraction)
  • inputcommentaire (stockage et extraction)
  • valeurchamp (extraction)
  • datechamp (extraction)
  • datecommentaire (extraction)
On associe donc une donnée à la routine qui permet sa saisie ou son affichage :
<donnee id="donne_saisie" routine="inputdate" />
Données système (troisième groupement)

Le concepteur d'une feuille de route peut vouloir rendre compte d'activités réalisées dans le cadre du cours, comme la réussite d'un quiz, le calcul d'un degré d'avancement. Ces informations sont généralement stockées dans une base de données spécifiques aux besoins du cours.

Pour permettre l'affichage des données provenant de cette source dans la feuille de route, la librairie comprend un mécanisme d'extension, à l'aide de routines externes, qui permet au développeur de créer ces routines et de les référencer dans le fichier XML.
La syntaxe XML demeure la même que dans le cas des routines internes : on associe une donnée à une routine spécifique en utilisant cette forme :
<donnee id="donnee_systeme" routine="routineexterne" />

donnee 
description à venir
id
description à venir
routine
description à venir

Bloc message_erreurs

  <message_erreurs>
    <contenu src="./gabarits/msg_erreurs_texte.inc" />
    <gabarit src="./gabarits/msg_erreurs.inc" />
  </message_erreurs>

Ce bloc pointe sur le contenu et le gabarit-type des messages d'erreur.

contenu 
description à venir
src
description à venir
gabarit 
description à venir
src
description à venir

Bloc structure

<structure>
   <section id="Introduction">
      <element>
        <titre>Introduction</titre>

           <champ donnee="donnes_statique">(15 min)</champ>


           <champ  donnee="donnee_saisie"  id="identifiantunique" />


           <champ donnee="donnes_systeme" ref="parametres" />

        <gabarit 
            statut="apprenant|formateur"
            src="./gabarits/g2_sectionsimple.inc" />
      </element>
    </section>
</structure>

Explication :



Section 
Simple "container" pour regrouper les structures logiques de la fdr. Peut contenir : aucun, 1 ou plusieurs <section> ; un ou plusieurs éléments <element>.
element 
Peut contenir un <titre>; un ou plusieurs <gabarit>; aucun, 1 ou plusieurs <champ>
titre 
Titre de l'élément. Seul élément qui peut être utilisé directement pour substitution {titre}
gabarit 
Appel du ou des gabarits de présentation du contenu dans la fdr. Peut varier selon le statut de l'utilisateur si l'attribut statut est présent. Les gabarits doivent toujours apparaître après les éléments <champ> et <titre>.
statut
Lorsqu'absent le gabarit s'applique à tous deux valeurs possibles : apprenant | formateur
src
Adresse (??) du gabarit
champ 
Spécifie la donnée à être substituée dans le gabarit. L'attribut donnee doit toujours être présent.
donnee
Identifie le champ de substitution et, indirectement, la routine qui lui est associée dans le bloc <donnees>.
id
Identifiant unique de l'élément qui sert à stocker la donnée dans la base de données FDR. L'attribut id peut être substitué directement dans les gabarits en utilisant la chaîne de remplacement {id}. On doit parfois préciser le champ et id pour que la substitution fonctionne correctement (ex. {donnee.id})


ref
Sert à passer les paramètres pour les routines