Modelet webSiteAnnot

Objectifs

Ce modelet permet d'ajouter des zones d'annotations (pour les utilisateurs / apprenants) dans une publication web. Ces zones s'activeront uniquement si un contexte applicatif de stockage compatible est détecté.

Aujourd'hui, seul un contexte SCORM 2004 permet d'activer cette fonctionalité. Scorm 1.2 n'offre pas suffisamment de champs de stockage pour permettre l'activation de cette fonctionnalité. Ces annotations seront activées dans un module exécuté dans SCENARIplayer car ce dernier simule un environnement SCORM 2004.

Information générales

• Date de création : 2006
• Licence : GPL / LGPL / MPL / CeCILL
• Partenaires : Kelis

Description du modelet

Ce modelet se compose de :

• un uiWidget qui doit être inséré dans les uiTemplates ou dans les transformers. Chaque publication du uiWidget constituera un point d'entrées d'annotation. Il peut 1 ou plusieurs points d'entrées d'annotation par page.
• un uiService annotMgr qui doit être inséré dans le uiFrame du generator qui va assurer :
  • la détection d'un environnement de stockage compatible,
  • la lecture et l'écriture des annotations auprès de l'environnement applicatif de stockage.
  • l'insertion d'un trigger dans tous les templates de pages pour détecter les points d'entrées d'annotation dans chaque page générée (points d'entrées issus du uiWidget).
• une image annot.gif qui doit être placée à l'emplacement site/img/annot.gif du dossier des ressources du uiFrame du generator. Cette image est uniquement destinée à améliorer le stylage du widget ; elle peut aisément être modifiée ou supprimée.

Pour fonctionner, ce modelet doit être associé à un service dataUiService avec au minimum l'environnement SCORM2004 activé (sm:physicalStorageLayer/sm:scorm2k4).

Mode d'emploi

Pour tester ce modelet :

1. Récupérez le modelet ici : [http://www.scenari-platform.org/trac/modelet/browser/branches/sc34/webSiteAnnot/model]
2. Créez un atelier dans SCENARIbuilder pointant vers ce dossier.
3. Créez un .wsptest pointant vers le demo/annot.wspdef.
4. Compilez et testez dans SCENARItest.

Pour intégrer ce modelet dans votre modèle :

1. Récupérez le modelet ici : [http://www.scenari-platform.org/trac/modelet/browser/branches/sc34/webSiteAnnot/model]
2. Copiez le service webSiteAnnot/svc/annotMgr.uiservice avec son dossier de ressources webSiteAnnot/svc/annotMgr.doss
3. Déclarez ce service dans votre uiFrame
4. Assurez-vous qu'au moins un service scorm2k4 est déclaré par ailleurs dans le uiFrame (avec un dataUiService par exemple).
5. Copiez le webSiteAnnot/widget/annot.uiWidget et référencez le partout ou vous souhaitez afficher une annotation.
6. Copiez l'image qui est dans webSiteAnnot/skin/res.uiframe.doss/site/img/annot.gif dans votre dossier de ressources de votre uiFrame.

Pour tester votre intégration :

• Si vous êtes dans une publication SCORM-CAM (utilisation du scormCamUiFrame), vous pourrez tester la fonctionnalité dans SCENARIchain / SCENARItest en activant "SCORM 2004" dans le simulateur SCORM intégré à SCENARI.
• Si vous êtes dans une publication 'standard' (utilisation du standardUiFrame), lors du test de la génération dans SCENARIchain / SCENARItest, aucun environnement SCORM 2004 ne sera détecté, les champs d'annotation seront automatiquement masqués.
  • Vous devez alors packager votre génération en SCORM 2004 et le tester dans une plateforme LMS compatible SCORM 2004.
  • Pour permettre néanmoins le test, il est possible de forcer l'affichage des champs d'annotation quelquesoit l'environnement détecté. Pour cela, éditer le fichier annotMgr.doss/annotMgr.js que vous avez copié, et recherchez ces les lignes de codes :

		//Pour tests : mettre this._isActive = true;
		this._isActive = false;

Remplacez this._isActive = false; par this._isActive = true;. ATTENTION, n'oubliez pas de remettre le fichier dans l'état initial après vos tests !

Pour modifier de stylage de cette annotation :

• Modifiez les styles de webSiteAnnot/widget/annot.uiWidget déclarés dans sm:customizableStyle.
  

  Attention !
  Ces styles n'apparaitront qu'après génération des styles *.uistyle.xhtml et leur association aux templates dans les .generator. Une fois générés, il faut modifier les styles directement dans le fichier *.uistyle.xhtml.

  Structure HTML lorsque le champ d'annotation est vide :

  <div clas="scAnnotField_co">
     <textarea class="scAnnotField"></textarea>
  </div>
  

  Structure HTML lorsque le champ d'annotation est renseigné (ajout de la classe scAnnotFilled) :

  <div clas="scAnnotField_co">
     <textarea class="scAnnotField scAnnotFilled">Exemple d'annotation remplie</textarea>
  </div>