La description des scripts
Dans
votre éditeur Scripts Manager, lorsque vous créez un nouveau script ou une
nouvelle fonction à partir de l’option de menu
« Script-Nouveau script », ou CTRL +E, vous disposez de
plusieurs zones d’informations qui seront utiliser pour donner de l’aide.
Ces
informations sont :
Résumé,
Description et catégorie.
Ainsi,
ultérieurement, l’utilisateur pourra mieux comprendre l’utilité d’un script,
soit à partir de l’éditeur, en se plaçant sur le script et en appelant la
fenêtre descriptions en réalisant le raccourci clavier CTRL +D, soit en
dehors de l’éditeur en activant l’aide du clavier avec le raccourci clavier
Insère +1 du pavé alphanumérique.
Dès
que l’aide du clavier sera activée, il suffira alors de réaliser le raccourci
clavier du script pour entendre la zone d’informations « Résumée, puis de
réaliser deux fois le raccourci clavier pour entendre la zone d’informations
« Description ».
Comme
les noms l’indiquent, le résumé permet d’informer brièvement l’utilisateur de
l’utilité du script, tandis que « Description » donne accès à une
description détaillée du script.
Ces
informations sont bien sûr facultatives.
La
description des scripts est enregistrée dans un fichier portant le même nom que
le fichier source contenant les scripts, mais avec l’extension JSD.
Par
exemple, les descriptions des différents scripts contenues dans le fichier
source RECORDNOW.JSS se trouvent dans le fichier RECORDNOW.JSD.
Mais
il arrive parfois, que pour un script créé, l’entrée dans le fichier JSD
correspondant ne se réalise pas.
Il
peut également se produire le phénomène inverse, c’est-à-dire que l’entrée d’un
script supprimé soit toujours présente dans le fichier JSD.
Et
pour terminer, il arrive que pour deux scripts ayant le même nom, l’un dans le
fichier défaut, et l’autre dans le fichier d’une application, provoque l’entrée
de la description du script défaut dans le fichiers JSD de l’application, et ce
à la place de l’entrée de la description du script de l’application.
Par
conséquent, l’éditeur Scripts Manager dispose d’un outil de mise à jour des
entrées de descriptions pour le fichier JSS ouvert.
Dès
que cet outil est lancé, les entrées inexistantes sont créées, et les entrées
qui ne devraient pas être présentes sont listées.
Pour
ce faire, ouvrez le fichier JSS pour lequel vous souhaitez réaliser le ménage.
A
partir du menu déroulant, activez l’option de menu
« Fichier-Synchroniser documentation ».
Automatiquement,
les nouvelles entrées sont créées.
Une
boîte de dialogue apparaît à l’écran et elle contient la liste des entrées pour
lesquelles les scripts ne figurent pas dans le fichier source ouvert.
Vous
pouvez sélectionner les entrées que vous voulez supprimer, puis faites
tabulation jusqu’au bouton « Supprimer sélectionnées » et
pressez la touche entrée.
Si
vous souhaitez quitter la boîte de dialogue sans supprimer les entrées, pressez
la touche entrée sur le bouton « Supprimer aucun ».
Pour
tout supprimer, pressez la touche entrée sur le bouton « Supprimer
tout ».
Philippe
BOULANGER