Introduktion till att skriva insticksprogram för RKWard

Thomas Friedrichsmeier

Meik Michalke

Översättare: Stefan Asserhäll
Revision 0.7.4 (2022-04-24)

Det här är en handledning för att skriva insticksprogram i RKWard.


Innehållsförteckning

1. Inledning
2. Förberedelse: Vad är insticksprogram i RKWard? Hur fungerar de?
3. Skapa menyalternativ
Bestämma menyalternativens ordning
4. Definiera det grafiska användargränssnittet
Definiera en dialogruta
Lägga till ett guidegränssnitt
Några hänsynstaganden vid konstruktion av det grafiska användargränssnittet
<radio> mot <checkbox> mot <dropdown>
5. Generera R-kod från inställningar i det grafiska användargränssnittet
Använda JavaScript i RKWard-insticksprogram
preprocess()
calculate()
printout()
Konventioner, principer och bakgrund
Förstå omgivningen local()
Kodformatering
Hantera komplexa alternativ
Tips och trick
6. Skriva en hjälpsida
7. Logisk interaktion mellan element i det grafiska användargränssnittet
Logik för grafiskt användargränssnitt
Skriptbaserad logik för det grafiskt användargränssnittet
8. Inbädda insticksprogram i insticksprogram
Användarfall för inbäddning
Inbäddning inne i en dialogruta
Kodgenerering vid inbäddning
Inbäddning inne i en guide
Mindre inbäddad inbäddning: Knappen Ytterligare alternativ
Inbädda eller definiera ofullständiga insticksprogram
9. Hantera många liknande insticksprogram
Översikt av olika tillvägagångssätt
Använda JS include-sats
Inkludera .xml-filer
Använda <snippets>
<include> och <snippets> mot <embed>
10. Koncept för användning i specialiserade insticksprogram
Insticksprogram som skapar ett diagram
Rita ett diagram i utmatningsfönstret
Lägga till funktionalitet för förhandsgranskning
Generella diagramalternativ
Ett standardexempel
Förhandsgranskningar av data, utmatning och andra resultat
Förhandsgranskning av (HTML-)utmatning
Förhandsgranskningar av (importerad) data
Anpassade förhandsgranskningar
Sammanhangsberoende insticksprogram
X11-enhetssammanhang
Importdatasammanhang
Begära information från R
Referera till det aktuella objektet eller aktuella filen
Repetera (ett antal) alternativ
"Drivna" optionsets
Alternativ: När optionsets inte ska användas
11. Hantera beroenden och kompatibilitetsfrågor
RKWard versionskompatibilitet
Kompatibilitet med R-version
Beroenden av R-paket
Beroenden av andra RKWard .pluginmap
Ett exempel
12. Översättning av insticksprogram
Allmänna hänsynstaganden
i18n i RKWards XML-filer
i18n i RKWards JS-filer och sektioner
i18n och citationstecken
Underhåll av översättningar
Skriva översättningar för insticksprogram
13. Information om upphovsman, licens och version
14. Dela med dig av ditt arbete med andra
Externa insticksprogram
Varför externa insticksprogram?
Strukturen hos ett insticksprogrampaket
Filhierarki
Bygga insticksprogrampaketet
15. Utveckling av insticksprogram med paketet rkwarddev
Översikt
Praktiskt exempel
Beskrivning av det grafiska användargränssnittet
JavaScript-kod
Insticksavbildning
Hjälpsida
Generera insticksprogrammets filer
Hela skriptet
Lägga till hjälpsidor
Översätta insticksprogram
A. Referens
Typer av egenskaper och modifierare
Element för allmänna syften att använda i vilken XML-fil som helst (.xml, .rkh, .pluginmap)
Element att använda i insticksprogrammets XML-beskrivning
Allmänna element
Gränssnittsdefinitioner
Layoutelement
Aktiva element
Logiksektion
Egenskaper för element i insticksprogram
Inbäddningsbara insticksprogram som levereras med den officiella utgåvan av RKWard
Element att använda i .pluginmap-filer
Element att använda i .rkh-filer (hjälp)
Funktioner tillgängliga för att skriva skriptlogik för grafiska användargränssnitt
B. Felsökning under utveckling av insticksprogram
C. Licens