Introducció a l'escriptura de connectors per al RKWard

Friedrichsmeier, Thomas

Michalke, Meik

Traductor: Josep M. Ferrer
revisió 0.7.4 (24 d'abril de 2022)

Aquesta és una guia a l'escriptura de connectors per al RKWard.


Sumari

1. Introducció
2. Preliminars: Què són els connectors en el RKWard? Com funcionen?
3. Creació d'entrades del menú
Control de l'ordre de les entrades del menú
4. Definir la IGU
Definir un diàleg
Afegir una interfície assistent
Algunes consideracions sobre el disseny de la IGU
<radio>, <checkbox> i <dropdown>
5. Generació de codi R a partir de la configuració de la IGU
Ús del JavaScript en els connectors del RKWard
preprocess()
calculate()
printout()
Convencions, polítiques i coneixement general
Entendre l'entorn local()
Format del codi
Tractament amb opcions complexes
Consells i trucs
6. Escriure una pàgina d'ajuda
7. Interaccions lògiques entre elements de la IGU
Lògica de la IGU
Lògica de la IGU amb scripts
8. Incrustar connectors en connectors
Casos d'ús per a incrustar
Incrustació dins d'un diàleg
Generació de codi en incrustar
Incrustació dins d'un assistent
Incrustació menys incrustada: botó d'opcions addicionals
Incrustació/definició de connectors incomplets
9. Tractament amb molts connectors similars
Vista general de diferents enfocaments
Ús de la sentència «include» del JS
Incloure els fitxers .xml
Ús de <snippets>
<include> i <snippets> vs. <embed>
10. Conceptes per a utilitzar en connectors especialitzats
Connectors que produeixen un diagrama
Dibuixar un diagrama a la finestra de sortida
Afegir la funcionalitat de vista prèvia
Opcions genèriques de diagrama
Un exemple canònic
Vistes prèvies de dades, sortida i altres resultats
Vistes prèvies de sortida (HTML)
Vistes prèvies de dades (importades)
Vistes prèvies personalitzades
Connectors dependents de context
Context de dispositiu X11
Importar el context de les dades
Consultar l'R per a obtenir informació
Referenciar l'objecte actual o el fitxer actual
Repetir (un conjunt d') opcions
«Driven» «optionsets»
Alternatives: quan no s'usen els «optionsets»
11. Gestió de dependències i problemes de compatibilitat
Compatibilitat de la versió del RKWard
Compatibilitat de la versió de l'R
Dependències de paquets de l'R
Dependències d'altres RKWard .pluginmaps
Un exemple
12. Traduccions d'un connector
Consideracions generals
«i18n» als fitxers «xml» del RKWard
«i18n» als fitxers i seccions dels fitxers «js» del RKWard
«i18n» i cometes
Manteniment d'una traducció
Escriure traduccions d'un connector
13. Autor, llicència i informació de la versió
14. Compartiu el vostre treball amb altres persones
Connectors externs
Per què connectors externs?
Estructura d'un paquet de connector
Jerarquia de fitxers
Construcció del paquet del connector
15. Desenvolupament de connectors amb el paquet rkwarddev
Vista general
Exemple pràctic
Descripció de la IGU
Codi JavaScript
Mapa de connectors
Pàgina d'ajuda
Generació dels fitxers del connector
L'script complet
Afegir pàgines d'ajuda
Connectors de traducció
A. Referència
Tipus de propietats/Modificadors
Elements de propòsit general que s'utilitzaran en qualsevol fitxer XML (.xml,.rkh, .pluginmap)
Elements a utilitzar en la descripció XML del connector
Elements generals
Definicions d'interfície
Elements de disposició
Elements actius
Secció de lògica
Propietats dels elements del connector
Connectors incrustables distribuïts amb la versió oficial del RKWard
Elements que s'utilitzaran en els fitxers .pluginmap
Elements per a utilitzar en fitxers .rkh (ajuda)
Funcions disponibles per a la creació de scripts de lògica de la IGU
B. Resolució de problemes durant el desenvolupament del connector
C. Llicència