DocAide Modules d'exercices OEF

Comment créer un module d'exercices OEF

• Démarrage
• Propriétés
• Ajout d'un exercice OEF
• Finaliser le module
• Publication
• Modification après publication
• Règles de bonne conduite
• Possibilités suplémentaires (de plus en plus) avancées
  • Aide commune à plusieurs exercices
  • Paramètres supplémentaires
  • Utiliser des fichiers de données
  • Utilisation de cpp
  • Liens sur d'autres modules
  • Exemples de styles css prédéfinis
  • Module multilangage

Démarrage

Propriétés

Le choix irréversible à bien faire : le type

• exercice : un exercice où tout est géré par le développeur sans passer par le format OEF. Ce n'est donc pas ce qu'il vous faut si vous désirez transférer des exercices de votre classe.
• outil : dans le cas d'un outil, il n'y a pas de notes, ni de question. Par exemple, la calculatrice de fonctions ou outil statistique .
• document : ce que vous êtes en train de lire : cela peut être un document de cours avec des liens sur des exercices de la base de données, des exemples variables. Pour avoir de plus amples détails, regardez le document Rédiger un document.
• récréation :
• OEF :
• Deductio : un modèle d'un type de modules.

Les autres choix

• Adresse : Il s'agit de l'adresse où sera physiquement votre module dans le logiciel si vous le publiez. Commencez par choisir la zone test, vous changerez au moment de la publication. Plutôt que de répéter l'aide, donnons ici quelques exemples :

  	test~algebra~oefsyslin.fr	test~analysis~oeftaylor.fr	test~stat~table.fr	

  qui deviendront ensuite

  	U1~algebra~oefsyslin.fr	U1~analysis~oeftaylor.fr	tool~stat~table.fr	

  et même lors de la publication et de la mise en place définitive

  	U1/algebra/oefsyslin.fr	U1/analysis/oeftaylor.fr	tool/stat/table.fr	

  Tant que le module n'est pas publié et que vous ne l'utilisez pas dans une classe, vous pouvez sans difficulté changer son nom. Ensuite, cela est tout à fait déconseillé. D'autre part, il est fortement conseillé de commencer le nom par oef dans le cas d'un module OEF, par doc s'il s'agit d'un document.
• Titre : Choisissez un titre court, sinon il sera coupé, et incisif !
• Description : La description est obligatoire, elle apparaît lorsqu'une recherche dans le moteur de recherche est faite
• Langue fr pour nous
• domaine : le domaine doit être pris parmi des domaines existants. Une liste à jour est accessible dans l'aide.
• Niveau : il s'agit du niveau scolaire, K1-K3, pour la maternelle, E1-E5 pour le primaire, E6-H3 pour le collège, H4-H6 pour le lycée, U pour l'université.
• Mécanisme de score : répondre oui s'il s'agit d'un module OEF.
• Version : pour la première fois, la version est 1.00. Quand vous modifierez le module, il faudra augmenter ce numéro par unité, dixièmes ou centièmes selon l'importance de vos modifications (mais dans tous les cas, il est conseillé de mettre deux décimales).
• wims_version : le numéro de version de WIMS sur lequel vous travaillez. Comme les possibilités de WIMS augmentent, il est important de mettre une version en rapport avec les possibilités que vous utilisez.
• Auteur : Vous pouvez en mettre plusieurs, séparés par des points-virgules, chaque auteur étant indiqué sous la forme Prénom, Nom
• Email de l'auteur : l'email est important car c'est à cette adresse que seront envoyés les rapports de bogue, les compliments et les critiques.
• Traducteur
• Email du traducteur
• Logiciels de soutien nécessaires : si vous utilisez un logiciel (pari/GP, maxima, octave etc), dites-le.
• Mots clés : Important, car c'est sur cette base-là que vos exercices seront trouvés par le moteur de recherche
• Droit d'auteur : GPL en général

Ajout d'un exercice OEF

• trouvez un nom de fichier (court et significatif) par exemple toto ;
• dans le champ Ajouter un autre fichier, mettez ce nom précédé du nom imposé src et suivi de l'extension oef, dans notre exemple src/toto.oef
• Dans la fenêtre qui apparaît, copiez le source de votre exercice.
• Cliquez sur Enregistrer

Finaliser le module

Modifier le menu d'introduction

• Le fichier intro.phtml contient par défaut le texte suivant :

  !header
  !read Exindex
  Ce module regroupe pour l'instant $exototal exercices sur ...
  
  !read oef/$module_language/intromenu.phtml
  !tail
  

  Il ne faut pas toucher aux deux premières lignes, ni aux deux dernières (elles donnent le format général du menu intro). Par contre vous pouvez/devez compléter la phrase

  Ce module regroupe pour l'instant $exototal exercices sur ...
  

  Tout ce que vous mettrez là sera dans le menu d'introduction de votre module avant la fenêtre de choix. Vous pouvez utiliser des balises html.
• Le fichier introhook.phtml permet de présenter des paramètres spécifiques à certains exercices. A partir de la version 4.10, le fichier introhook.phtml est défini par défaut avec une seule ligne

  !set introhook_exists=no

  Si ce fichier n'existe pas, il faut le créer.
  Ce fichier est à modifier si vous voulez rajouter du texte dans la page d'introduction du module après le champ permettant de sélectionner le titre d'un ou plusieurs exercices. Il commencera par la ligne

   !set introhook_exists=yes

  Le texte que vous voulez ajouter, s'incorporant dans un grand tableau html, devra être formaté de la façon suivante :

   <tr>
     <td>
     </td>
     <td>
     </td>
   </tr>
  

  Si vous ne désirez pas utiliser cette possibilité, mettez au début du fichier

   !set introhook_tableless=yes

  .
  Bien sûr, cela n'a d'intérêt que si vous rajoutez quelque chose. L'utilisation première est de créer des boutons de choix de paramètres. Donnons juste un exemple, cela sera détaillé dans le paramétrage avancé.

   <tr>
       <td class="wimscenter">Catégorie : </td>
       <td>
  !formradio confparm1 from 1 to 3 prompt facile, moyen,difficile
       </td>
    </tr>
  

Modifier le bas de page des exercices

 !if $status=waiting
   !read tool.phtml linear/vector linear/matrix linear/linsolver
   !href module=U2/analysis/docstokes.fr Un document
 !endif

Modifier l'à propos

!changeto oef/$module_language/about.phtml

Compte rendu de mise à jour

# This file registers changes to the module.
# Please write in reverse order: the last version first.

Version 1.00:
First publication.

Modifier le fichier var.proc

# Change to 0 if you don't want the choice `I don't know'
idontknow=1

# Change to 1 of you want all choices to be present
allchoices=0

# Computational precisions: you can change the defaults here.
# pari_precision=18
# maxima_precision=8
# print_precision=8

# Change to no if you don't want classes to import exercises in this module.
# A typical situation is that these exercises use common resources of the module.
class_importation=yes

# Change to yes if you want to put images in common (images/) to all exercises.
# If you do so, you must disable class_importation.
common_images=no

!changeto oef/var.proc

Ajouter des métadonnées pour chaque exercice

Publication

• la publication centralisée sur tous les serveurs wims qui le désirent.
• la publication sur le serveur sur lequel vous travaillez.

Modification après publication

• Retournez dans votre compte Modtool.
• Si vous avez mis à la poubelle le module après publication, allez à la page d'accueil de WIMS, cherchez le module que vous désirez modifier, cliquez sur ce module, puis cliquez sur le lien Copier dans Modtool en bas de page.
• Modifiez le module par Modtool.
• Vérifiez les différences par Check diff, testez, etc.
• Remplissez le fichier NEWS : indiquez la nouvelle version, les modifications importantes faites.
• Changez le numéro de version dans les propriétés (Propriétés) : des centièmes, des dizièmes ou des unités selon l'importance de la modification.
• Publiez en version stable.
• Effacez le module dans le compte Modtool quand la nouvelle version apparaît sur le serveur. Vous pouvez bien sûr le garder sur votre compte Modtool, mais cela fait double emploi. Si vous avez à modifier, vous pourrez toujours reprendre la version du serveur. D'autre part, si vous avez fait un lien d'une feuille d'exercices sur ce module, vous devez le garder. Cependant, l'année prochaine, changez votre feuille d'exercices pour lier à la version publique.

Règles de bonne conduite

Présentation générale

• Vérifiez la présentation (titre compréhensible, orthographe, règles typographiques, clarté de l'énoncé).
• Vérifiez que toute question posée est bien analysée.
• Testez suffisamment l'exercice (et faites tester) en particulier en envoyant aussi des réponses fausses et en vérifiant les feedbacks.
• Nettoyez le code html en enlevant les balises inutiles ou redondantes. Le bouton Validation W3C, proposé dans la page Fichiers principaux du module, permet de vérifier que le code html d'un exercice est correct, à utiliser sur chaque exercice du module.
• Présentez le code source le plus clairement possible (indentation ...).
• N'utilisez pas l'option Soft Wrap text de certains éditeurs et allez régulièrement à la ligne sauf si cela est interdit par le code.

Conseils typographiques

• Pas d'abréviations inutiles: le titre doit être sans abréviation, le plus parlant possible (ce n'est pas toujours facile).
• L'énoncé doit être parfaitement écrit avec les règles typographiques en cours en France ainsi que des règles simples concernant l'introduction des mathématiques. Entre autres
  • un espace avant les signes de ponctuation en deux morceaux comme :?;!
  • un espace après les signes en un morceau, pas d'espace avant (virgule, point)
  • Une phrase ne doit pas commencer par un symbole mathématique : tourner la phrase autrement (raison : si vous écrivez P est sur la droite D . Q est sur le cercle C, une lecture rapide pourrait faire croire que l'on parle du produit scalaire de D et de Q).
  • Pour la clarté du texte, on utilise dans les livres une typographie différente pour les mathématiques et le texte français. Faire de même ici en mettant les formules mathématiques entre \( et \) . Il y a quelques bogues concernant cet emploi, mais en général essayer de ne pas faire des choses trop compliquées. Cela est valable même si la formule mathématique est réduite à une seule lettre.
  • Les formules sont plus visibles si vous laissez un espace avant et après le signe =, + , - . Cela n'est pas toujours possible, mais le faire si l'on peut. Lorsque la formule est traduite en TeX, on n'a pas la maîtrise de ce qui se passe, par contre pour le cas où le code html est utilisé, il faut y penser.
• Si les formules mathématiques risquent d'être un peu longues, aller à la ligne et centrer. Cela les mettra en évidence et ce sera de toute façon plus clair.
• Ne pas aller à la ligne au milieu d'une phrase en forçant avec <br /> ou <p> par exemple (sauf raison valable). Pas la peine de marquer les respirations du texte parlé en allant à la ligne. De même, ne pas abuser des virgules.
• Conseil sur le code html : faire du code html valide et le plus correct et simple possible : fermer les balises (même la balise <p>, cela évite des bogues de certains navigateurs), ne pas laisser d'espaces entre la balise et le texte : par exemple

  <div class="wimscenter">toto</div>

  plutôt que

  <div class="wimscenter">   toto  </div>
  

  à moins qu'il n'y ait une réelle intention. Eviter les balises successives en ajoutant un style css

  <span style="color:red; font-weight:bold;">toto</span>
  

  et même définir une classe css que vous mettrez dans la commande

  \css{}

• Si vous avez utilisé un outil sophistiqué pour produire du code html, ce qui est inutile, nettoyez et enlevez tout ce qui est inutile. Cela vous servira quand vous aurez à déboguer ou relire votre texte un peu plus tard.
• Mettez de la couleur !
• Utilisez le style prédéfini wims_instruction pour les consignes de l'exercice qui ne font pas explicitement partie de l'énoncé, par exemple :

  <div class="wims_instruction">Entrez non si aucun développement n'existe.</div>
  

  donne
  Entrez non si aucun développement n'existe.

Aide commune à plusieurs exercices

• Créez un fichier, par exemple aide dans lequel vous écrivez cette aide (sans variable).
• Dans la source d'un exercice où vous désirez que cette aide apparaisse, écrivez les lignes suivantes :

  \text{monaide=wims(record 0 of aide)}
  \help{\monaide}
  

:bla bla bla
etc
: blo blo blo
etc

\text{monaide=wims(record 1 of aide)}
\help{\monaide}

\text{monaide=wims(record 2 of aide)}
\help{\monaide}

Paramètres supplémentaires

  <tr><td class="wimscenter">Niveau de difficulté</td>
  <td>
    !formbar confparm1 from 1 to 3
    Taille du graphe
    </td></tr>

    \integer{ n = \confparm1=1? randint(3..4):randint(3..4) }
    \integer{ n = \confparm1=2? randint(5..7) }
    \integer{ n = \confparm1=3? randint(10..12)}

    <tr><td class="wimscenter">Choix d'animal</td>
    <td>
      !formradio confparm1 list A,B,C prompt Loup, Chèvre, Mouton
    </td></tr>

   <tr>
     <td>Exclure les éléments au-dessus du numéro</td>
     <td><input size="3" name="confparm3" value="54" /></td>
  </tr>
  <tr>
    <td>ou une liste de numéros des éléments à tester :</td>
    <td><input size="40" name="confparm4" /></td>
  </tr>
  

!set wims_html_mode=li
 <ul>
!formradio confparm1 list 1,2 prompt xxx, yyy
 </ul>

Utiliser des fichiers de données

	\title{Choix et/est/ai}
	\language{fr}

\text{tableau =randomrow(
	Je suis grand ??et,est,ai?? brun.
	Le café ??est,et,ai?? chaud.
	La fleur ??est,et,ai?? rouge.
	Le soleil ??est,et,ai?? chaud
	J'??ai,est,et?? chaud)}

	\matrix{A = slib(text/cutchoices \tableau)}
	\text{good=\A[2;]}
	\text{cnt = items(\good)}
	\text{mix = shuffle(\cnt)}
	\matrix{good= \good[\mix]}
	\text{rep = position(1,\mix)}

	\statement{
	Faire le bon choix :
	<div class="wimscenter"> \A[1;] \embed{reply 1} \A[3;] </div>
	}

	\answer{}{\rep[1];\good}{type=menu}

:Je suis grand ??et,est,ai?? brun.
Le café ??est,et,ai?? chaud.
La fleur ??est,et,ai?? rouge.
Le soleil ??est,et,ai?? chaud
J'??ai,est,et?? chaud

:L'élève ??est,et?? sérieux ??et,est?? appliqué.
Paul se ramasse ??et,est?? se relève.
Le pull ??est,et?? chaud ??et,est?? léger.
La rue ??est,et?? étroite ??et,est?? en pente.
Pierre ??est,et?? fort en mathématiques ??et,est?? en français.
La lumière sur le vieux port ??est,et?? très belle en hiver ??et,est?? en été.

\text{Tableau = wims(record 1 of tableau)}
\text{a = randomrow(\Tableau)}

\text{Tableau = wims(record 2 of tableau)}
\text{a = randomrow(\Tableau)}

\text{Tableau = wims(record 0 of tableau)}
\text{a = randomrow(\Tableau)}

\integer{m = wims(recordcnt tableau)}
\matrix{Tableau = }
\for{ i = 1 to \m}{
  \text{Tableau = \tableau
  randrow(wims(record \i of tableau))}

\author{Ambali}
\integer{m = randint(1..wims(recordcnt tableau))}
\matrix{Tableau = }
\text{Tableau= randrow(wims(record \m of tableau))}
\matrix{A= slib(text/cutchoices \Tableau)}
\text{cntrow=rows(\A)}
\integer{cntQ=(\cntrow-\cntrow%2)/2}
\matrix{good1=}
\text{rep= }
\for{i= 1 to \cntQ}{
  \text{good=\A[2*\i;]}
  \text{cnt= items(\good)}
  \text{mix= shuffle(\cnt)}
  \matrix{good1=\good1
  \good[\mix]}
  \text{rep= \rep, position(1,\mix)}
}
\text{rep=wims(nonempty items \rep)}
\text{STEP= wims(makelist r x for x = 1 to \cntQ)}
\steps{\STEP}

\statement{<div style="text-align:center;
background-color:#faffe6;
padding:1%;
margin:5% 20%;">
\for{k = 1 to \cntQ}{\A[2*\k-1;]  \embed{r \k} }
   \A[2*\cntQ+1;]
<div/>}

\answer{}{\rep[1];\good1[1;]}{type=menu}
\answer{}{\rep[2];\good1[2;]}{type=menu}
\answer{}{\rep[3];\good1[3;]}{type=menu}

azote:.....
hydrogene:....

\text{ligne= wims(lookup azote in tableau)}

Utilisation de cpp

target=toto1 toto2 toto3 toto4

#if defined TARGET_toto1
 \title{Premier exercice}
#endif
#if defined TARGET_toto2
 \title{Second exercice}
#endif
#if defined TARGET_toto3
 \title{Troisième exercice}
#endif
#if defined TARGET_toto4
\title{Quatrième exercice}
#endif

target= et_est ou_ou la_la
#define TITLE Choix
#if defined #TARGET_et_est
 \title{TITLE et/est}
 \text{Type=tableau_et}
#endif
#if defined #TARGET_ou_ou
\title{TITLE ou/où}
 \text{Type=tableau_ou}
#endif
#if defined #TARGET_la_la
\title{TITLE la/là/l'a}
 \text{Type=tableau_la}
#endif

#include "commun.inc"

\text{tableau = wims(record 0 of \Type)}
\text{a = randomrow(\tableau)}
teste si le premier champ est une question
\text{testa= wims(nospace \a)}
\text{first = wims(replace internal ? by | in wims(char 1 of \testa))}
\text{u= \first issametext | ? 1 : 0}
\text{u1 = \u = 0 ? -1:1}
\matrix{A = slib(text/cutchoices \a)}
\text{cntrow = rows(\A)}
\integer{cntQ = (\cntrow+\u1*\cntrow%2)/2}
\matrix{good1 = }
\text{rep = }
\for{i= 1 to \cntQ}{
  \text{good=\A[2*\i -\u;]}
  \text{cnt = items(\good)}
  \text{mix = shuffle(\cnt)}
  \matrix{good1=\good1
  \good[\mix]}
  \text{rep = \rep, position(1,\mix)}
}
\text{rep =wims(nonempty items \rep)}
\text{STEP = wims(makelist r x for x = 1 to \cntQ)}
\steps{\STEP}

\statement{
<div class="wimscenter moncss">
 \for{k = 1 to \cntQ}{
   \A[2*\k-1-\u;] \embed{r \k}
 }
 \A[2*\cntQ+1-\u;]
<p/>}

\answer{}{\rep[1];\good1[1;]}{type=menu}
\answer{}{\rep[2];\good1[2;]}{type=menu}
\answer{}{\rep[3];\good1[3;]}{type=menu}
\answer{}{\rep[4];\good1[4;]}{type=menu}
\answer{}{\rep[5];\good1[5;]}{type=menu}
\answer{}{\rep[6];\good1[6;]}{type=menu}
\answer{}{\rep[7];\good1[7;]}{type=menu}
\answer{}{\rep[8];\good1[8;]}{type=menu}

Liens sur d'autres modules

!set wims_ref_target=wims_internal
!href module=adresse_du_module nom du lien

 Vous pouvez aller voir le document
!set wims_ref_target=wims_internal
!href module=H2/algebra/docpuissance.fr Tout sur les puissances
pour réviser le cours.

Module multilangage

1. Copier tous les exercices *.oef qui ne sont pas créés par des fichiers cpp dans le répertoire src/cpp en changeant l'extension : src/toto.oef devient src/cpp/toto.cpp (tous les fichiers dont il sera parlé ensuite devront être créés dans le répertoire src/cpp). Pour un tel fichier, ajouter en haut du fichier

   target=toto
   

   (toto est le nom du fichier sans extension). Tous les fichiers à créer dans la suite seront dans src/cpp . Bien sûr, si vous avez déjà utilisé les fonctionnalités de cpp pour mutualiser des données communes à plusieurs exercices, cette étape est à passer.
2. Créer un fichier "common.inc" avec la ligne

   \text{lang=slib(oef/env lang)}
   

   On peut y mettre pour commodité des instructions communes à tous les exercices comme \author{} \precision{}. L'inclure dans toto.cpp

   #include "common.inc"
   

3. Créer un fichier lang_fr.inc et mettre dans ce fichier ce qui dépend de la langue en créant des variables contenant ce texte et en ce texte par la variable dans l'exercice toto.cpp. Les variables sont par exemple du type name_xxx de manière à bien les distinguer des variables déjà définies. Essayez de ne mettre que du texte et le moins d'environnement de styles possibles (ceux-ci doivent être dans le fichier principal toto.cpp). Bien sûr, les définitions de langage vont dépendre de l'exercice, vous devez donc certainement faire des tests sur l'exercice.

   #if defined TARGET_toto
    \text{name_instruction= Instruction de l'exercice toto}
   #endif
   #if defined TARGET_tata
    \text{name_instruction= Instruction de l'exercice tata}
   #endif
   

4. Créer les fichiers lang_en.inc (ou tout autre langage) correspondants.
5. Écrire

   #include "lang.inc"
   #include "lang_title.inc"
   

   quelque part dans le fichier toto.cpp. L'endroit dépend de ce qu'on met dedans (s'il y des variables de l'auteur, il faut bien sûr que ces variables soient connues lorsque le fichier lang.inc est inclus.)
   Créer le fichier lang.inc et indiquer quelque chose comme

   #include "lang_fr.inc"
   \if{\lang=en}{
   #include "lang_en.inc"
   }
   

   Cela dépend bien sûr des langues traduites. Attention, il faut toujours qu'il y ait un défaut (si la langue n'est pas traduite, la version originelle (ici française) doit y être.
6. Faire un fichier de titre lang_title.inc dans lequel on mettra les titres des exercices sous la forme

   #if defined TARGET_toto
   #define TITLE Titre de l'exercice toto
   #define TITLE_en Title of the exercise toto
   #endif
   #if defined TARGET_tata
   #define TITLE Titre de l'exercice tata
   #define TITLE_en Title of the exercise tata
   #endif
   

   et continuer avec tous les exercices. Dans le fichier toto.cpp, écrire

   #include "lang_title.inc"
   \title{TITLE}
   \title_en{TITLE_en}
   

   On peut bien sûr faire pareil pour toutes les langues.
7. Dans les propriétés, dans la partie Langue (onglet Langue), rajouter en dans le champ Autres langues, sauver, puis y revenir : un bouton Propriétés (Anglais) est apparu, cliquer dessus, remplir les propriétés relatif au module (si les mots clés ont été écrits en anglais technique, inutile de les répéter). Regarder l'aide pour les mots clés.