Le langage de script d'Instrumenpoche

Les constructions géométriques d’Instrumenpoche sont enregistrées au format XML.

Il s’agit de fichiers “textes” lisibles avec n’importe quel éditeur de texte. Ces fichiers décrivent les constructions, à l’aide de balises comparables à celles du langage HTML (le langage utilisé pour les pages web).

Ce format de fichier a plusieurs avantages :

• il est lisible et compréhensible par un humain, il suffit d’utiliser n’importe quel éditeur de texte ou le bouton d'Instrumenpoche ;
• il est universel : de nombreux programmes utilisent des formats semblables (la suite bureautique OpenOffice.org, le client de messagerie Thunderbird…) ce qui permet, à partir d’un même fichier, de produire des documents de divers formats (animation lue par le lecteur Instrumenpoche, page web statique, document imprimable…)

Vous pouvez donc facilement modifier ces fichiers, les copier, les échanger…

L'interface de création d'Instrumenpoche crée automatiquement, au fur et à mesure des actions effectuées, le script correspondant à la construction. Il est possible de voir le script correspondant et de le modifier en cliquant sur le bouton

Avec l'interface de création d'Instrumenpoche, cliquons deux fois sur le bouton On voit le crayon apparaître puis disparaître. Cliquons ensuite sur pour voir le script correspondant à cette animation toute simple, qui consiste juste à montrer puis masquer le crayon. Le texte suivant apparaît (les couleurs et indentations ne font pas partie du script, elles sont justes définies pour faciliter la lecture) :

<?xml version="1.0" encoding="UTF-8"?>
  <INSTRUMENPOCHE version="2">
     <action mouvement="montrer" objet="crayon" />
     <action mouvement="masquer" objet="crayon" />
  </INSTRUMENPOCHE>

Bien que très simple, ce code contient tous les éléments obligatoires d'un script Instrumenpoche :

• un en-tête qui indique que le fichier est au format XML et que l'encodage de caractères est en unicode :

<?xml version="1.0" encoding="UTF-8"?>

• Une balise ouvrante et une fermante, nommées INSTRUMENPOCHE. Le code de la construction se trouvera entre ces deux balises. Pour des raisons de compatibilité avec l'ancienne version, il faut préciser version=“2” dans la première balise.

<INSTRUMENPOCHE version="2">
     ...
</INSTRUMENPOCHE>

• Des nœuds XML, tous de la même forme : <action … /> avec différents attributs qui caractérisent l'action qu'ils décrivent. Parmi tous les attributs possibles, mouvement et objet sont obligatoires : ils précisent l'action à effectuer et l'objet sur lequel se porte l'action.

Un autre type de nœud est possible, qui ne décrit pas une action Instrumenpoche mais un commentaire destiné à faciliter la lecture du script. Dans ce cas, le nœud doit se nommer commentaire et comporter un seul attribut nommé texte. Dans l'exemple ci-dessus, on pourrait ainsi préciser :

<?xml version="1.0" encoding="UTF-8"?>
  <INSTRUMENPOCHE version="2">
     <commentaire texte="Faisons apparaître le crayon" />
     <action mouvement="montrer" objet="crayon" />
     <action mouvement="masquer" objet="crayon" />
  </INSTRUMENPOCHE>

Les commentaires sont ignorés par Instrumenpoche en mode lecture.

Une action d'Instrumenpoche est donc enregistrée sous forme d'un nœud XML composé d'attributs, comme par exemple pour le crayon :

<action objet="crayon" mouvement="translation" abscisse="200" ordonnee="350" vitesse="10" />

L'ordre dans lequel ces attributs sont écrits importe peu. Ainsi, le nœud précédent est identique à :

<action abscisse="200" ordonnee="350" vitesse="10"  objet="crayon" mouvement="translation" />

Il est parfois souhaitable, entre deux étapes de construction, de forcer Instrumenpoche à faire une pause pour que le lecteur puisse lire un texte, se rendre compte d'un mouvement particulier… Dans ce cas, il faut ajouter l'attribut tempo dans le nœud décrivant l'action qui est juste avant la pause, en précisant, comme valeur d'attribut, le nombre de dixièmes de seconde de la pause. Par exemple, pour faire une pause de deux secondes après l'apparition du crayon :

<action mouvement="montrer" objet="crayon" tempo="20" />

On peut modifier un script d'Instrumenpoche par deux moyens :

• soit en cliquant sur le bouton qui fait apparaître une fenêtre montrant le script ;
• soit collant le script dans un éditeur de textes.

Appuyer sur le bouton fait apparaître une fenêtre semblable à celle-ci :

Le texte du script qui y apparaît est modifiable.

Les boutons et permettent de modifier la taille du texte.

Le bouton ajoute un nouveau nœud minimal à compléter, à la fin du script :

<action mouvement="" objet="" />

Le bouton permet d'activer et désactiver la coloration syntaxique, qui met en couleur les mots-clés du script.

Le bouton valide le texte affiché dans la fenêtre comme nouveau script courant d'Instrumenpoche.

Le bouton ferme la fenêtre sans valider le script.

Pour en savoir plus : script.

Un script d'Instrumenpoche peut également être modifié dans un éditeur de texte. Le site Framasoft présente des éditeurs de textes ou, plus puissants, des environnements de programmation libres. Cette méthode permet de bénéficier des fonctionnalités de ces logiciels : coloration syntaxique, fonctions avancées de recherche et remplacement de texte, etc.

Il faut toutefois distinguer un éditeur de texte (qui traite un texte brut) d'un logiciel de traitement de textes, comme Microsoft Word ou OpenOffice.org, qui met le texte en forme. On peut toutefois utiliser ces logiciels pour modifier un script d'Instrumenpoche, à condition de l'enregistrer au format “texte brut” : choisir “enregistrer sous…” puis “texte brut”. Sinon le logiciel enregistrera le fichier dans un autre format, qu'Instrumenpoche ne pourra pas lire.