<< Retour au sommaire

 

La description des scripts

 

 

 

Table des matières

  1. Qu’est-ce que c’est ?
  2. Modifier la description ;
  3. L’aide du clavier ;
  4. La synchronisation.

 

Qu’est-ce que c’est ?

 

Dans votre éditeur Scripts Manager, lorsque vous créez un nouveau script ou une nouvelle fonction à partir de la commande du menu déroulant :

ALT, « Script », « Nouveau script », ou le raccourci clavier CTRL +E, vous disposez de plusieurs zones d’informations qui seront peut-être, ultérieurement, utiliser pour fournir de l’aide à l’utilisateur.

Ces informations sont :

Résumé, Description et catégorie.

 

Ainsi, un 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 depuis 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.

 


Modifier la description

 

Lors de la création d’un script ou d’une fonction, vous devez définir un certain nombre d’informations obligatoires ou facultatives dans la boîte de dialogue « Description du Script que vous avez activée avec le raccourci clavier CTRL +E, ou depuis la commande du menu déroulant :

ALT, « Script », « Nouveau script ».

 

Ultérieurement, vous pourrez revenir dans cette boîte de dialogue afin de procéder à des modifications.

Pour ce faire, placez-vous dans le script ou dans la fonction pour lequel vous désirez modifier les propriétés, puis, réalisez le raccourci clavier CTRL +D.

Dans la boîte de dialogue qui apparaît à l’écran, procédez aux différents changements, puis validez le bouton « Ok ».

De retour dans le fichier source, n’oubliez pas de compiler, donc, CTRL +S.

 

L’aide du clavier

 

Pour activer l’aide du clavier, vous devez au préalable vous placer dans l’environnement adéquat :

  1. Pour interroger les scripts d’une application, lancez l’application concernée au préalable ;
  2. Pour interroger les scripts d’une application ainsi que ceux du fichier « Default.jss », lancez l’application au préalable ;
  3. Pour interroger uniquement les scripts du fichier « Default.jss », vous ne devez pas vous soucier de l’endroit où vous vous situez à l’écran.

 

Puis, dès que vous avez activé l’aide du clavier depuis le raccourci clavier Insère +1 du pavé alphanumérique, il suffit que vous réalisiez le raccourci clavier du script pour que vous soit annoncée la zone d’informations intitulée « Résumée », celle que vous avez-vous-mêmes renseignée lors de la création du script.

Puis, si vous désirez obtenir davantage d’informations, vous devez réaliser 2 fois rapidement le raccourci clavier afin d’entendre, cette fois, la zone d’informations intitulée « Description ».

 

Comme les intitulés de ces 2 propriétés l’indiquent assez clairement, le résumé permet d’informer brièvement l’utilisateur sur le rôle du script, tandis que « Description » donne accès à une aide plus détaillée du script.

 

Et encore mieux, en réalisant 3 fois rapidement le raccourci clavier du script, vous obtenez le nom du script.

 

Rappel :

 


La synchronisation

 

Lors de la création d’un script ou d’une fonction, les informations « Résumé », « Description » et « Catégorie » sont facultatives.

Mais il est toutefois vivement conseillé de les renseigner !

Du reste, 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 fichier JSD de l’application, et ce à la place de l’entrée de la description du script de l’application.

C’est l’horreur !

Par conséquent, et heureusement, l’éditeur Scripts Manager dispose d’une fonctionnalité de mise à jour d’entrées de descriptions pour le fichier JSS ouvert.

 

Dès que cette fonctionnalité est lancée, les entrées inexistantes sont créées, et les entrées qui ne devraient pas être présentes sont listées.

 

Vous voulez essayer ?

Pour commencer, ouvrez le fichier JSS dans lequel vous souhaitez effectuer le ménage.

Puis, validez la commande du menu déroulant :

ALT, « Fichier », « Synchroniser documentation ».

 

Automatiquement, les nouvelles entrées sont créées et si la synchronisation ne détecte aucune erreur, la fenêtre est refermée.

 

Dans le cas contraire, une boîte de dialogue apparaît à l’écran, elle contient la liste des entrées pour lesquelles les scripts ne figurent pas dans le fichier source ouvert.

 

Vous pouvez sélectionner manuellement les entrées que vous voulez supprimer, puis faites tabulation jusqu’au bouton intitulé « Supprimer sélectionnées » et pressez la touche entrée.

 

Pour tout supprimer, pressez la touche entrée sur le bouton intitulé « Supprimer tout ».

 

Par contre, si vous souhaitez quitter la boîte de dialogue sans supprimer les entrées, pressez la touche entrée sur le bouton intitulé « Supprimer aucun ».

 

Philippe BOULANGER