Creating & Storing Scripts

Altium Designer-Skripte werden normalerweise in einem Skriptprojekt (*.PrjScr) erstellt und gespeichert, können jedoch zu jedem Projekttyp hinzugefügt oder darin gespeichert werden.

Um mit dem Schreiben von Skripten zu beginnen, erstellen Sie zunächst ein neues Skriptprojekt und fügen diesem Projekt Skriptdateien hinzu.

Erstellen von Skriptprojekten und Skripten

Ein Skriptprojekt hilft Ihnen bei der Verwaltung Ihrer Skripte und kann über File » New » Script » Script Project in den Hauptmenüs erstellt werden.

Ein neues Projekt (Script_Project1.PrjScr) zum Speichern von Skripten wird im Projects panel aufgeführt.

Um dem Projekt ein neues Skript hinzuzufügen, klicken Sie mit der rechten Maustaste auf den Projektnamen und wählen Sie Add New to Project aus dem Kontextmenü.

Nachdem ein neues Skriptprojekt erstellt wurde, fügen Sie dem Projekt ein neues Skript hinzu.

Beim Erstellen eines neuen Skripts stehen je nach Projektanforderungen zwei Skripttypen zur Auswahl – Skript-Units und Skript-Formulare.

Skripttypen

Skript-Units

Eine Skript-Unit ist ein Skriptdokument mit einer bestimmten Sprachsyntax, zum Beispiel DelphiScript.

Eine Skript-Unit mit Skriptcode.

Skript-Formulare

Ein Skript-Formular ist ein Fenster, das verschiedene Steuerelemente wie Schaltflächen, Memofelder und Listenfelder mit Ereignishandlern enthalten kann. Im Editor hat ein Skript-Formular zwei Ansichten, die über die Registerkarten Code und Form ausgewählt werden können, wie unten am Skriptdokument zu sehen ist.

Ein Skript-Formular mit geöffneter Registerkarte Code und Form.

Skriptbeziehungen innerhalb eines Projekts

Wenn sich mehrere Skripte in einem Projekt befinden, hat jedes Skript innerhalb dieses Projekts (bei Verwendung derselben Sprachgruppe) Zugriff auf globale Variablen und Prozeduren. Alle Skripte in einem Projekt sind praktisch „sichtbar“, sodass eine Prozedur in einem Skript eine andere Prozedur in einem anderen Skript innerhalb desselben Skriptprojekts aufrufen kann.

Es ist wichtig, für Skripte innerhalb desselben Projekts eindeutige Prozedur- und globale Variablennamen zu verwenden. Ein Ansatz besteht darin, alle gemeinsamen Prozeduren/Funktionen, die in verschiedenen Skripten verwendet werden, in ein neues Skript innerhalb desselben Projekts zu verschieben. Dadurch können die Prozeduren und Funktionen in diesem neuen gemeinsamen Skript leicht für verschiedene Skriptprojekte wiederverwendet werden.

► Siehe Writing Scripts für ein Beispiel zum Aufrufen einer Prozedur aus einem anderen Skript.

Hochladen eines Skriptprojekts in den Connected Workspace

Altium Designer bietet in Verbindung mit Ihrem verbundenen Workspace die Möglichkeit, Workspace-Skripte zu erstellen und zu verwalten. Solche Skripte werden direkt im Workspace erstellt, wobei das entsprechende Skriptprojekt (*.PrjScr) in eine Revision eines Ziel-Workspace-Skripts hochgeladen wird. Der Ablauf ist wie folgt:

1. Erstellen Sie ein neues Script Item in Ihrem verbundenen Workspace über das Explorer Panel. Weitere Informationen zum Erstellen von Items im Workspace finden Sie auf der Seite Creating & Editing Content.

2. Klicken Sie im Explorer Panel mit der rechten Maustaste auf das gewünschte Script Item und wählen Sie den Befehl Upload aus dem Kontextmenü. Daraufhin wird der standardmäßige Windows-Dialog Open angezeigt, mit dem Sie zur gewünschten Skriptprojektdatei (*.PrjScr) navigieren können.

   Wenn das Item keine geplante Revision hat, erfolgt das Hochladen in die nächste geplante Revision, die im Rahmen des Upload-Vorgangs automatisch erstellt wird.

   
   Festlegen der Skriptprojektdatei, die in das Ziel-Script-Item hochgeladen werden soll.

3. Nachdem die gewünschte Datei ausgewählt wurde, fahren Sie mit dem Hochladen fort, indem Sie auf die Schaltfläche Open klicken. Die Projektdatei wird zusammen mit allen Dateien im selben Ordner in die Revision hochgeladen und steht auf der Registerkarte der Aspektansicht Details für diese Revision im Explorer Panel zur Verfügung.

   
   Das hochgeladene Projekt wird zusammen mit allen Dateien im selben Ordner auf der Registerkarte der Aspektansicht Details für die Revision des Script Item aufgeführt.

Alternativ kann ein Skriptprojekt in ein neues Workspace-Skript hochgeladen werden, indem Sie die ausgewählte Skriptprojektdatei und die zugehörigen Quelldateien aus einem Quellordner im Windows Explorer ziehen und im gewünschten Ordner im Explorer Panel ablegen. Daraufhin wird der Dialog Create New Item angezeigt, in dem die gezogenen Dateien im Bereich Sources aufgelistet sind. Das Name des Items entspricht den Dateinamen einschließlich Erweiterung (Einträge werden durch ein Semikolon getrennt). Das Description hat das Format Uploaded from <FileNameandPath>, Size <FileSize>, Created on <FileCreationDate> (Einträge werden durch ein Semikolon getrennt). Ändern Sie diese Angaben nach Bedarf. Das Item ID entspricht dem auf Ordnerebene definierten Item-Namensschema. Wenn für den Ordner kein Namensschema definiert ist, erfolgt die Benennung nach dem Schema $CONTENT_TYPE_CODE-{000000}.

Hochladen eines Skriptprojekts und zugehöriger Dateien in die erste Revision eines neu erstellten Workspace-Skripts per Drag-and-drop.

Bearbeiten eines Workspace-Skripts

Sie können jederzeit zu jeder Revision eines Workspace-Skripts zurückkehren und diese direkt bearbeiten. Klicken Sie im Explorer Panel mit der rechten Maustaste auf die Revision und wählen Sie den Befehl Edit aus dem Kontextmenü. Dadurch wird diese Revision in Altium Designer geöffnet, wo sie nach Bedarf bearbeitet und anschließend mit dem Befehl Save to server (Tastenkürzel: Ctrl+Alt+S) als nächste Revision zurück in den Workspace gespeichert werden kann – verfügbar über das Kontextmenü per Rechtsklick für den Projekteintrag im Projects Panel.

Zugriff auf den Befehl zum Starten der direkten Bearbeitung einer vorhandenen Revision eines Skripts.

Wenn Sie das in einem Workspace-Skript gespeicherte Projekt oder die zugehörigen Quelldaten ändern müssen und Ihnen die aktualisierten Quelldateien vorliegen, können Sie diese Dateien in dieses Workspace-Skript hochladen – die neuen Dateien werden in der nächsten Revision dieses Workspace-Skripts gespeichert.

Globale Projekte

Skriptprojekte können mit der Funktion Global Projects installiert werden, sodass sie beim Start der Software vorgeladen werden und verfügbar sind. Die globalen Variablen und Prozeduren aus diesen Skripten stehen dann zur Verwendung in anderen geöffneten Skriptprojekten zur Verfügung.

Um ein Skriptprojekt global zu machen, navigieren Sie über den Dialog Preferences zur Seite Scripting System - Global Projects. Verwenden Sie die Schaltfläche Install , um zu einer Projektdatei oder einem Workspace-Projekt zu navigieren und diese(s) auszuwählen. Wiederholen Sie diesen Vorgang für alle Skriptprojekte, die Sie global verfügbar machen möchten.

Das installierte Workspace-Skriptprojekt steht Altium Designer immer dann zur Verfügung, wenn ein Benutzer mit dem Workspace verbunden ist. Beachten Sie, dass das installierte Workspace-Skriptprojekt anhand seines Speicherorts bzw. „Pfads“ innerhalb der Ordnerstruktur des Workspace und der ID des Workspace-Skripts aufgeführt wird, das die Skriptprojektdaten enthält.

Verwenden Sie Scripting System – Global Projects aus dem Dialog Preferences, um Skripte zu installieren.

Globale Projekte ermöglichen es Skripten aus einem lokalen Projekt desselben Typs, Routinen aus den installierten globalen Skriptprojekten zu verwenden. Wenn der Dialog Select item to Run geöffnet wird (File » Run Script), erscheinen die installierten Skriptprojekte zusammen mit anderen derzeit geöffneten Skriptprojekten im Projects panel.