Elementi da utilizzare nella descrizione XML dell'estensione

Le proprietà detenute dagli elementi sono elencate in una sezione separata.

Elementi generali

<document>

Deve essere presente in ogni file description.xml come nodo radice. Nessuna funzione speciale. Nessun attributo

<about>

Informazioni su questa estensione (autore, licenza, ecc.). Questo elemento è consentito sia nel file .xml di una singola estensione, sia nel file .pluginmap. Fare riferimento al manuale .pluginmap per i dettagli di riferimento, il capitolo sulle informazioni 'informazioni' per un'introduzione.

<code>

Definisce dove cercare il modello JS per l'estensione. Utilizzare solo una volta per file, come figlio diretto del tag document. Attributi:

file

Nome file del modello JS, relativo alla cartella in cui si trova il codice xml dell'estensione

<help>

Definisce dove cercare il file della guida per l'estensione. Utilizzare solo una volta per file, come figlio diretto del tag documento. Attributi:

file

Nome del file della guida, relativo alla cartella in cui si trova il codice xml dell'estensione

<copy>

Può essere utilizzato come elemento figlio (diretto o indiretto) degli elementi di layout principali, cioè <dialog > e <wizard >. Viene utilizzato per copiare un intero blocco di elementi XML 1:1. Attributes:

id

L'ID da cercare. Il tag <copy> cercherà un precedente elemento XML a cui è stato assegnato lo stesso ID e lo copierà includendo tutti gli elementi discendenti.

copy_element_tag_name

In alcuni casi, vorrete una copia quasi letterale, ma cambierete il nome del tag dell'elemento da copiare. L'esempio più importante è quando si desidera copiare un'intera <tab> da un'interfaccia alla <pagina> di un'interfaccia guidata. In questo caso, impostereste copy_element_tag_name="page" per eseguire questa conversione automaticamente.

Definizioni dell'interfaccia

<dialog>

Definisce un'interfaccia di tipo finestra. Inserire la definizione della GUI all'interno di questo tag. Utilizzare solo una volta per file, come figlio diretto del tag document. È richiesto almeno uno dei tag «dialog» o «wizard» per un'estensione. Attributi:

label

Didascalia per la finestra

recommended

La finestra dovrebbe essere utilizzata come interfaccia «consigliata» (cioè l'interfaccia che sarà mostrata in modo predefinito, a meno che l'utente non abbia configurato RKWard per utilizzare, in modo predefinito, un'interfaccia specifica)? Questo attributo non ha attualmente alcun effetto, poiché è implicitamente «vero», a meno che la procedura guidata sia consigliata.

<wizard>

Definisce un'interfaccia simile a una procedura guidata. Inserisci la definizione GUI all'interno di questo tag. Utilizzala una sola volta per file, come tag figlio diretto del tag document. Per un'estensione è richiesto almeno uno tra i tag «dialog» o «wizard». Accetta solo i tag <page> o <embed> come tag figlio diretto. Attributi:

label

Didascalia per la procedura guidata

recommended

La procedura guidata deve essere utilizzata come interfaccia «consigliata» (cioè l'interfaccia che sarà mostrata in modo predefinito, a meno che l'utente non abbia configurato RKWard per utilizzare come impostazione predefinita un'interfaccia specifica)? Facoltativo, il valore predefinito è "false".

Elementi della struttura

Tutti gli elementi in questa sezione accettano un attributo id="stringaidentificatore". Questo attributo è facoltativo per tutti gli elementi. Può essere utilizzato, ad esempio, per nascondere/disabilitare l'intero elemento della disposizione e tutti gli elementi in esso contenuti (vedere capitolo logica della GUI). La stringa dell'ID non può contenere «.» (punto) o «;» (punto e virgola) e generalmente dovrebbe essere limitata a caratteri alfanumerici e al carattere di sottolineatura ("_"). Vengono elencati solo gli attributi aggiuntivi.

<page>

Definisce una nuova pagina all'interno di una procedura guidata. Consentito solo come figlio diretto di un elemento <wizard>.

<row>

Tutti i figli diretti di un tag «row» saranno posizionati da sinistra a destra.

<column>

Tutti i figli diretti di un tag «column» saranno posizionati dall'alto verso il basso.

<stretch>

Per impostazione predefinita, gli elementi nella GUI occupano tutto lo spazio disponibile. Ad esempio, se avete due colonne affiancate, quella di sinistra è piena di elementi, ma quella di destra contiene un <radio> solitario, il controllo <radio> si espanderà verticalmente, anche se in realtà non ha bisogno dello spazio disponibile, e non sarà visivamente gradevole. In questo caso vorrete davvero aggiungere uno «spazio vuoto» sotto l'elemento <radio>. A questo scopo, utilizzate l'elemento <stretch>. Utilizzerà semplicemente un po' di spazio. Non abusare di questo elemento, di solito è una buona idea per gli elementi della GUI per ottenere tutto lo spazio disponibile, solo a volte la disposizione risulterà distanziata. L'elemento <stretch> non accetta argomenti, nemmeno un "id". Inoltre non potete posizionare figli all'interno dell'elemento <stretch> (in altre parole, lo utilizzerete sempre e solo come "<stretch/>")

<frame>

Disegna una cornice/riquadro attorno ai suoi elementi figli diretti. Può essere utilizzato per raggruppare visivamente opzioni correlate. La disposizione all'interno di una cornice è dall'alto verso il basso, a meno che non si inserisca una <row> al suo interno. Attributi:

label

Didascalia per la cornice (facoltativo)

checkable

Le cornici possono essere controllate. In questo caso, tutti gli elementi contenuti saranno disabilitati quando la cornice è deselezionata e abilitata, quando è selezionata. (facoltativo, il valore predefinito è "false")

checked

Solo per cornici verificabili: la cornice dovrebbe essere controllata in modo predefinito? Il valore predefinito è «true». Non interpretato per cornici non controllabili.

<tabbook>

Organizza gli elementi in un tabbook. Accetta solo tag <tab> come figli diretti.

<tab>

Definisce una pagina in un tabbook. Inserisci la definizione GUI per la scheda all'interno di questo tag. Può essere utilizzato solo come figlio diretto di un tag <tabbook>. Un tag <tabbook> deve avere almeno due schede definite. Attributi:

label

Didascalia per la scheda (richiesto)

<text>

Mostra il testo racchiuso in questo tag nella GUI. Alcuni semplici contrassegni HTML di stile sono supportati (in particolare <b>, <i>, <p> e <br/>). Tuttavia, mantenete la formattazione al minimo. L'inserimento di una riga completamente vuota aggiunge un'interruzione di riga. Attributi:

type

Tipo di testo. Uno tra «normale», «avviso» o «errore». Questo influenza l'aspetto del testo (facoltativo, il valore predefinito è normale)

Elementi attivi

Tutti gli elementi in questa sezione accettano un attributo id="identifierstring". Questo attributo è obbligatorio per tutti gli elementi. Sono elencati solo gli attributi aggiuntivi. La stringa id non può contenere «.» (punti).

<varselector>

Fornisce un elenco di oggetti disponibili da cui l'utente può selezionarne uno o più. Richiede uno o più <varslot> come controparte per essere utili. Attributi:

label

Etichetta per il varselector (opzionale, il valore predefinito è «Seleziona variabili»)

<varslot>

Utilizzato insieme a un «varselector» per consentire all'utente di selezionare una o più variabili. Attributi:

label

Etichetta per il varslot (consigliato, il valore predefinito è «Variabile:»)

source

Il varselector da cui prelevare la selezione (obbligatorio, a meno che non ci si connetta manualmente o utilizzando source_property)

source_property

Una proprietà arbitraria da cui copiare i valori, quando si fa clic sul pulsante di selezione. Se specificato, questo sovrascrive l'attributo «source».

required

Se, per l'invio del codice, è necessario che questo varslot contenga un valore valido. Vedere required-property (facoltativo, il valore predefinito è falso)

multi

Se il varslot contiene solo uno (valore predefinito, «falso») o più oggetti

allow_duplicates

Se il varslot può accettare solo oggetti univoci (valore predefinito, «falso») o se lo stesso oggetto può essere aggiunto più volte.

min_vars

Significativo solo se multi="true": numero minimo di variabili da selezionare perché la selezione sia considerata valida (facoltativo, il valore predefinito è «1»)

min_vars_if_any

Significativo solo se multi="true": alcuni varslot possono essere considerati validi, se, ad esempio, il varslot è vuoto o contiene almeno due valori.Questo specifica quante variabili devono essere selezionate se presenti (2 nell'esempio). (facoltativo, il valore predefinito è «1»)

max_vars

Significativo solo se multi="true": numero massimo di variabili da selezionare (facoltativo, il valore predefinito è «0», il che significa che non esiste un massimo)

classes

Se si specifica qui uno o più nomi di classe di R (separati da spazi (« »)), il varslot accetterà solo oggetti appartenenti a quelle classi (facoltativo, usare con grande attenzione, all'utente non dovrebbe essere impedito di fare scelte valide e R ha molte classi diverse)

types

Se si specifica uno o più tipi di variabili (separati da spazi ("")), qui, varslot accetterà solo oggetti di quei tipi. I tipi validi sono "sconosciuto", "numero", "stringa", "fattore", "non valido". (Facoltativo, usalo con grande attenzione, all'utente non dovrebbe essere impedito di fare scelte valide e RKWard non sempre conosce il tipo di una variabile)

num_dimensions

Il numero di dimensioni che deve avere un oggetto. «0» (impostazione predefinita)significa che è accettabile qualsiasi numero di dimensioni. (facoltativo, il valore predefinito è «0»)

min_length

La lunghezza minima che un oggetto deve avere per essere accettabile. (facoltativo, il valore predefinito è «0»)

max_length

La lunghezza massima che un oggetto deve avere per essere accettabile. (facoltativo, il valore predefinito è il numero intero più grande rappresentabile sul sistema)

<valueselector>

Fornisce un elenco di stringhe disponibili (non oggetti di R) da selezionare in uno o più <valueslot> associati. Le opzioni delle stringhe possono essere definite utilizzando i tag <option> come figli diretti (vedere di seguito) oppure impostate utilizzando le proprietà dinamiche. Attributi:

label

Etichetta per il valueselector valori (facoltativo, per impostazione predefinita nessuna etichetta)

<valueslot>

Utilizzato insieme a <valueselector> per consentire all'utente di selezionare uno o più elementi stringa. Questo elemento è pressoché identico a <varslot> e condivide gli stessi attributi, ad eccezione di quelli che fanno riferimento alle proprietà degli elementi accettabili (ad esempio, classi, tipi, num_dimensions, min_length, max_length).

<radio>

Definisce un gruppo di pulsanti radio-esclusivi (è possibile selezionarne solo uno alla volta). Richiede almeno due tag <option> come figli diretti. Non sono consentiti altri tag come figli. Attributi:

label

Etichetta per il controllo radio (consigliato, il valore predefinito è «Seleziona uno:»)

<dropdown>

Definisce un gruppo di opzioni, di cui è possibile selezionarne solo una alla volta, tramite un elenco a tendina. Funziona come un <radio>, ma ha un aspetto diverso. Richiede almeno due tag <option> come figli diretti. Non sono consentiti altri tag come figli. Attributi:

label

Etichetta per l'elenco a tendina (consigliato, il valore predefinito è «Seleziona uno:»)

<select>

Fornisce un elenco di stringhe disponibili da cui l'utente può selezionare un numero arbitrario. Le opzioni delle stringhe possono essere definite utilizzando i tag <option> come figli diretti (vedi sotto) oppure impostate utilizzando le proprietà dinamiche. Attributi:

label

Etichetta per la <select> (facoltativo, per impostazione predefinita nessuna etichetta)

single

Se impostato a vero, sarà selezionabile solo un singolo valore, anziché valori multipli contemporaneamente (booleano, il valore predefinito è false)

<option>

Può essere utilizzato solo come elemento secondario diretto di <radio>, <dropdown>, <valueselector> oppure <select> elemento. Rappresenta un'opzione selezionabile in un controllo radio o in un elenco a tendina. Poiché <opzione> gli elementi fanno sempre parte di uno degli elementi di selezione, normalmente non hanno un «id» proprio, ma vedi sotto. Attributi:

label

Etichetta per l'opzione (richiesto)

value

Il valore della stringa restituito dall'elemento genitore se questa opzione è marcata/selezionata (richiesto)

checked

Indica se l'opzione deve essere marcata/selezionata per impostazione predefinita: "true" o "false". In una <radio> o <dropdown>, solo un'opzione può essere impostata su checked=""true" e se nessuna opzione è impostata su marcata, la prima opzione nell'elemento genitore sarà marcata/selezionata automaticamente. In una <select>, qualsiasi numero di opzioni può essere impostato su selezionato. (facoltativo, predefinito su "falso")

id

Specificando il parametro «id» per gli elementi <opzione> è facoltativo (e infatti è consigliabile non impostare un «id», a meno che non ne sia realmente necessario). Tuttavia, specificando un «id» potrete abilitare/disabilitare le <opzioni>, dinamicamente, collegandoti alla proprietà booleana id_of_radio.id_of_optionX.enabled. Attualmente funziona per le opzioni all'interno di elementi <radio> o <dropdown>, solo; <valueselector> e <select> le opzioni attualmente non supportano gli ID.

<checkbox>

Definisce una casella di controllo, cioè una singola opzione che può essere attivata o disattivata. Attributi:

label

Etichetta per la casella di controllo (obbligatorio)

value

Il valore restituito dalla casella di controllo se selezionato (obbligatorio)

value_unchecked

Il valore che sarà restituito se la casella di controllo non è selezionata (facoltativo, il valore predefinito è "", cioè una stringa vuota)

checked

Se l'opzione dovrebbe essere selezionata in modo predefinito «true» o «false» (opzionale, impostazione predefinita per «false»)

<frame>

L'elemento cornice viene generalmente utilizzato come puro elemento di disposizione ed è elencato nella sezione elementi di disposizione. Tuttavia, può anche essere reso controllabile, agendo così come una semplice casella di controllo allo stesso tempo.

<input>

Definisce un campo di inserimento di testo libero. Attributi:

label

Etichetta per il campo di input (obbligatorio)

initial

Testo iniziale del campo di testo (facoltativo, il valore predefinito è "", cioè una stringa vuota)

size

Uno tra «piccolo», «medio» o «grande». «grande» definisce una campo di inserimento a righe multiple, «piccolo» e «medio» sono campi a riga singola (facoltativo,il valore predefinito è «medio»)

required

Se, per l'invio del codice, è necessario che questo input non sia vuoto. Vedere required-property (facoltativo, il valore predefinito è falso)

<matrix>

Una tabella per l'immissione di dati di matrici (o vettori) nella GUI.

Nota

Questo elemento di input non è ottimizzato per l'immissione/modifica di grandi quantità di dati. Sebbene non vi siano limiti rigorosi alle dimensioni di una <matrice>, in generale non dovrebbe superare una decina di righe / colonne. Se ci si attende dati più grandi, consentire agli utenti di selezionarli come oggetti di R (che potrebbe essere una buona idea come opzione alternativa, in quasi ogni istanza in cui si utilizza un elemento matrice).

Attributi:

label

Etichetta per la tabella (obbligatorio)

mode

Uno tra «intero», «reale» o «stringa». Il tipo di dati che sarà accettato nella tabella (richiesto)

min

Valore minimo accettabile (per matrici di tipo «intero» o «reale»)(facoltativo, il valore predefinito è il più piccolo valore rappresentabile)

max

Valore massimo accettabile (per matrici di tipo «intero» o «reale»)(facoltativo, il valore predefinito è il più grande valore rappresentabile)

allow_missings

Se nella matrice sono consentiti valori mancanti (vuoti). Ciò è implicito per le matrici o la modalità «stringa» (facoltativo, il valore predefinito è falso).

allow_user_resize_columns

Se impostato a vero, l'utente può aggiungere colonne digitando sulle celle più a destra (inattive) (facoltativo, il valore predefinito è true).

allow_user_resize_rows

Se impostato a vero, l'utente può aggiungere righe digitando sulle celle più in basso (inattive) (facoltativo, il valore predefinito è true).

rows

Numero di righe nella matrice. Non ha alcun effetto per allow_user_resize_rows="true".

Nota

Questo può anche essere controllato impostando la proprietà «rows».

(facoltativo, il valore predefinito è 2).

columns

Numero di colonne nella matrice. Non ha alcun effetto per allow_user_resize_columns="true".

Nota

Questo può anche essere controllato impostando la proprietà «columns».

(facoltativo, il valore predefinito è 2).

min_rows

Numero minimo di righe nella matrice. La matrice rifiuterà la riduzione al di sotto di questa dimensione. (facoltativo, il valore predefinito è 0; vedere anche: allow_missings).

min_columns

Numero minimo di colonne nella matrice. La matrice rifiuterà la riduzione al di sotto di questa dimensione. (facoltativo, il valore predefinito è 0; vedere anche: allow_missings).

fixed_height

Forza l'elemento della GUI a rimanere alla sua altezza iniziale. Non utilizzare in combinazione con matrici, in cui il numero di righe può cambiare in qualsiasi modo.Utile, specialmente, durante la creazione di un elemento di input vettoriale (columns="1"). Con questa opzione impostata a vero, non sarà visualizzata alcuna barra di scorrimento orizzontale, anche se la matrice supera la larghezza disponibile (poiché ciò influirebbe sull'altezza). (facoltativo, il valore predefinito è falso).

fixed_width

Leggermente inaccurato: si supponga che il conteggio delle colonne non cambierà. L'ultima (o in genere l'unica) colonna sarà allungata per occupare la larghezza disponibile. Non utilizzare in combinazione con matrici, in cui il numero di colonne può cambiare in qualsiasi modo. Utile, specialmente, durante la creazione di un elemento di ingresso vettoriale (rows="1"). (facoltativo, il valore predefinito è falso).

horiz_headers

Stringhe da utilizzare per l'intestazione orizzontale, separate da «;». L'intestazione sarà nascosta, se impostata su "". (facoltativo, il valore predefinito è il numero di colonna).

vert_headers

Stringhe da utilizzare per l'intestazione verticale, separate da «;». L'intestazione sarà nascosta, se impostata su "". (facoltativo, il numero predefinito è il numero di riga).

<optionset>

Un'interfaccia utente per la ripetizione di un insieme di opzioni per un numero arbitrario di elementi (introduzione agli insiemi di opzioni). Attributi:

min_rows

Se specificato, l'insieme sarà contrassegnato come non valido, a meno che non abbia almeno questo numero di righe (facoltativo, intero).

min_rows_if_any

Come min_rows, ma sarà testato solo se è presente almeno una riga (facoltativo, intero).

max_rows

Se specificato, l'insieme sarà contrassegnato come non valido, a meno che non contenga al massimo questo numero di righe (facoltativo, intero).

keycolumn

ID della colonna per fungere da colonna dei tasti. Un insieme di opzioni con una colonna chiave (valida) fungerà da insieme di opzioni «guidato». Un insieme di opzioni senza colonna chiave consentirà l'inserimento / la rimozione manuale degli articoli. La colonna chiave deve essere contrassegnata come esterna. (facoltativo, il valore predefinito è nessuna colonna dei tasti).

Elementi figli:

<optioncolumn>

Dichiara un'optioncolumn dell'insieme. Per ogni valore che si desidera recuperare dall'insieme di opzioni, è necessario dichiarare una <optioncolumn> separata. Attributi:

id

L'ID dell'optioncolumn (obbligatorio, stringa).

external

Impostato su vero, se l'opzione colonna è controllata dall'esterno dell'insieme di opzioni (facoltativo, booleano, il valore predefinito è false).

label

Se indicato, l'optioncolumn sarà visualizzata in una colonna in base a quell'etichetta (facoltativo, stringa, per impostazione predefinita non è visualizzata).

connect

La proprietà a cui collegare questa colonna di opzioni, fornita come ID all'interno dell'area <content>. Per le <optioncolumn> esterne, il valore corrispondente sarà impostato sul valore impostato esternamente. Per le <optioncolumn> regolari (non esterne), la riga corrispondente della proprietà <optioncolumn> sarà impostata quando la proprietà cambia all'interno dell'area del contenuto. (facoltativo, stringa, il valore predefinito è non connesso).

default

Solo per colonne esterne: il valore da assumere per questa colonna, se non è noto alcun valore per una voce. Raramente utile (Facoltativo, per impostazione predefinita è una stringa vuota)

<content>

Dichiara il contenuto/interfaccia utente dell'insieme. Nessun attributo. Tutti i normali elementi attivi, passivi e di disposizione sono consentiti come elementi childname. Inoltre, nelle versioni precedenti di RKWard (fino alla 0.6.3), lo speciale elemento figlio <optiondisplay> era consentito. Questo è obsoleto in RKWard 0.6.4 e dovrebbe essere semplicemente rimosso dalle estensioni esistenti.

<logic>

Specifica facoltativa della logica dell'interfaccia utente da applicare all'interno dell'area dei contenuti dell'insieme di opzioni. Vedere il riferimento su <logic>

<browser>

Un elemento progettato per selezionare un singolo nome file (o nome di cartella). Notare che questo campo accetterà qualsiasi stringa, anche se è pensato per essere utilizzato solo per i file:

label

Etichetta per il browser (opzionale, il valore predefinito è «Inserisci nome file»)

initial

Testo iniziale del browser (facoltativo, il valore predefinito è "", cioè una stringa vuota)

type

Uno tra «file», «dir» o «savefile». Per selezionare un file esistente, una cartella esistente o un file non esistente, rispettivamente (facoltativo, il valore predefinito è «file»)

allow_urls

Se è possibile selezionare URL (non locali) (facoltativo, il valore predefinito è «false»)

filter

Filtro del tipo di file, ad es. ("* .txt * .csv" per i file .txt e .csv). Viene aggiunta automaticamente una voce separata per «Tutti i file» (facoltativo, valore predefinito "", cioè tutti i file)

required

Se, per l'invio del codice, è necessario che il campo non sia vuoto. Notare che ciò non significa necessariamente che il nome file selezionato sia valido. Vedere required-property (facoltativo, il valore predefinito è true)

<saveobject>

Un elemento progettato per selezionare il nome con cui salvare un oggetto di R (cioè generalmente non già esistente, a differenza di un varslot):

label

Etichetta per l'ingresso (facoltativo, il valore predefinito è «Salva in:»)

initial

Testo iniziale dell'ingresso (facoltativo, il valore predefinito è «my.data»)

required

Se, per l'invio del codice, è necessario che il campo contenga un nome oggetto consentito. Vedere required-property (facoltativo, il valore predefinito è true)

checkable

In molti casi d'uso, salvare in un oggetto di R è facoltativo. In questi casi, una casella di controllo può essere integrata nell'elemento saveobject usando questo attributo. Se impostato a vero, l'oggetto di salvataggio sarà attivato/disattivato dalla casella di controllo. Vedere active-property di saveobject (facoltativo, il valore predefinito è falso)

checked

Solo per gli elementi saveobject controllabili: se il controllo è marcato/abilitato per impostazione predefinita (facoltativo, il valore predefinito è false)

<spinbox>

Una casella di selezione in cui l'utente può selezionare un valore numerico, usando l'inserimento diretto da tastiera o le piccole frecce in su/giù. Attributi:

label

Etichetta per la casella di selezione (consigliato, impostazione predefinita per «Inserisci valore:»)

min

Il valore più basso che l'utente può inserire nella casella di selezione (facoltativo, il valore predefinito è il più basso tecnicamente rappresentabile nella casella di selezione)

max

Il valore più grande che l'utente può inserire nella casella di selezione (facoltativo, il valore predefinito è il più alto tecnicamente rappresentabile nella casella di selezione)

initial

Il valore iniziale mostrato nella casella di selezione (facoltativo, il valore predefinito è «0»)

type

Uno di «reale» o «intero». Se lo casella di selezione accetterà numeri reali o solo numeri interi (facoltativo, il valore predefinito è «reale»)

default_precision

Significativo solo se la casella di selezione è di tipo="real". Specifica il numero predefinito di posizioni decimali visualizzate nella casella di selezione (saranno visualizzati solo questi zeri finali). Quando l'utente preme le frecce in su/giù, questo punto decimale sarà modificato. L'utente può comunque essere in grado di inserire valori con una precisione maggiore (vedere sotto) (facoltativo, il valore predefinito è «2»)

max_precision

Il numero massimo di cifre che possono essere rappresentate in modo significativo (opzionale, il valore predefinito è «8»)

<formula>

Questo elemento avanzato consente all'utente di selezionare una formula/insieme di interazioni dalle variabili selezionate. Ad esempio per un GLM, questo elemento può essere utilizzato per consentire all'utente di specificare i termini di interazione nel modello. Attributi:

fixed_factors

L'ID del varslot contenente i fattori fissi selezionati (richiesto)

dependent

L'ID del varslot che contiene la variabile dipendente selezionata (richiesto)

<embed>

Integrare un'estensione diversa in questa (consultare il capitolo sull'integrazione). Attributi:

component

Il nome registrato del componente da integrare (vedere il capitolo sulla registrazione dei componenti) (obbligatorio)

as_button

Se impostata a «true», solo un pulsante sarà inserito nella GUI di integrazione, la GUI integrata sarà mostrata (in una finestra separata) solo quando si preme il pulsante (opzionale, il valore predefinito è «false»)

label

Significativo solo se as_button="true": l'etichetta del pulsante (si consiglia, l'impostazione predefinita è «Opzioni»)

<preview>

Casella di selezione per attivare o disattivare la funzionalità di anteprima. Notare che, a partire dalla versione 0.6.5 di RKWard, gli elementi di anteprima <preview> sono un caso speciale nelle finestre delle finestre delle estensioni (non nelle procedure guidate): saranno posizionati nella colonna dei pulsanti, indipendentemente da dove sono definiti esattamente nell'interfaccia utente. È comunque una buona idea definirli in una posizione ragionevole della disposizione, per compatibilità con le versioni precedenti. Attributi:

label

Etichetta della casella (opzionale, il valore predefinito è «Anteprima»)

mode

Tipo di anteprima. I tipi supportati sono «grafico» (vedere capitolo sulle anteprime dei grafici), «risultato» (vedere capitolo sulle (HTML) anteprime del risultato), «dati» (vedere anteprime dei dati) e «personalizzata» (vedere anteprime personalizzate). (facoltativo, il valore predefinito è «grafico»)

placement

Posizionamento dell'anteprima: «agganciata» (all'area di lavoro principale), «sganciata» (finestra autonoma), «ancorata» (agganciata alla finestra dell'estensione) e «predefinita» (attualmente è uguale a «ancorata», ma potrebbe diventare configurabile dall'utente a un certo punto). In generale, si consiglia di lasciarla come impostazione predefinita per una migliore coerenza dell'interfaccia utente (facoltativo, il valore predefinito è «predefinita»)

active

Se l'anteprima è attiva in modo predefinito. In generale, solo le anteprime ancorate devono essere rese attive per impostazione predefinita e, anche per queste, c'è un motivo per cui l'impostazione predefinita è l'anteprima inattiva (opzionale, l'impostazione predefinita è «falso»)

Sezione logica

<logic>

L'elemento contenitore per la sezione logica. Tutti gli elementi seguenti sono consentiti solo all'interno dell'elemento <logic>. L'elemento <logic> è consentito solo come elemento figlio diretto dell'elemento <document> (al massimo una volta per documento) o di elementi <optionset> (al massimo una volta per insieme di opzioni). La sezione logica del documento si applica sia alle interfacce <finestra> e <procedura guidata> allo stesso modo.

<external>

Crea una nuova proprietà (stringa) che dovrebbe essere connessa a una proprietà esterna se il l'estensione viene integrata. Vedere la sezione sulle estensioni «incomplete». Attributi:

id

L'ID della nuova proprietà (richiesto)

default

Il valore di stringa predefinito della nuova proprietà, cioè il valore utilizzato, se la proprietà non è connessa a una proprietà esterna (facoltativo, per impostazione predefinita è una stringa vuota)

<i18n>

Crea una nuova proprietà (stringa) che dovrebbe fornire un'etichetta i18n. Attributi:

id

L'ID della nuova proprietà (richiesto)

label

L'etichetta. Questa sarà tradotta. (necessario)

<set>

Imposta una proprietà su un valore fisso (ovviamente, se collega anche la proprietà a qualche altra proprietà, il valore non rimane fisso). Ad esempio, se si incorpora un'estensione, ma si desidera nascondere alcuni dei suoi elementi, potreste impostare la proprietà di visibilità di tali elementi su falso. Utile soprattutto per estensioni incorporate/incorporanti. Nota: se sono presenti più elementi <set> per un singolo id, l'ultimo a essere definito ha la precedenza. A volte sarà utile fare affidamento su questo quando si utilizzano le parti <incluse>. Attributi:

id

'ID della proprietà da impostare (obbligatorio)

to

Il valore di stringa su cui impostare la proprietà (obbligatorio). Nota: per proprietà booleane come visibilità, abilitazione, in genere si imposta l'attributo to a to="true" o a to="false".

<convert>

Crea una nuova proprietà booleana che dipende dallo stato di una o più proprietà diverse. Attributi:

id

L'ID della nuova proprietà (richiesto)

sources

Gli ID delle proprietà da cui dipenderà questa proprietà. Una o più proprietà possono essere specificate, separate da «;» (necessario)

mode

La modalità di conversione/operazione. Uno di «uguale», «non uguale», «intervallo», «e», «o». Se in modalità uguale, la proprietà sarà vera solo se il valore di tutte le sue fonti è uguale all'attributo standard (vedere sotto). Se in modalità non uguale, la proprietà sarà vera solo se il valore di tutte le sue fonti è diverso dallo standard dell'attributo (vedere sotto). Se in modalità intervallo, le fonti devono essere numeriche (intere o reali). La proprietà sarà vera solo se tutte le origini sono nell'intervallo specificato dagli attributi min e max (vedere sotto). Se in modalità e, le fonti devono essere proprietà booleane. La proprietà sarà vera solo se tutte le fonti sono vere contemporaneamente. Se in modalità o, le fonti devono essere proprietà booleane. La proprietà sarà vera solo se almeno una delle fonti è vera. (necessario)

standard

Significativo solo in modalità uguale o nota: il valore stringa da confrontare (richiesto se in una di queste modalità)

min

Significativo solo nell'intervallo di modalità: il valore minimo da confrontare (opzionale, il valore predefinito è il numero in virgola mobile più basso rappresentabile sulla macchina)

max

Significativo solo nell'intervallo di modalità: il valore massimo con cui confrontare (opzionale, il valore predefinito è il più grande numero in virgola mobile rappresentabile sulla macchina)

require_true

Se impostato a "true", la proprietà diventerà obbligatoria e sarà considerata valida solo se il suo stato è true/on. Quindi, se la proprietà è falsa, bloccherà il pulsante Invia (facoltativo, il valore predefinito è "false").

Attenzione

Se lo si utilizza, assicurarsi che l'utente possa facilmente rilevare ciò che è sbagliato, ad esempio mostrando un testo esplicativo.

<switch>

Creare una nuova proprietà che sarà inoltrata a proprietà di destinazione diverse (o stringhe fisse) in base al valore di una proprietà di condizione. Ciò consente di creare logiche simili ai costrutti if() o switch(). Attributi:

id

L'ID della nuova proprietà (richiesto)

condition

L'ID della proprietà «condition» (richiesto)

Elementi figli:

<true>

Se la proprietà di condizione è booleana, è possibile specificare i due elementi secondari <true> e <false> (e solo questi). (Obbligatorio, se viene fornito anche <false>)

<false>

Se la proprietà di condizione è booleana, è possibile specificare i due elementi secondari <true> e <false> (e solo questi). (Obbligatorio, se viene fornito anche <true>)

<case>

Se la proprietà di condizione non è booleana, è possibile fornire un numero arbitrario di elementi <case>, uno per ogni valore della proprietà di condizione che si desidera far corrispondere (almeno uno di questi elementi è richiesto, se la proprietà di condizione non è booleana)

<default>

Se la proprietà di condizione non è booleana, l'elemento facoltativo <default> consente di specificare il comportamento, se nessun elemento <case> corrisponde al valore della proprietà di condizione (opzionale, consentito solo una volta, in combinazione con uno o più elementi <case>).

Gli elementi figlia <true>, <false>, <case> e <default> accettano i seguenti attributi:

standard

Solo per gli elementi <case>: il valore con cui confrontare la proprietà della condizione (richiesto, stringa).

fixed_value

Una stringa fissa che deve essere fornita come valore della proprietà <switch>, se la condizione attuale corrisponde (obbligatorio, se dynamic_value non è fornito).

dynamic_value

L' >id della proprietà di destinazione che dovrebbe essere fornito come valore della proprietà dell'<interruttore>, se la condizione attuale corrisponde (obbligatorio, se fixed_value non viene fornito).

<connect>

Collega due proprietà. La proprietà del client sarà modificata ogni volta che cambia la proprietà governor (ma non viceversa). Attributi:

client

L'ID della proprietà del client, cioè la proprietà che sarà modificata (necessario)

governor

L'ID della proprietà governor, cioè la proprietà che regolerà la proprietà del cliente. Questo può includere un modificatore (richiesto)

reconcile

Se "true", la proprietà client farà regolare la proprietà del governor sulla connessione in modo tale che la proprietà del governor accetti solo valori accettabili anche dal client (ad es. supponiamo che il governor sia una proprietà numerica con valore minimo «0» e il client sia una proprietà numerica con valore minimo «100». Il minimo di entrambe le proprietà sarà regolato su 100, se reconcile="true"). Funziona generalmente solo per proprietà dello stesso tipo di base (facoltativo, predefinito su "false")

<dependency_check>

Crea una proprietà booleana che è vera se le dipendenze specificate sono soddisfatte, falsa altrimenti. La sintassi XML dell'elemento è la stessa dell'elemento <dependencies>, descritto nel manuale .pluginmap. A partire da RKWard 0.6.1, solo le specifiche di versione di RKWard e R vengono prese in considerazione, non le dipendenze dai pacchetti o dalle mappe di estensioni.

<script>

Definire il codice script per controllare la logica dell'interfaccia utente. Vedere la sezione sulla logica GUJI con script per i dettagli. Il codice dello script da eseguire può essere fornito utilizzando l'attributo "file" o come testo (commentato) dell'elemento. L'elemento <script> non è consentito nella sezione <logic> di un insieme di opzioni. Attributi:

file

Nome del file di script. (necessario)