Creating & Storing Scripts

Les scripts Altium Designer sont généralement créés et stockés dans un projet de script (*.PrjScr), mais ils peuvent être ajoutés à ou stockés dans n’importe quel type de projet.

Pour commencer à écrire des scripts, commencez par créer un nouveau projet de script et y ajouter des fichiers de script.

Création de projets de script et de scripts

Un projet de script vous aide à gérer vos scripts et peut être créé en sélectionnant File » New » Script » Script Project dans les menus principaux.

Un nouveau projet (Script_Project1.PrjScr) destiné à stocker des scripts sera répertorié dans le panneau Projects.

Pour ajouter un nouveau script au projet, cliquez avec le bouton droit sur le nom du projet et sélectionnez Add New to Project dans le menu contextuel.

Une fois le nouveau projet de script créé, ajoutez-y un nouveau script.

Lors de la création d’un nouveau script, vous avez le choix entre deux types de scripts selon les exigences de votre projet : les unités de script et les formulaires de script.

Types de scripts

Unités de script

Une unité de script est un document de script avec une syntaxe de langage spécifique, par exemple DelphiScript.

Une unité de script avec du code de script.

Formulaires de script

Un formulaire de script est une fenêtre pouvant héberger divers contrôles tels que des boutons, des mémos et des zones de liste, auxquels peuvent être associés des gestionnaires d’événements. Dans l’éditeur, un formulaire de script possède deux vues sélectionnables avec les onglets Code et Form, comme on peut le voir en bas du document de script illustré ci-dessous.

Un formulaire de script avec les onglets Code et Form ouverts.

Relations entre scripts dans un projet

Lorsque plusieurs scripts se trouvent dans un projet, tout script (utilisant le même ensemble de langages) au sein de ce projet a accès aux variables globales et aux procédures. Tous les scripts d’un projet sont en pratique « visibles », de sorte qu’une procédure dans un script peut appeler une autre procédure dans un autre script du même projet de script.

Il est important d’avoir des noms de procédures et de variables globales uniques pour les scripts d’un même projet. Une approche consiste à déplacer toutes les procédures/fonctions communes utilisées dans différents scripts vers un nouveau script au sein du même projet. Cela permet de réutiliser facilement les procédures et fonctions de ce nouveau script commun dans différents projets de script.

► Reportez-vous à Writing Scripts pour un exemple d’appel d’une procédure depuis un autre script.

Téléchargement d’un projet de script vers le Workspace connecté

Altium Designer, en association avec votre Workspace connecté, permet de créer et de gérer des Workspace Scripts. Ces scripts sont créés directement dans le Workspace, le projet de script correspondant (*.PrjScr) étant téléversé vers une révision d’un Workspace Script cible. Le processus est le suivant :

1. Créez un nouvel élément Script dans votre Workspace connecté à l’aide du panneau Explorer. Reportez-vous à la page Creating & Editing Content pour en savoir plus sur la création d’éléments dans le Workspace.

2. Cliquez avec le bouton droit sur l’élément Script requis dans le panneau Explorer puis choisissez la commande Upload dans le menu contextuel. La boîte de dialogue Windows standard Open apparaîtra, vous permettant de rechercher le fichier de projet de script requis (*.PrjScr).

   Si l’élément n’a pas de révision planifiée, le téléversement se fera vers la prochaine révision planifiée, créée à la volée dans le cadre du processus de téléversement.

   
   Spécification du fichier de projet de script à téléverser vers l’élément Script cible.

3. Une fois le fichier souhaité sélectionné, poursuivez le téléversement en cliquant sur le bouton Open. Le fichier de projet, ainsi que tous les fichiers du même dossier, sont téléversés vers la révision et seront disponibles dans l’onglet de vue d’aspect Details pour cette révision, dans le panneau Explorer.

   
   Le projet téléversé, ainsi que tous les fichiers du même dossier, sont répertoriés dans l’onglet de vue d’aspect Details pour la révision de l’élément Script.

Sinon, un projet de script peut être téléversé dans un nouveau Workspace Script en faisant glisser le fichier de projet de script sélectionné et les fichiers source associés depuis un dossier source dans l’Explorateur Windows, puis en les déposant dans le dossier requis du panneau Explorer. La boîte de dialogue Create New Item apparaîtra, avec les fichiers glissés répertoriés dans la zone Sources. Le Name de l’élément sera constitué des noms de fichiers, extension comprise (les entrées seront séparées par un point-virgule). Le Description sera au format Uploaded from <FileNameandPath>, Size <FileSize>, Created on <FileCreationDate> (les entrées seront séparées par un point-virgule). Modifiez-les selon vos besoins. Le Item ID sera conforme au schéma de nommage des éléments défini au niveau du dossier. Si aucun schéma de nommage n’est défini pour le dossier, le nommage suivra le schéma $CONTENT_TYPE_CODE-{000000}.

Téléversement d’un projet de script et des fichiers associés vers la révision initiale d’un Workspace Script nouvellement créé à l’aide de la méthode glisser-déposer.

Modification d’un Workspace Script

À tout moment, vous pouvez revenir à n’importe quelle révision d’un Workspace Script et la modifier directement. Cliquez avec le bouton droit sur la révision dans le panneau Explorer et choisissez la commande Edit dans le menu contextuel. Cela ouvrira cette révision dans Altium Designer, où elle pourra être modifiée selon les besoins, puis enregistrée dans le Workspace comme révision suivante à l’aide de la commande Save to server (raccourci : Ctrl+Alt+S) – disponible dans le menu contextuel accessible par clic droit associé à l’entrée du projet dans le panneau Projects.

Accès à la commande permettant de lancer la modification directe d’une révision existante d’un script.

Si vous devez modifier le projet ou les sources associées stockés dans un Workspace Script et que vous disposez des fichiers source mis à jour, vous pouvez téléverser ces fichiers vers ce Workspace Script – les nouveaux fichiers seront stockés dans la révision suivante de ce Workspace Script.

Projets globaux

Les projets de script peuvent être installés à l’aide de la fonctionnalité Global Projects afin d’être préchargés et disponibles au démarrage du logiciel. Les variables globales et les procédures de ces scripts peuvent être utilisées dans d’autres projets de script ouverts.

Pour rendre un projet de script global, accédez à la page Scripting System - Global Projects via la boîte de dialogue Preferences. Utilisez le bouton Install pour rechercher et sélectionner un projet à partir du fichier ou du Workspace. Répétez ce processus pour tous les projets de script que vous souhaitez rendre disponibles globalement.

Le projet Workspace Script installé sera disponible dans Altium Designer chaque fois qu’un utilisateur sera connecté au Workspace. Notez que le projet Workspace Script installé est répertorié par son emplacement ou « chemin » dans la structure de dossiers du Workspace et par l’ID du Workspace Script contenant les données du projet de script.

Utilisez Scripting System – Global Projects depuis la boîte de dialogue Preferences pour installer des scripts.

Les projets globaux permettent aux scripts d’un projet local du même type d’utiliser les routines des projets de script globaux installés. Lorsque la boîte de dialogue Select item to Run est lancée (File » Run Script), les projets de script installés apparaissent avec les autres projets de script actuellement ouverts dans le panneau Projects .