Elements que s'utilitzaran en els fitxers .pluginmap- <document>
Cal que estigui present a cada fitxer
.pluginmapcom a node arrel (exactament una vegada). Atributs:- base_prefix
Els noms de fitxer especificats al fitxer
.pluginmaps'assumeixen que són relatius al directori del fitxer.pluginmap+ el prefix que especifiqueu aquí. Especialment útil si tots els vostres components es troben sota un únic subdirectori.- namespace
Un espai de noms ("namespace") per als identificadors dels components. Quan se cerquin components per a incrustar-los, els components es podran recuperar mitjançant una cadena "namespace::component_id". Establert a "rkward" per ara.
- id
Una cadena d'identificador opcional per a aquest
.pluginmap. Especificar això permet als autors tercers referir-se i carregar el vostre.pluginmapdes del seu (vegeu el capítol sobre la gestió de les dependències).- priority
Un d'entre
"hidden","low","medium", o"high". Els.pluginmapamb prioritat «medium» o «high» s'activen automàticament quan el RKWard els troba per primera vegada. Utilitzeupriority="hidden"per als.pluginmapque no estan destinats a ser activats, el directori (només per a la inclusió). En la implementació actual això no oculta realment el.pluginmap. (Opcional, el valor predeterminat és "medium").
- <dependencies>
Aquest element, especificant dependències, es permet com a fill directe de l'element <document> (un cop), i com a fill dels elements <component> (un cop per a cada element <component>). Especifica les dependències que s'han de complir per a utilitzar els connectors. Consulteu el capítol sobre dependències per a una visió general. Atributs:
- rkward_min_version, rkward_max_version
Versió mínima i màxima permesa del RKWard. Les especificacions de versió poden incloure sufixos no numèrics, com "0.5.7z-devel1". Si no es compleix una dependència especificada, el/s connector/s al/s que s'aplica s'ignorarà. Més informació. Opcional; si no s'especifica, no es requerirà cap versió mínima/màxima del RKWard.
- R_min_version, R_max_version
Versió mínima i màxima permesa de l'R. Les especificacions de versió poden no incloure sufixos no numèrics, com "0.5.7z-devel1". La dependència de la versió de l'R es mostrarà a les pàgines d'ajuda dels connectors, però no té cap efecte directe, a partir del RKWard 0.6.1. Més informació. Opcional; si no s'especifica, no es requerirà cap versió mínima/màxima de l'R.
Elements fills:
- <package>
Afegeix una dependència d'un paquet R específic. Atributs:
- name
Nom del paquet (requerit).
- min_version, max_version
Versió mínima/màxima permesa (opcional).
- repository
Dipòsit on es troba el paquet. Opcional, però molt recomanat, si el paquet no està disponible al CRAN.
- <pluginmap>
Afegeix una dependència d'un
.pluginmapespecífic del RKWard. Atributs:- name
Cadena d'«id» del connector
.pluginmaprequerit (requerit).- min_version, max_version
Versió mínima/màxima permesa (opcional).
- url
URL on es pot trobar el
.pluginmap. Requerit.
- <about>
Pot estar present exactament una vegada com a fill directe de l'element <document>. Conté la metainformació sobre el
.pluginmap(o connector). Consulteu el capítol sobre la informació «about» per a obtenir una visió general. Atributs:- name
Nom visible de l'usuari. Opcional. No ha de ser el mateix que "id".
- version
Número de versió. Opcional. El format no està restringit, però per a estar sobre segur, seguiu esquemes de versions habituals com ara "x.y.z".
- releasedate
Especificació de data de publicació. Opcional en format "AAAA-MM-DD".
- shortinfo
Una descripció curta del connector/
.pluginmap. Opcional.- url
URL a on es pot trobar més informació. Opcional, però recomanat.
- copyright
Especificació del copyright, p. ex., "2012-2013 de John Doe". Opcional, però recomanat.
- licence
Especificació de la llicència, p. ex., «GPL» o «BSD». Assegureu-vos d'acompanyar els fitxers amb una còpia completa de la llicència corresponent. Opcional, però recomanat.
- category
Categoria del/s connector/s, p. ex., «Teoria de resposta d'elements». A partir del RKWard 0.6.1, no hi ha categories predefinides. Opcional.
Elements fills:
- <author>
Afegeix informació sobre un autor. Atributs:
- name, given, family
Especifiqueu el nom complet per al
name, o especifiqueu ambdósgivenifamily, per separat.- role
Descripció del rol de l'autor (opcional).
L'adreça de correu electrònic on es pot contactar amb l'autor. Requerida. Es pot establir a la llista de correu rkward-devel, si esteu subscrit, i el vostre connector està destinat a ser inclòs en la versió oficial del RKWard.
- url
L'URL amb més informació sobre l'autor, p. ex., la pàgina web (opcional).
- <components>
Necessita estar present exactament una vegada com a fill directe de l'element <document>. Conté els elements individuals <component> descrits a continuació. Sense atributs.
- <component>
Un o més elements <component> s'han de donar com a fills directes de l'element <components> (i només allà). Registra un component/plugin amb el «rkward». Atributs:
- type
Per a futures extensions: el tipus de component/connector. S'estableix sempre a «standard» per ara (l'únic tipus admès actualment).
- id
L'ID pel qual es pot recuperar aquest component (per a col·locar-lo al menú (vegeu a sota), o per a incrustar). Vegeu l'espai de noms <document> a dalt.
- file
Requerit almenys pels components de type="standard": el nom del fitxer XML que descriu la IGU.
- label
L'etiqueta d'aquest component, quan es col·loca a la jerarquia del menú.
- <attribute>
Defineix un atribut d'un component. Només té sentit per a connectors d'importació fins ara. Només es permet com a fill directe de <component>. Atributs:
- id
Id de l'atribut
- value
Valor de l'atribut
- labels
Etiqueta associada amb l'atribut
- <hierarchy>
Necessita estar present exactament una vegada com a fill directe de l'element <document>. Descriu on s'han de col·locar els components declarats a dalt a la jerarquia del menú. Accepta només elements <menu> com a fills directes. Sense atributs.
- <menu>
Un o més elements <menu> s'han de donar com a fills directes de l'element <hierarchy>. Declara un (sub)menú nou. Si ja existeix un menú amb l'ID indicat (vegeu més avall), els dos menús es fusionen. Es permet l'element <menu> com a fill directe de l'element <hierarchy> (menú de nivell superior), o com a fill directe en qualsevol altre element <menu> (menú inferior). Per contra, l'element <menu> accepta altres elements <menu> o <entry> com a elements fills. Atributs:
- id
Una cadena d'identificació del menú. Útil quan les definicions del menú es llegeixen des de diversos fitxers del
.pluginmap, per a assegurar-se que els connectors es poden col·locar en el mateix menú. Alguns identificadors de menú com ara «file» es refereixen a menús predefinits (en aquest cas el menú «File»). Assegureu-vos de comprovar amb els fitxers existents del.pluginmapper a utilitzar ID coherents.- label
Una etiqueta per al menú.
- group
Permet controlar l'ordenació de les entrades del menú. Vegeu ordenació d'elements del menú. Opcional.
- <entry>
Una entrada de menú, és a dir, una opció de menú per a invocar un connector. Només es pot utilitzar com a fill directe d'un element <menu>, no accepta elements fills. Atributs:
- component
L'ID del component que s'ha d'invocar quan s'activa aquesta entrada del menú.
- group
Permet controlar l'ordenació de les entrades del menú. Vegeu ordenació d'elements del menú. Opcional.
- <group>
Declara un grup d'elements al menú. Vegeu ordenació d'elements del menú. Atributs:
- id
El nom d'aquest grup.
- separated
Opcional. Si s'estableix a «true» (cert), l'element d'aquest grup se separarà visualment dels elements circumdants.
- group
El nom del grup al qual afegir aquest grup (opcional).
- <context>
Declara les entrades en un context. Només es permet com a fill directe de l'etiqueta <document>. Només accepta etiquetes <menu> com a filles directes. Atributs:
- id
L'ID del context. Fins ara només s'han implementat dos contextos: "x11" i "import".
- <require>
Incloure un altre fitxer
.pluginmap. Aquest fitxer.pluginmapnomés es carregarà una vegada, encara que sigui <require> des de diversos fitxers. El cas d'ús més important és incloure un fitxer «pluginmap», el qual declara alguns components que estan incrustats pels components declarats en aquest.pluginmap. Només es permeten els elements <require> com a fills directes del node <document>. Atributs:- file
El nom del fitxer del
.pluginmapa incloure. Això es veu en relació amb el directori del fitxer.pluginmapactual + el base_prefix (vegeu més amunt l'element <document>). Si no coneixeu el camí relatiu al.pluginmapque s'ha d'incloure, utilitzeu l'atributmapper a referir-vos a ell per ID.- map
Per a incloure un fitxer
.pluginmapdes d'un paquet diferent (o un.pluginmapdel RKWard des del vostre.pluginmapextern), podeu referir-vos a ell pel seunamespacename::id, com s'especifica en l'element <document> necessari del.pluginmap. La inclusió fallarà si no es coneix cap.pluginmapper aquest identificador (p. ex., no està instal·lat en el sistema de l'usuari). Hauríeu d'utilitzar aquest mètode per a incloure els.pluginmapfora del paquet, només. Per als mapes dins del paquet, especificar un camí relatiu (l'atributfile) és més ràpid i més fiable.