Le projet QCMXML

FSC - Last modified: Fri Nov 4 11:25:54 CET 2011

Ce projet a pour but de proposer un format XML de QCM appelé QCMXML et des scripts de transformation pour transformer un fichier au format QCMXML en Latex, HTML et en format XML pour Moodle.

À partir d'un fichier XML au format QCMXML exempleQCM.qcm.xml, les scripts générent:

exempleQCM.tex (latex)
exempleQCM.html, exempleQCM-reponses.html, exempleQCM-reponses.txt (formulaires HTML)
exempleQCM.moodle.xml (Moodle XML)

Pour récupérer le package Debian, ajouter dans /etc/apt/sources.list :


deb http://www-public.it-sudparis.eu/~silber/repositories/apt-repo/ binary/
deb-src http://www-public.it-sudparis.eu/~silber/repositories/apt-repo/ sources/

Après installation du package,

man qcmxml

pour obtenir la documentation sur l'utilisation de la commande qcmxml.

Plan

1. Description du format QCMXML
2. Transformation vers Latex
3. Transformation vers des formulaires HTML
4. Transformation vers Moodle XML
5. Inclure les QCM dans un cours slideint
6. FAQ
Changes

Il existe aussi un script de transformation de l'ancien format qcm en format qcm.xml : qcm2xml.py.

1. Description du format QCMXML

Les balises contiennent toutes du texte. Certaines peuvent avoir un contenu mixte texte et HTML. La balise racine du document est la balise questionnaire. La balise questionnaire contient les balises :

idfqcm : obligatoire, cette balise correspond au nom de la catégorie dans Moodle qui contiendra les questions du questionnaire courant.
une liste de balises question.

Les balises suivantes contenues dans la balise questionnaire sont utilisées pour générer le fichier HTML (mais ne sont utilisées ni pour Latex, ni pour Moodle XML):

titre : optionnel
date : optionnel
instructions : optionnel
auteurs : optionnel
module : optionnel
(enseignant : optionnel, non utilisé)
(seuilcorrige : optionnel, non utilisé)

Une balise question a pour attribut optionnel la difficulte pouvant prendre les valeurs FACILE, INTERMEDIAIRE, DIFFICLE. Cet attribut est utilisé dans les transformations HTML, Latex, Moodle pour ajouter '*' pour un niveau intermédiaire et '**' pour un niveau difficile.

Une balise question contient :

une balise intitule donnant l'intitule de la question.
une liste de balises reponse. Une balise reponse peut prendre comme attribut :
- valeur : peu testé,
- statut pouvant prendre les valeurs VRAI ou FAUX pour préciser si la réponse donnée est correcte ou incorrecte. Ceci sert aussi à calculer la note dans le format MoodleXML.
Une réponse contient :
- une balise contenu donnant une proposition de réponse,
- une balise justification optionnelle permettant de donner une explication liée à la réponse. Cette balise est utilisée pour la transformation en HTML et en Moodle XML.

Les balises instructions, intitule, contenu et justification peuvent contenir:

du texte,
du HTML,
et une ou plusieurs image(s) décrite(s) par la balise <img src="nomimage.extension"/> (voir la FAQ).

Pour plus d'informations, reportez-vous à la DTD qcm.dtd. Exemple de QCM au format QCMXML (extrait du fichier tube.qcm.xml) :

=====================================================
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE questionnaire SYSTEM "qcm.dtd" >
<questionnaire>
<idfqcm>tube</idfqcm>
<titre>
Redirections et tube
</titre>
<date>
Mars 2003
</date>
<instructions>
<b>Pour chacune des questions, plusieurs réponses peuvent être
correctes, vous pouvez donc cocher plusieurs cases !</b>
<br/> Les questions sont de trois niveaux de difficultés. Les niveaux
'intermediaire' et 'difficile' sont précédés des signes '*' et '**',
respectivement.
<br/> Ces QCM sont autant l'occasion de contrôler des connaissances que
d'apprendre quelque chose. En effet, les questions difficiles
demandent un travail supplémentaire. Par conséquent, ne vous
auto-évaluez pas sur ces questions.
</instructions>
<auteurs>
Denis Conan
</auteurs>
<module>
Initiation à Unix
</module>

<question difficulte="FACILE">
<intitule>La commande 'ls -1 /bin | wc -l' affiche :</intitule>
<reponse statut="FAUX">
<contenu>Le nombre de lignes de '/bin'</contenu>
<justification>L'expression "nombre de lignes" n'a pas de signication pour un répertoire.</justification>
</reponse>
<reponse statut="VRAI">
<contenu>Le nombre d'entrées sous '/bin'</contenu>
</reponse>
<reponse statut="FAUX">
<contenu>'1'</contenu>
</reponse>

</question>

<question difficulte="INTERMEDIAIRE">
<intitule>Vous exécutez la commande 'write paul &lt; toto' et le shell répond
'bash: cannot open toto'. Quelle peut être la cause provoquant ce
message d'erreur :</intitule>
<reponse statut="VRAI">
<contenu>Le fichier 'toto' n'existe pas</contenu>
</reponse>
<reponse statut="VRAI">
<contenu>Vous n'avez pas les droits sur le fichier 'toto'</contenu>
</reponse>
<reponse statut="FAUX">
<contenu>L'utilisateur 'paul' n'a pas les droits sur le fichier 'toto'</contenu>
</reponse>
</question>


<question difficulte="FACILE">
<intitule> Pourquoi l'image suivante est-elle drôle? <br/><img src="geekscottes.png" width="50%"/> <br/>Bonne question!</intitule>
<reponse statut="FAUX">
<contenu>Ce n'est pas drôle, on aurait pû dire et "home la maison" aussi</contenu>
</reponse>
<reponse statut="VRAI">
<contenu>C'est drôle parce que lorsque le PATH est mal positionné alors aucune commande ne fonctionne et donc PAF! y'a rien qui marche</contenu>
</reponse>
</question>
</questionnaire>
=====================================================

2. Transformation en Latex

Le script qcmxml2tex.py génère la version LaTeX du QCM : à partir du fichier monfichier.qcm.xml, génération de monfichier.tex. Dans le cas d'un QCM contenant des images, les images doivent se trouver au même endroit que le QCM (voir la FAQ).

3. Transformation en formulaire HTML

Étape 1: transformation en formulaire HTML

Taper make génère les fichiers

exempleQCM.html
exempleQCM-reponses.html
exempleQCM-reponses.txt

Pour cela, Il faut configurer l'URL où les CGI sont installés dans le Makefile en positionnant la variable CGIURL. Si le QCM contient des images, il faut configurer l'URL des images dans le Makefile en positionnant la variable IMGURL (voir la FAQ).

Principe

Le script qcmxml2html.xsl génère le fichier monfichier.html pour le QCM à remplir par l'étudiant. Le nom du fichier HTML généré est précisé par le paramètre nombase dans le Makefile, par défaut est égal au nom de base du fichier monfichier.qcml.xml.

Le script qcmxml2reponseshtml.xsl génère le fichier monfichier-reponses.html pour le fichier HTML avec les réponses à afficher si l'étudiant coche la case « afficher les réponses ». Le script qcmxml2reponsestxt.xsl génère le fichier monfichier-reponses.txt pour le fichier des réponses qui est utilisé par le CGI traite-qcm-new.cgi.

Étape 2: Installation

Installation du script CGI et des réponses

Déplacer les fichiers suivants à l'endroit où doivent être installés les CGI (voir la variable CGIURL du Makefile):

traite-qcm-new.cgi
*-reponses.html (un fichier généré par QCM)
*-reponses.txt (un fichier généré par QCM)

4. Transformation en Moodle XML

Si le QCM contient des images, il faut configurer l'URL des images dans le Makefile (IMGURL). Pour éviter d'avoir à modifier cette URL chaque année, il est préférable de stocker ces images sur un serveur Web externe (par exemple stromboli) plutôt que dans l'espace Moodle du cours.

Étape 1: transformation QCMXML vers Moodle XML
Étape 2: importation dans Moodle

Étape 1: transformation QCMXML vers Moodle XML

Le script qcmxml2moodlexml.xsl génère le fichier monfichier.moodle.xml au format XML du module Quiz de Moodle. Il semble impossible dans Moodle d'importer ou exporter directement un questionnaire. Il faut importer les questions puis créer, via l'interface Moodle, le « test ». C'est pourquoi les balises relatives au questionnaire (titre, date, auteurs, instructions...) ne sont pas utilisées pour l'importation dans Moodle. Le questionnaire contenu dans monfichier.qcm.xml est transformé en un quiz contenant l'ensemble des questions inclues dans le questionnaire. Ces questions seront ajoutées à la base de questions dans la catégorie spécifiée par la balise idfqcm du fichier d'entrée. Chaque question est transformée en question de type multichoice.

Feedback et General feedback

Dans Moodle, il est possible d'afficher un feedback pour chaque proposition de réponse dans une question. Nous utilisons ce feedback pour afficher la justification (en gras). Attention, ce feedback n'est affiché qu'après exécution de la question si l'étudiant a cliqué sur la proposition de réponse correspondante. Dans Moodle, il est aussi possible d'afficher un general feedback pour une question s'affichant après exécution de la question. Nous utilisons ce general feedback pour afficher le niveau de difficulté de la question (avec des couleurs : rouge pour facile, orange pour intermédiaire et vert pour difficile).

Calcul des notes

Dans Moodle, l'exécution d'un questionnaire résulte en une note. Par défaut, chaque question possède le même poids (ceci se configure dans l'interface Moodle au moment d'ajouter une question).

Pour calculer la note correspondant à une question, nous devons attribuer un poids à chaque proposition de réponse. Prenons l'exemple d'une question contenant 5 propositions dont 3 propositions vraies.

Le script de transformation calcule la note de la façon suivante.

chaque proposition de réponse a le même poids calculé sur le nombre de réponses vraies. Dans notre exemple, chaque proposition aura un poids égal à 1/3;
sélectionner une proposition VRAIE compte pour + 1/3;
sélectionner une proposition FAUSSE compte pour - 1/3.

Ainsi, pour obtenir tous les points liés à une question, il faut cliquer sur toutes les réponses vraies et aucune réponse fausse. Cliquer sur autant de réponses vraies que fausses donne la note zéro. La note minimum est zéro.

Étape 2: Importation dans Moodle (MAJ Moodle 2011)

Pour créer un QCM dans Moodle, il faut:

Étape 1: créer un test
ajouter une activité de type Test et la configurer (dans UX on ne met ni le mode adaptatif ni la prise en compte des pénalités par exemple);
Étape 2: importer les questions dans la banque de questions
Dans le menu gauche, sélectionner Banque de questions puis Importer pour importer les questions dans la base de questions :
- IMPORTANT : à coté de la zone de saisie Catégorie, sélectionner Depuis le fichier;
- dans le menu Format de fichier, choisir Format XML Moodle;
- dans le menu Faire correspondre les notes, choisir impérativement Erreur si la note n'est pas listée
- déposer le fichier d'extension .moodle.xml.
- si l'importation a réussi, les questions doivent apparaître en sélectionnant dans le menu déroulant choisir une catégorie la catégorie correspondant aux questions
Étape 3: ajouter les questions importées dans le test créé
Dans le menu gauche, cliquer sur Modifier le test :
- cliquer sur Visualiser dans le cadre à droite intitulé contenu de la banque de questions
- sélectionner la catégorie souhaitée;
- ajouter les questions au test.

Nouveautés

Moodle version 1.9: au moment d'importer, il est maintenant possible choisir si l'on souhaite importer le contexte à partir du fichier. L'effet de ceci n'est pas clair pour moi. Les deux cas fonctionnent. Si on importe le contexte à partir du fichier alors la catégorie de question s'affiche sous "Module d'activité" sinon elle s'affiche sous "Cours:".
Moodle version 2: le format XML semble inchangé. L'interface graphique a nettement évolué.

5. Inclure les QCM dans un cours slideint

Nous avons ajouté dans l'URL du QCM dans le cours en ligne généré par slideint l'appel à qcm.php. En effet, le même cours en ligne est utilisé à la fois sur Internet et dans Moodle. Selon le cas, en cliquant sur le QCM, il faut aller soit vers l'URL du QCM sur Internet soit vers l'URL du QCM dans Moodle.
En fonction du serveur Web et de l'identifiant du QCM, qcm.php dirige vers le QCM html ou le QCM Moodle. Par exemple, pour le QCM identifié par processus, qcm.php permet de rediriger le clic vers l'une des deux URL suivantes:

http://cours.it-sudparis.eu/moodle/Suivi/qcm.php?id=processus

http://www-inf.it-sudparis.eu/cours/UNIX/Web/moodle/Suivi/qcm.php?id=processus

Configurer le fichier qcm.php et copier le fichier qcm.php dans /moodle/Suivi sur tous les serveurs Web sur lesquels les QCM sont utilisés.

6. FAQ

Comment insérer une image dans un QCM?
Il est possible d'insérer une image. Pour cela, il faut utiliser la balise HTML img en précisant le nom du fichier contenant l'image.

Il faut utiliser l'attribut src pour préciser le nom du fichier contenant l'image. Attention le chemin absolu du serveur Web sera ajouté après transformation. Voir l'exemple ci-dessus.

Pour donner le chemin où se trouve l'image, il faut configurer la variable IMGURL dans le Makefile en donnant un chemin vers l'image accessible depuis Internet. Cette URL sera utilisée à la fois pour un QCM HTML et un QCM Moodle.

Pour la transformation Latex, l'image doit se trouver au même endroit que le fichier de QCM.

Les attributs HTML width et height sont recopiés dans les traductions HTML et Moodle. Pour la traduction Latex, ces balises sont traduites en pourcentage de \textwidth ou \textheight.

À quoi sert qcm.php?
Voir la section «5. Inclure les QCM dans un cours slideint».

Quels paquetages installer pour utiliser qcmxml sur debian ?
nxml-mode pour éditer sous emacs et libxml2-utils pour vérifier la conformité du fichier questionnaire par rapport à la DTD.

Le mode nxml d'emacs affiche la balise questionnaire invalide. Pourquoi ?
Quand le questionnaire contient des codes HTML, nxml cherche à ajouter un attribut d'espace de noms (xmlns) dans la balise questionnaire. Les scripts XSL ne prennent pas en compte cet espace de noms donc je suggère de ne pas l'ajouter.

Le fichier généré est quasiment vide. Pourquoi ?
Lorsque le fichier XML source contient un espace de noms, les scripts XSL ne fonctionnent pas. Les scripts XSL ne supportent pas pour l'instant les espaces de noms parce qu'il faudrait alors en forcer l'utilisation dans tous les fichiers sources.

Comment utiliser le mode nxml d'emacs?

Pour activer le mode nxml par défaut dans emacs:

;; /usr/share/emacs/site-lisp/tcc-nxml-emacs:  Add these lines
;;      to your .emacs to use nxml-mode.  For documentation of
;;      this mode, see http://www.nmt.edu/tcc/help/pubs/nxml/
;;--
;; Add the nxml files to emacs's search path for loading:
;;--
(setq load-path
      (append load-path
              '("/usr/share/emacs/site-lisp/nxml-mode/")))
;;--
;; Make sure nxml-mode can autoload
;;--
(load "/usr/share/emacs/site-lisp/nxml-mode/rng-auto.el")

;;--
;; Load nxml-mode for files ending in .xml, .xsl, .rng, .xhtml
;;--
(setq auto-mode-alist
      (cons '("\\.\\(xml\\|xsl\\|rng\\|xhtml\\)\\'" . nxml-mode)
            auto-mode-alist))

Si le fichier qcm.rnc n'existe pas, le générer:
- L'installer et installer le module trang
- Convertir la DTD en un format relax-NG avec trang
```
$ trang qcm.dtd  qcm.rnc
```
Dans emacs, choisir XML, Set schema, File et choisir qcm.rnc
Des soulignés rouges apparaissent aux endroits où le fichier est invalide
CTRL-entrée permet d'insérer automatiquement les balises

Comment valider mon fichier par rapport à la DTD?
Pour valider le fichier, il est possible d'utiliser xmllint:
```
$ xmllint --dtdvalid qcm.dtd droit_acces.qcm.xml > /dev/null
```

Que faire en cas d'entité externe publique non trouvée?
```
warning: failed to load external entity
parser warning : PEReference: %block; not found
...
```
Dans l'extrait suivant de la norme XML concernant les entités externes, la méthode d'obtention des entités externes n'est pas clairement spécifiée:
```
An XML processor attempting to retrieve the entity's content
may use any combination of the public and system identifiers as well
as additional information outside the scope of this specification to
try to generate an alternative URI reference. If the processor is
unable to do so, it MUST use the URI reference specified in the system
literal.
```
xsltproc utilise des catalogues XML (voir la documentation Catalog support et les spécifications OASIS). Ce que je crois comprendre de tout ça: xsltproc va chercher d'abord sur le système local dans les catalogues XML puis sur le réseau grâce à l'URL donnée (voir aussi l'option --nonet de xsltproc).
En pratique, en installant le catalogue XML contenant la DTD xhtml (package Debian w3c-dtd-xhtml) en local, cela a résolu le problème.

Changes

04/11/2011:
- Ajout du fichier qcm.rnc (généré à partir de qcm.dtd) pour édition sous emacs avec le mode nxml
- Mise à jour de la FAQ en conséquence
13/10/2011:
- transformation latex: traduction des guillemets (altgrw et altgr x) en << et >>
- caracteres Unicode: voir http://formex.publications.europa.eu/formex-4/physspec/formex-4-character-encoding-c01.htm
- 05/10/2011
  - Modifications proposees par DC
  - Insertion d'images
    - ne pas preciser d'extension dans le fichier .qcm.xml
    - transformation latex : pas d'extension
    - transformation html: l'extension PNG est supposée
  - Transformation latex: amélioration du latex généré
13/09/2011
- transformation html: correction du lien "recommencer" dans traite-new-qcm.cgi
- tranformation latex: balise nbsp traduite en espace (inclus dans alltt)
- transformation Moodle:
  - le champ name dans question tronqué à 100 caractères (erreur: write error in database). Pourrait être augmenté à 256 probablement.
  - Recherche infructueuse pour améliorer l'affichage des codes dans les questions. Les balises pre et code s'affichent en gros caractères avec des interlignes très grands. C'est aussi le cas dans une sasie directe de la question.
  - doc: ajout de la remarque de Sébastien concernant les notes.
14/12/2010-3: Correction cible html dans Makefile.
14/12/2010-2: Récupération du Makefile OK.
14/12/2010
- Add xhtml1-dtd into package
10/12/2010-2
- Problème lié à la récupération des références externes par le parser SAX de python: copie dans qcmxml de la DTD xhtml1. Rend temporairement inutile la dépendance sur le catalogue XML. Cependant cette copie devrait être supprimée et il faudrait faire en sorte que le parser python SAX utilise les catalogues XML locaux. A VOIR.
- Correction d'un bug dans qcmxml2tex.py dans le traitement de la taille des images pour lesquelles uniquement la largeur ou la hauteur était explicitée.
10/12/2010
- évolution du Makefile: valeur par défaut pour QCMDIR, CGIURL et IMGURL
- ajout de la page de manuel pour la commande qcmxml
08/11/2010
- évolution du Makefile pour n'effacer que les .tex générés à partir des fichiers .qcm.xml
- ajout d'une dépendance vers w3c-dtd-xhtml (voir le fichier control)
18/10/2010: évolution du Makefile pour ne pas effacer contenu.tex

Comment produire le package Debian

package.html