Elementi da utilizzare nei file di .pluginmap

<document>

Deve essere presente in ogni file di .pluginmap come nodo radice (esattamente una volta). Attributi:

base_prefix

Nomi file specificati nella .pluginmap si presume che il file sia relativo alla cartella dei file di .pluginmap + il prefisso specificato qui. Utile, in particolare, se tutti i componenti si trovano sotto una singola sottocartella.

namespace

Uno spazio dei nomi per gli ID dei componenti. Quando si cercano componenti per l'integrazione, i componenti saranno recuperabili tramite una stringa «namespace::id_componente». Impostare su «rkward» per ora.

id

Una stringa identificativa facoltativa per questa .pluginmap. Specificando questa opzione, i terzi autori possono fare riferimento e caricare la vostra .pluginmap dalle loro (vedere il capitolo sulla gestione delle dipendenze

priority

Uno tra "nascosto", "basso", "medio" o "alto". I .pluginmap con priorità "media" o "alta" vengono attivati ​​automaticamente quando RKWard li trova. Usare priority="hidden" per i .pluginmap che non devono essere attivati, la cartella (destinati solo all'inclusione). Tuttavia, nell'attuale implementazione questo in realtà non nasconde il .pluginmap. (Facoltativo, il valore predefinito è "medio").

<dependencies>

Questo elemento, che specifica le dipendenze, è consentito come figlio diretto dell'elemento <document> (una volta) e come elemento figlio di elementi <component> (una volta per ogni elemento <component>). Specificare le dipendenze che devono essere soddisfatte per poter utilizzare le estensioni. Vedere il capitolo sulle dipendenze per una panoramica. Attributi:

rkward_min_version, rkward_max_version

Versione minima e massima consentita di RKWard. Le specifiche della versione possono includere suffissi non numerici, come «0.5.7z-devel1». Se una dipendenza specificata non viene soddisfatta, le estensioni che si applicano a saranno ignorate. Ulteriori informazioni. Facoltativo; se non specificato, nessuna versione minima / massima di RKWard sarà richiesta.

R_min_version, R_max_version

Versione minima e massima consentita di R. Le specifiche di versione possono non includere suffissi non numerici, come «0.5.7z-devel1». La dipendenza della versione di R sarà mostrata nelle pagine della guida delle estensioni, ma non ha alcun effetto diretto, a partire da RKWard 0.6.1. Ulteriori informazioni. Opzionale; se non specificato, nessuna versione minima / massima di R sarà richiesta.

piattaforme

Piattaforme in cui questa estensione è disponibile. I valori supportati sono "unix", "windows", "macos", "qualsiasi" e combinazioni separate da due punti (ad esempio "unix:macos"). "unix" include qualsiasi variante Linux e BSD, ma non MacOS. Se la vostra estensione non dipende dalla piattaforma, omettete semplicemente questo attributo.

Elementi figli:

<package>

Aggiunge una dipendenza da uno specifico pacchetto di R. Attributi:

name

Nome del pacchetto (richiesto).

min_version, max_version

Versione minima / massima consentita (facoltativo).

repository

Deposito in cui è possibile trovare il pacchetto. Facoltativo, ma altamente consigliato, se il pacchetto non è disponibile su CRAN.

<pluginmap>

Aggiunge una dipendenza da una specifica .pluginmap di RKWard. Attributi:

name

Stringa ID della .pluginmap richiesta (necessario).

min_version, max_version

Versione minima / massima consentita (facoltativo).

url

URL dove può essere trovata la .pluginmap. Necessario.

<about>

Può essere presente esattamente una volta come figlio diretto dell'elemento <document>. Contiene meta informazioni sulla .pluginmap (o estensione). Vedere il capitolo su «informazioni» per una panoramica. Attributi:

name

Nome visibile dell'utente. Facoltativo. Non deve essere uguale a «id».

version

Numero della versione. Facoltativo. Il formato non è limitato, ma per essere al sicuro, segui gli schemi di versione comuni come «x.y.z».

releasedate

Specifica della data di rilascio. Facoltativo nel formato «AAAA-MM-GG».

shortinfo

Una descrizione breve dell'estensione / .pluginmap. Facoltativo.

url

URL dove è possibile trovare ulteriori informazioni. Facoltativo, ma consigliato.

copyright

Specifiche del copyright, ad es. "2012-2013 di Mario Rossi". Facoltativo, ma consigliato.

licence

Specifiche della licenza, ad es. «GPL» o «BSD». Assicurarsi di accompagnare i propri file con una copia completa della relativa licenza. Facoltativo, ma consigliato.

category

Categoria di estensione, ad es. «Teoria della risposta dell'item». A partire da RKWard 0.6.1, nessuna categoria è predefinita. Facoltativo.

Elementi figli:

<author>

Aggiunge informazioni su un autore. Attributi:

nome, nome proprio, cognome

Specificare il nome completo per nome o specificare sia nome proprio che cognome, separatamente.

ruolo

Descrizione del ruolo dell'autore (facoltativo).

posta elettronica

Indirizzo di posta elettronica, dove è possibile contattare l'autore. Necessario. Può essere impostato alla lista di distribuzione rkward-devel, se si è iscritti, e la propria estensione è pensata per essere inclusa nella versione ufficiale di RKWard.

url

URL con ulteriori informazioni sull'autore, ad es. pagina principale (facoltativo).

<components>

Deve essere presente esattamente una volta come figlio diretto dell'elemento <document>. Contiene i singoli elementi <component> descritti di seguito. Nessun attributo.

<component>

Uno o più elementi <component> dovrebbero essere dati come figli diretti dell'elemento <component> (e solo lì). Registra un componente/estensione con rkward. Attributi:

type

Per future estensioni: il tipo di componente/estensione. Sempre impostato su «standard» per ora (l'unico tipo attualmente supportato).

id

L'ID con cui è possibile recuperare questo componente (per posizionarlo nel menu (vedere di seguito) o per integrarlo). Vedere lo spazio dei nomi <document> sopra.

file

Richiesto almeno per i componenti di tipo="standard": il nome del file XML che descrive la GUI.

label

L'etichetta per questo componente, quando inserito nella gerarchia dei menu.

facoltativo

Significativo solo per componenti con dipendenze definite: solitamente è considerato un errore segnalabile se un componente non è compatibile con questa versione di RKWard. Tuttavia, se il componente non è realmente necessario nell'ambiente attuale, l'impostazione di questo attributo su "true" sopprime qualsiasi avviso ("false" per impostazione predefinita).

<attribute>

Definisce un attributo di un componente. Finora solo significativo per le estensioni di importazione. Consentito solo come figlio diretto di <component>. Attributi:

id

ID dell'attributo

value

Valore dell'attributo

labels

Etichetta associata all'attributo

<hierarchy>

Deve essere presente esattamente una volta come figlio diretto dell'elemento <document>. Descrive dove i componenti dichiarati sopra devono essere collocati nella gerarchia dei menu. Accetta solo elementi <menu> come figli diretti. Nessun attributo.

<menu>

Uno o più <menu> dovrebbero essere forniti come figli diretti dell'elemento <hierarchy>. Dichiarare un nuovo (sotto)menu. Se esiste già un menu con l'ID specificato (vedi sotto), i due menu vengono uniti. Il <menu> è consentito come elemento figlio diretto dell'elemento <hierarchy> (menu di livello superiore) o come elemento secondario diretto in qualsiasi altro elemento <menu> elemento (sottomenu). Al contrario, il menu <menu> accetta altri elementi <menu> o elementi <entry> come figli. Attributi:

id

Una stringa identificativa del menu. Utile, quando vengono lette le definizioni dei menu da diversi file di .pluginmap, per assicurarsi che le estensioni possano essere inserite negli stessi menu. Alcuni ID di menu come «file» si riferiscono a menu predefiniti (in questo caso il menu «File»). Assicurarsi di controllare con i file di .pluginmap esistenti per utilizzare ID coerenti.

label

Un'etichetta per il menu.

group

Consente di controllare l'ordinamento delle voci di menu. Vedere ordinamento delle voci di menu. Facoltativo.

<entry>

Una voce di menu, cioè un'opzione di menu per invocare un'estensione. Può essere utilizzata solo come figlia diretta di un elemento di menu, non accetta elementi figlio. Attributi:

component

L'ID del componente che deve essere richiamato quando viene attivata questa voce di menu.

group

Consente di controllare l'ordinamento delle voci di menu. Vedere ordinamento delle voci di menu. Facoltativo.

<group>

Dichiara un gruppo di voci nel menu. Vedere ordinamento delle voci di menu. Attributi:

id

Il nome di questo gruppo.

separated

Facoltativo. Se impostata su «vero», l'elemento in questo gruppo sarà separato visivamente dagli elementi circostanti.

group

Il nome del gruppo a cui aggiungere questo gruppo (facoltativo).

<context>

Dichiara le voci in un contesto. Consentito solo come figlio diretto del tag <document>. Accetta solo tag <menu> come figli diretti. Attributi:

id

L'ID del contesto. Finora sono stati implementati solo due contesti: «x11» e «import».

<require>

Includere un altro file .pluginmap. Questo file .pluginmap viene caricato una sola volta, anche se è <require> da diversi altri file. Il caso d'uso più importante è includere un file pluginmap, che dichiara alcuni componenti, che sono incorporati dai componenti dichiarati in questo .pluginmap. Gli elementi <require> sono consentiti solo come figli diretti del nodo <document>. Attributi:

file

Il nome del file della .pluginmap da includere. Questo è visto in relazione alla cartella dell'attuale file di .pluginmap + il prefisso_base (vedere sopra, elemento <document>). Se non si conosce il percorso relativo alla .pluginmap da includere, usare invece l'attributo map per fare riferimento ad esso tramite ID.

map

Per includere un file .pluginmap da un pacchetto diverso (o un file .pluginmap di RKWard dal proprio file .pluginmap esterno), è possibile farvi riferimento tramite il suo namespacename::id, come specificato nell'elemento <document> del file .pluginmap richiesto. L'inclusione non riuscirà se non è noto alcun file .pluginmap con quell'ID (ad esempio, non installato sul sistema dell'utente). Si dovrebbe usare questo metodo solo per includere file .pluginmap esterni al proprio pacchetto. Per le mappe interne al pacchetto, specificare un percorso relativo (attributo file) è più veloce e affidabile.