DocAide Modules d'exercices OEF

Comment créer un module d'exercices OEF

Vous avez déjà développé des exercices dans votre classe sur un même thème et vous désirez en faire votre premier module : ce document est pour vous.

Avant toute chose...

• Prenez contact avec l'administrateur du serveur WIMS sur lequel vous travaillez et demandez-lui un compte développeur : il vous donnera un login et un mot de passe.
• Pour accéder alors à votre compte, suivez le lien Création de ressources > Modtool sur le menu de la page d'accueil et identifiez-vous. Vous pouvez aussi vous connecter à partir de votre classe. Le mot de passe sera alors enregistré.
• Vous pouvez alors créer votre premier module en cliquant sur le lien créer un nouveau module.

Règles de publication

La particularité de WIMS est son fonctionnement collaboratif. Nous sommes tous collectivement responsables de la qualité des ressources produites. Cette base s'est étoffée au fur et à mesure des années, le nombre de contributeurs a augmenté, il est donc difficile de travailler de concert. Cela est cependant un objectif. L'association WIMS EDU propose un ensemble de règles afin de maintenir la qualité des ressources publiées.

• Les deux modes de publication
• Règles de publication d'un nouveau module et maintenance des anciens
• Conseils et éléments à vérifier avant une première publication
• Modification après publication

Finalisation du module

La finalisation des modules est importante car elle impacte fortement le recensement des exercices et le fonctionnement du moteur de recherche. Elle porte d'une part sur le renseignement des propriétés du module et sur les éléments d'informations qu'il convient de donner dans les fichiers de configuration.

• Renseigner les propriétés du module
• Renseigner les fichiers de configuration

Possibilités de programmation supplémentaires (de plus en plus) avancées

• Ajout d'un exercice OEF
• Aide commune à plusieurs exercices
• Paramètres supplémentaires
  Les paramètres avancés permettent de proposer des choix avant de lancer l'exercice. Par exemple, on peut choisir le niveau de difficulté de l'exercice que l'on souhaite lancer. Voir par exemple, le module suivant.
• Utiliser des fichiers de données
• Utilisation de cpp
• Liens sur d'autres modules
• Rudiments d'HTML et exemples de styles css prédéfinis (Voir page du même nom dans le document Aide exercices)
• Module multilangage

Les deux modes de publication

Publier un module signifie le rendre public et utilisable par d'autres enseignants ou élèves. Le serveur étant dédié à l'enseignement et à destination d'élèves et d'enseignants, le contenu et les ressources doivent tous avoir un but pédagogique et sont soumis au code de déontologie des enseignants et aux règles usuelles de devoir de réserve.
Il y a plusieurs sortes de publication possibles :

• la publication centralisée sur un serveur de publication.
• la publication sur le serveur sur lequel vous travaillez (publication en local).

Publication centralisée

Lorsqu'un module est publié via la publication centralisée, il est intégré à la base de données de ressources de WIMS. Il va se propager automatiquement à travers les miroirs et les mises à jour automatiques à tous les serveurs WIMS du monde entier. Le module sera à la disposition de tous les utilisateurs de WIMS.

Toutes les ressources WIMS sont publiées sous licence GNU GPL qui assure les libertés suivantes :

1. La liberté d'exécuter le logiciel, pour n'importe quel usage ;
2. La liberté d'étudier le fonctionnement d'un programme et de l'adapter à ses besoins, ce qui passe par l'accès aux codes sources ;
3. La liberté de redistribuer des copies ;
4. La liberté de faire bénéficier la communauté des versions modifiées.

La publication centralisée nécessite que vous soyez titulaire d'un compte de publication. Vous devez demander ce compte en envoyant un mail à publishcenter@wimsedu.info.

Une publication centralisée vous engage à maintenir le module, notamment lors des évolutions des logiciels ou langages tiers qui rendent les exercices obsolètes (exemple : java).

Publication en local

Lorsqu'un module est publié sur un serveur local X, seuls les utilisateurs du serveur X voient et peuvent utiliser ce module.

Il ne faut pas considérer la zone local comme un purgatoire pour la publication centralisée. En effet, lorsque un module est publié sur un serveur de publication, le gestionnaire du site pourra effacer le module enregistré en local. La publication en local peut intéresser des enseignants qui développent des exercices spécifiques à l'environnement dans lequel est intégré le serveur X.

La publication en local nécessite uniquement l'autorisation de l'administrateur du serveur X.

Règles de publication d'un nouveau module et maintenance des anciens

Parmi les difficultés à maintenir une base d'exercices de bonne qualité, la duplication des exercices en est une de taille. Cette difficulté se fait sentir lorsque des exercices proches ou identiques apparaissent dans plusieurs modules. Si quelqu'un remonte un bug sur un tel exercice, il sera corrigé dans un module et pas dans un autre. De même, les méta-données permettent d'améliorer le référencement des modules.

Il existe aux moins deux serveurs de publication, le serveur historique de Nice et le serveur de l'association WIMSEDU. Chaque serveur a ses propres règles, mais toutes contribuent à améliorer la base de données et le référencement des exercices. L'association WIMSEDU a créé un comité de publication dont le travail consiste à organiser le travail de maintenance sur la base de données du serveur de publication WIMSEDU.

Les différentes propositions énoncées dans ce document ont pour but de simplifier le travail des personnes qui travaillent à maintenir la qualité des exercices de la base.

Il peut arriver que les auteurs stoppent leur investissement sur WIMS pour des raisons personnelles. Dans ce cas, le comité de publication essaye de trouver un mainteneur.

Conseils et éléments à vérifier avant une première publication

Une liste de vérification est disponible à l'adresse (à compléter). Vous pouvez l'utiliser pour vous aider à ne rien oublier.

Avant de publier :

Cohérence avec les modules déjà publiés

Assurez-vous qu'il n'existe pas encore de module existant pouvant accueillir vos exercices. Enrichir un module existant permet d'une part de regrouper des exercices de même niveau et/ou de même thème, et d'autre part, permet de partager le travail de maintenance des modules entre plusieurs auteurs.

Programmation

Code source

• Présentez le code source le plus clairement possible (indentation ...). Cela vous aidera à reprendre ultérieurement votre programme sans perdre trop de temps.
• Commentez le plus possible le code.
• N'utilisez pas l'option Soft Wrap text (retour automatique à la ligne) de certains éditeurs et allez régulièrement à la ligne sauf si cela est interdit par le code.
• Vérifiez que les auteurs sont toujours déclarés de la même façon dans chacun des exercices (\author{Prénom, Nom}). Si les orthographes sont différentes, le nom d'un auteur peut apparaitre plusieurs fois dans la liste des auteurs.
• Vérifiez que l'e-mail est bien renseigné il est indispensable pour la maintenance du module. Les bugs éventuels vous seront signalés à cette adresse.

HTML & CSS

• Ecrivez 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.
• Nettoyez le code html en enlevant les balises inutiles ou redondantes. Utilisez le validateur en ligne, par exemple https://validator.w3.org. Donnez l'adresse de votre exercice (vous la trouverez sous l'icône "à propos" lorsque vous avez lancé votre exercice).
• Evitez les balises successives en ajoutant un style css dans la balise principale ou même définissez une classe css au sein de votre exercice.
• 
  De manière générale, utilisez de préférence les styles css proposés par défaut sous wims. Ils dépendent alors du thème de WIMS choisi. Nous essayons de les rendre cohérents. Ils permettent d'avoir une meilleure unité dans les exercices. La liste des styles css par défaut est disponible dans la documentation oef et dans un rappel dans ce document.
  Exemples de styles css prédéfinis Les styles CSS permettent de standardiser la présentation d'une page HTML. Les styles CSS sont destinés à une ou plusieurs éléments de code HTML. WIMS propose un certain nombre de styles par défaut. Ils permettent d'homogénéiser les présentations des exercices sur un serveur wims donné.
  Vous retrouverez la liste complète des styles css par défaut dans la documentation oef.
  

  des balises HTML

  • <div> (pour division) : Cette balise permet de définir un ensemble de paragraphes sur lesquels seront appliqués les styles.
  • <span> : Cette balise permet de définir un extrait de paragraphe sur lesquels seront appliqués les styles.

  
  Ces deux éléments sont aussi appelés "conteneurs génériques". Toute balise ouvrante (<div>) est accompagnée d'une balise fermante correspondante (</div>), sinon, l'analyse de votre code HTML remontera une erreur.
  La balise <p>...</p> indique un paragraphe. C'est l'équivalent du pied-de-mouche du traitement de texte. La balise <br> indique un saut de ligne. C'est une des rares balises à ne pas nécessiter une balise fermante.
  Pour une meilleure présentation, nous vous conseillons d'utiliser essentiellement les balises <div> et <span>.
  Les balises de liste sont au nombre de trois :

  • <ul> indique un début de liste à puces
  • <ol> indique un début de liste à numéros
  • <li> indique un élément de liste

  
  

  Exemple :

  • <ul>
  • <li>élément 1</li>
  • <li> élément 2</li>
  • </ul>

  donne :

  • élément 1
  • élément 2

  des styles affectés aux balises

  Certains styles s'appliquent sur du texte, ou sur des paragraphes, comme les styles de mise en forme dans un traitement de texte. Les styles sont affectés à la balise avec la syntaxe class="nom du style". Si vous souhaitez appliquer un style sur un paragraphe, nous vous conseillons d'utiliser le conteneur <div>. pour une partie de phrase, utiliser le conteneur <span>.
  

  Par exemple : Vous souhaitez centrer une phrase. Vous allez écrire le code suivant : <div class="center">Vous souhaitez centrer une phrase.</div>
  Pour mettre en évidence <span class="wims_emph">un ensemble de mots</span> dans la phrase.

  
  Vous obtiendrez le résultat suivant :

  Vous souhaitez centrer une phrase.

  Pour mettre en évidence un ensemble de mots dans la phrase.

  Exemples de styles css prédéfinis sous WIMS

  • wimscenter, center permettent de centrer un texte; wimscenterajoute un padding en plus de centrer.
  • wimsborder, wimsnoborder gère le bord des cases d'un tableau;
  • wims_emph met un texte en évidence;
  • oef_indbad, oef_indpartial, oef_indgood, oef_indprec et oef_indforget écrit un texte en utilisant le code couleur identique à celui utilisé dans l'analyse de la réponse;
  • wims_instruction peut être utilisé pour donner une explication sur la façon d'entrer une réponse;
  • wims_credits peut être utilisé pour une référence (par exemple, les crédits pour une photo).
  • wims_difficultylevel permet de donner un niveau de difficulté à un exercice.
  • wims_color1, wims_color2, wims_color3 donnent les couleurs du thème choisi.
    couleur des bandeaux
    couleur des boutons
    couleur des boutons d'aide
  • wims_question permet de mettre en valeur une partie du texte avec un liseré de la couleur du thème (wims_color1) (à partir uniquement de wims4.17e).
    Souligner les verbes

    Le chat mange la souris.

  Il est recommandé de garder l'esprit de ces styles (ne pas utiliser par exemple oef_indgood pour un autre emploi que celui indiqué)
• Accessibilité : Le plugin Wave de firefox (voir https://wave.webaim.org/extension/) peut vous aider à identifier de solutions plus accessibles.

Nom des exercices

Un seul mot écrit comme un nom propre. Évitez les caractères spéciaux et les noms trop longs et écrivez-le de préférence en minuscules. Cela simplifie les processus de contrôle du code. Exemple : signes.oef ou coordonnees2.oef

Fonctionnement des exercices

• Un intérêt majeur de WIMS est d'avoir des exercices aléatoires. Donc vérifiez bien que vous avez tiré le meilleur parti possible de cette possibilité.
• Vérifiez que toute question posée est bien analysée.
• Testez et faites tester les exercices en particulier en envoyant aussi des réponses fausses et en vérifiant les feedbacks. Les meilleurs testeurs sont nos élèves, nos étudiants.

Présentation générale

Conseils typographiques

Les quelques conseils suivants sont des conseils de type éditorial. Ils concernent les mathématiques mais aussi les autres disciplines.

• Evitez les 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 de la langue utilisée 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. Séparez les lettres par un espace s'il s'agit d'objets mathématiques différents: par exemple, $AB$ plutôt que $\mathrm{AB}$.
  • 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.
  Par exemple, si les formules mathématiques risquent d'être un peu longues, aller à la ligne et centrer. Cela les mettra en évidence.
• Evitez les retours à la ligne forcés en milieu de phrase ou de paragraphe (en utilisant les balises <br> ou <p> par exemple).

Eléments pédagogiques et didactiques

• Vérifiez la clarté des énoncés ; assurez-vous en particulier que l'exercice puisse être utilisé en dehors du contexte particulier de votre classe.
• Évitez les liens externes à WIMS : ils risquent de disparaitre avec le temps et vous obliger à reprendre votre module. Pour tout lien interne à WIMS, donnez l'adresse relative de la ressource.

Propriétés du module (Méta-données)

Eléments pédagogiques et didactiques

Précisez dans le fichier d'introduction (intro.phtml), les points spécifiques de votre module : méthodes pédagogiques utilisées avec ce module, les points de cours particuliers travaillés, les compétences visées, etc.) Précisez éventuellement le lien entre votre module et des modules déjà existants sur le même sujet ou des sujets similaires.

Propriétés du module

Les propriétés générales du module sont importantes pour la classification et la recherche de ressources WIMS. Lorsque vous créez un nouveau module, utilisez les boutons d'aide et suivez soigneusement les instructions données dans ces aides. voir la page poru plus d'explications.

Modification après publication

Ça y est, vous avez publié votre module ! Et bien sûr, deux jours après, vous y découvrez une erreur (ne vous inquiétez pas, c'est toujours comme ça). Il ne vous reste plus qu'à la corriger. Pour cela,

• 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.
• Effectuez une publication centralisée.
• 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 et vous risquez de corriger un mauvais module ultérieurement. Par contre, 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.

Les serveurs WIMS ayant activé la mise à jour automatique récupéreront le module modifié à leur prochaine mise à jour automatique. S'ils ne l'ont pas fait, écrivez au gestionnaire ...

Quelques conseils après expérience

Vous devez faire très attention de ne publier que des modules bien testés. C'est encore plus le cas quand vous modifiez un module d'exercices existants.

Nous avons tous un désir constant d'améliorer nos oeuvres : une présentation encore plus jolie, encore plus de capacités (ou dans le cas d'un exercice, plus de cas), une réorganisation du code, etc. Mais attention ! Votre module est peut-être déjà inséré dans des feuilles d'exercices actives ou/et des examens importants. Vos nouveautés apportent alors des changements au milieu du travail des gens. Les nouvelles capacités ou présentations peuvent troubler les élèves ; au pire, un examen important peut être cassé par un bogue.

En règle générale, il est conseillé de s'abstenir d'introduire des modifications esthétiques ou des renforcements au milieu d'une année académique sur les modules activement utilisés. Seules les corrections de bogues doivent être publiées pendant cette période. Développez vos nouveautés dans votre