====== Paramétrage ======
Il est possible de paramétrer instrumenpoche pour que, dès son apparition, le logiciel ait un certain comportement : limitation du nombre de boutons disponibles, instruments "cassés" ou fixes...
===== Le principe =====
Instrumenpoche est un fichier Flash qui peut être inséré dans une page HTML ou une autre application Flash.
On peut peut insérer instrumenpoche "simplement" afin d'avoir toutes les fonctionnalités du logiciel comme sur la page [[http://instrumenpoche.net/v2/iep.php|Utiliser en ligne]], mais on peut aussi lui passer deux paramètres essentiels :
* un [[:script:start|script]] décrivant une animation,
* un script de paramétrage.
Chacun de ces deux paramètres peut être passé de deux façons différentes à instrumenpoche : soit en donnant un URL vers un fichier, soit en donnant directement le code XML voulu.
La variable donnant un chemin vers une script XML doit s'appeler ''anim'' (et ''iep_anim'' si on veut donner le contenu du script), la variable pour un fichier de configuration s'appelle ''config'' (et ''iep_config'' si on préfère donner le contenu). Pour la configuration, lorsque Instrumenpoche est appelé depuis une autre application Flash, on peut aussi utiliser un objet appelé ''iep_parametres''.
==== Dans une page HTML ====
Si on insère [[:tutoriels:iep_dans_html|instrumenpoche dans une page HTML]] sans javascript, on le fait avec le code suivant :
Où on reconnaît deux paramètres ''flashvars'' (qui servent à passer des paramètres à une animation Flash) le code ''anim=mon_anim.xml&config=ma_config.xml'' qui donne un lien vers un fichier d'animation ''mon_anim.xml'' et un fichier de configuration ''ma_config.xml''.
Il est également possible de passer ces paramètres après l'URL d'instrumenpoche. Au lieu de ''flashvars'', on aura '''' et ''src="iep.swf?anim=mon_anim.xml&config=ma_config.xml"''
**Note.** Dans la page HTML, les paramètres ''anim'', ''config'', etc doivent apparaître deux fois et les valeurs qui leur sont passées sont données sans guillemets. En cas de texte complet (paramètres ''iep_anim'' ou ''iep_config''), les textes doivent être "échappés" au format URL.
==== Dans une autre animation Flash ====
Si on insère instrumenpoche [[:tutoriels:application_contenant_iep|dans une application Flash]], on peut d'abord créer une variable texte ''anim'' qui donnera le chemin vers un script XML d'animation, et une variable ''config'' qui donnera le chemin vers un script de configuration.
On peut également donner le texte XML de l'animation dans une variable ''iep_anim'', le texte XML de la configuration dans une variable ''iep_config''.
Mais il est en plus possible de créer un objet ''iep_parametres'' pour le paramétrage, dont les enfants (noms et valeurs) seront identiques à ceux de la classe Instrumenpoche.as :
var iep_parametres:Object = new Object();
iep_parametres.boutons_lecteur = new Array("debut",
"precedente", "pause", "lecture",
"boucle", "suivante", "fin","fermer");
iep_parametres.geometrie = false;
Tout cela doit être fait avant le chargement d'instrumenpoche.
===== Syntaxe du paramétrage =====
Pour la syntaxe des scripts décrivant les animations, voir [[:script:start|la rubrique "script"]].
Les paramètres disponibles sont ceux contenus dans la classe [[http://instrumenpoche.sesamath.net/documentation_classes/Instrumenpoche.html|Instrumenpoche.as]] et dont le nom commence par ''options_''.
Un fichier de configuration d'instrumenpoche est au format XML. Les paramètres qui sont de la forme ''options_nom1_nom2'' avec une valeur par défaut de ''false'' dans ''Instrumenpoche.as'' peuvent passer à ''true'' par un nœud XML de la forme
nom2
Si on veut passer plusieurs paramètres de la forme ''options_nom1_XXX'' à ''true'', on les écrit dans le même nœud en les séparant par une virgule.
**Exemple**
Pour que le rapporteur soit fixe et apparaisse avec une double graduation (''Instrumenpoche.options_rapporteur_fixe'' et ''Instrumenpoche.options_rapporteur_double'' égaux à ''true''), on code :
fixe,double
Pour les autres, qui apparaissent sous la forme ''parametre=valeur'' dans ''Instrumenpoche.as'', on écrit :
valeur
**Exemple**
15
va débuter l'animation à la quinzième étape.
**Lecture**
Pour obtenir instrumenpoche en mode "lecture" classique, un raccourci est disponible : ''config="config_lecture"''.
==== Exemple complet ====
On veut créer un exercice tout simple : une figure avec deux points O et I est tracée, et on demande à l'élève de tracer au crayon le segment [OI].
Cet exemple est [[http://instrumenpoche.sesamath.net/v2/exercices/base/segment.html|visible en ligne]]. Si on examine le code source de la page HTML, on voit qu'elle appelle Instrumenpoche par le code
'../../iep.swf?config=longueur_segment_config.xml&anim=longueur_segment_anim.xml'
Donc Instrumenpoche va se charger avec [[http://instrumenpoche.sesamath.net/v2/exercices/base/segment_anim.xml|une animation]] et [[http://instrumenpoche.sesamath.net/v2/exercices/base/segment_config.xml|une configuration]] accessibles en ligne.
L'animation chargée est
où on affiche deux points O et I et le texte de la consigne : "Trace le segment [OI].".
crayonannuler,restaurer,validersansinstrument,sanstrace,sanscoordonnees,fixe../../
Comme le fichier de configuration ne précise pas de ''mode'', instrumenpoche va rester en mode "géométrie" (utilisation des instruments) et se caler sur la fin de l'animation chargée, qui servira d'énoncé de l'exercice.
**Ligne 1**
Le seul instrument accessible par le menu est le crayon.
**Ligne 2**
En plus du bouton permettant de sélectionner ou masquer le crayon, on donne les boutons permettant d'annuler ou restaurer les dernières actions effectuées et le bouton qui valide la construction effectuée.
Cette validation sera effectuée à l'aide des données de la ligne ''...'' située plus bas.
**Ligne 3** On ne peut pas déplacer d'instrument sur un point en s'aidant du clic droit (''sansinstrument'') ni tracer de point à point (''sanstrace'') et les points ne peuvent pas être déplacés (''fixe''). Lorsqu'un point est survolé à la souris, ses coordonnées ne sont pas affichées par Instrumenpoche (''sanscoordonnees'').
**Ligne 4** Par rapport à la page HTML, le fichier d'instrumenpoche ''iep.swf'' est situé deux étages au-dessus dans l'arborescence. Il faut le préciser, car cette arborescence est la même pour les fichiers de la configuration et de l'animation.
**Ligne 5** Un test. Ce test utilise les fonctions de [[http://instrumenpoche.sesamath.net/documentation_classes/TestIep.html|la classe TestIep.as]]. ''resultat_0'' est le message qui sera affiché si le test renvoie le nombre 0, ''resultat_1'' le message affiché si le test renvoie 1.