Script Library · indice

Creare e salvare uno script

  1. Per un record riutilizzabile scegli File → New User script; per un record della Session aperta scegli New Session script.
  2. In Metadata compila un ID stabile e un Name; controlla Scope e Language e, se utili, versione, descrizione e API richieste. Per cambiare linguaggio modifica il campo Language con Python o Octave.
  3. Apri Source e scrivi il codice. Ad esempio, per una prova Octave autonoma: disp("Hello from Script Library");
  4. Se servono parametri, apri Parameters e inserisci una definizione per riga nel formato nome | tipo | obbligatorio | valore predefinito | descrizione. Ad esempio threshold | double | 0 | 1.5 | Example threshold; 0 indica che non è obbligatorio. I valori devono rispettare il tipo dichiarato.
  5. Scegli File → Save oppure Ctrl+S. Il messaggio in basso conferma il riferimento e la revisione salvati nel Registry.

Campi di Metadata

CampoUso e condizioni
ScopeUser conserva il record nella libreria utente; Session lo conserva nella Session aperta. La scelta New imposta inizialmente il valore; in una nuova bozza può essere modificato. Su un record già registrato è in sola lettura.
LanguageInserisci Python o Octave nella nuova bozza; su un record già registrato il linguaggio è in sola lettura. Il sorgente iniziale segue il linguaggio scelto.
IDIdentificatore stabile e univoco nell'ambito, parte del riferimento. Dopo la registrazione è in sola lettura.
NameNome leggibile mostrato nell'elenco. Compilalo prima di salvare.
VersionVersione del record, inizialmente 1.0.0; inserisci una versione valida, ad esempio 1.2.3. È distinta dalla revisione incrementata dal salvataggio.
DescriptionDescrizione libera dello scopo dello script.
Required APIsAPI pubbliche richieste dal codice; ad esempio NUMERIC_API_v1. La revisione dell'esecuzione controlla la disponibilità delle API dichiarate.
ResetIl pulsante accanto a ciascun campo ripristina il valore predefinito del controllo, vuoto nei campi Metadata provati; è disabilitato se il campo non è modificabile. Dopo Reset reinserisci gli eventuali valori richiesti prima di salvare.
Editor delle definizioni dei parametri con una riga di esempio
Una definizione di parametro nell'editor. Il salvataggio controlla la sintassi.

Formato delle definizioni

In Parameters ogni riga usa nome | tipo | obbligatorio | predefinito | descrizione. Nome e tipo sono necessari; gli altri campi possono essere vuoti. Obbligatorio accetta 0 o 1; se omesso vale 0. I tipi disponibili sono string, integer, double, number, boolean, choice, color, path, file e command: i significati sono illustrati nella tabella dei tipi del Runner. Il salvataggio controlla la struttura delle definizioni e i nomi duplicati. Controlla anche il valore predefinito nel Runner: un testo come wrong può essere salvato come predefinito di un double, ma Validate review lo rifiuta come numero non valido. Correggi il valore nel Runner o la definizione registrata e salva di nuovo. Una riga vuota è ignorata.

Definire le alternative di un choice

Le cinque colonne dell'editor Parameters non includono l'elenco delle alternative. In questa versione, un parametro choice creato lì senza alternative può essere salvato ma il Runner non offre scelte e la validazione fallisce. Una soluzione è dichiarare il parametro nel sorgente Python, lasciando libera la riga con lo stesso nome in Parameters:

from gxtxt import gxtxt_parameter_declare
gxtxt_parameter_declare('mode', 'choice', values=['red', 'blue'], default='red')

Salva lo script: la dichiarazione viene acquisita staticamente dal sorgente. Nel Runner il menu mode offre red e blue. Non definire lo stesso nome anche come metadato manuale: i nomi in conflitto richiedono correzione.