Element att använda i .pluginmap-filer- <document>
Måste finnas i varje
.pluginmap-fil som rotnod (exakt en gång). Egenskaper:- base_prefix
Filnamn angivna i
.pluginmap-filen antas vara relative till katalogen där.pluginmap-filen finns plus det prefix som anges här. Särskilt användbar om alla komponenter är placerade i en enda underkatalog.- namespace
En namnrymd för komponent-identifierare. När komponenter slås upp för inbäddning, går det att hämta komponenterna via strängen "namnrymd::komponent_id". För närvarande satt till "rkward".
- id
En valfri identifierarsträng för din
.pluginmap. Att ange den låter en tredjepartsutvecklare hänvisa till den och läsa in din.pluginmapfrån sin egen (se kapitlet om att hantera beroenden).- priority
Ett av
"hidden","low","medium"eller"high". En.pluginmapmed prioritet "medium" eller "high" aktiveras automatiskt när RKWard först hittar dem. Användpriority="hidden"för en.pluginmapsom inte är avsedd att aktiveras, katalog (bara avsedd för inkludering). I den nuvarande implementeringen döljer det dock inte i själva verket en.pluginmap. (Valfri, med förvalt värde "medium").
- <dependencies>
Elementet, som anger beroenden, tillåts som ett direkt underliggande objekt till elementet <document> (en gång), och som ett underliggande objekt till elementen <component> (en gång för varje <component>). Anger de beroenden som måste uppfyllas för att kunna använda insticksprogrammen. Se kapitlet om beroenden för en översikt. Egenskaper:
- rkward_min_version, rkward_max_version
Minimal och maximal tillåten version av RKWard. Versionsspecifikationer får innehålla icke-numeriska suffix, såsom "0.5.7z-devel1". Om ett angivet beroende inte uppfylls, kommer insticksprogrammen det gäller att ignoreras. Mer information. Valfri. Om ej specificerad krävs ingen minimal eller maximal version av RKWard.
- R_min_version, R_max_version
Minimal och maximal tillåten version av R. Versionsspecifikationer får inte innehålla icke-numeriska suffix, såsom "0.5.7z-devel1". Beroendet av R-version visas på insticksprogrammets hjälpsidor, men har ingen direkt effekt till och med RKWard 0.6.1. Mer information. Valfri, om ej specificerad krävs ingen minimal eller maximal version av R.
Underliggande element:
- <package>
Lägger till ett beroende på ett specifikt R-paket. Egenskaper:
- name
Paketnamn (krävs).
- min_version, max_version
Minimal eller maximal tillåten version (valfri)
- repository
Arkiv där paketet kan hittas. Valfritt, men rekommenderas starkt. Om paketet inte är tillgängligt på CRAN.
- <pluginmap>
Lägger till ett beroende på en specifik RKWard
.pluginmap. Egenskaper:- name
Id-sträng för den
.pluginmapsom krävs (krävs).- min_version, max_version
Minimal eller maximal tillåten version (valfri)
- url
Webbadress där
.pluginmapkan hittas. Krävs.
- <about>
Får finnas exakt en gång som ett direkt underliggande objekt till elementet <document>. Innehåller metainformation om
.pluginmap(eller insticksprogram). Se kapitlet om 'om'-information för en översikt. Egenskaper:- name
Synligt användarnamn. Valfritt. Måste inte vara samma som "id".
- version
Versionsnummer. Valfritt. Formatet är inte begränsat, men för att vara på den säkra sidan, följ vanlig versionsnumrering såsom "x.y.z".
- releasedate
Specifikation av utgivningsdatum. Valfri på formatet "ÅÅÅÅ-MM-DD".
- shortinfo
En kort beskrivning av insticksprogrammet eller
.pluginmap. Valfri.- url
Webbadress där mer information kan finnas. Valfri, men rekommenderad.
- copyright
Specifikation av copyright, t.ex. "2012-2013 av Anna Svensson". Valfri, men rekommenderad.
- licence
Specifikation av licens, t.ex. "GPL" eller "BSD". Försäkra att filerna åtföljs av en fullständig kopia av relevant licens. Valfri, men rekommenderad.
- category
Insticksprogrammens kategori, t.ex. "Item response theory". Från RKWard 0.6.1 är inga kategorier fördefinierade. Valfri.
Underliggande element:
- <author>
Lägger till information om en upphovsman. Egenskaper:
- name, given, family
Ange antingen hela namnet som
name, eller ange bådegiven(förnamn) ochfamily(efternamn) separat.- role
Upphovsmannens rollbeskrivning (valfri).
E-postadress där upphovsmannen kan kontaktas. Krävs. Kan sättas till e-postlistan rkward-devel, om du prenumererar, och ditt insticksprogram är avsett att inkluderas i den officiella utgåvan av RKWard.
- url
Webbadress med mer information om upphovsmannen, t.ex. hemsida (valfri).
- <components>
Måste finnas exakt en gång som ett direkt underliggande objekt till elementet <document>. Innehåller de individuella elementen <component> som beskrivs nedan. Inga egenskaper.
- <component>
En eller flera element av typen <component> ska anges som direkt underliggande objekt till elementen <components> (och bara där). Registrerar en komponent eller ett insticksprogram i rkward. Egenskaper:
- type
För framtida utökningar: Typ av komponent eller insticksprogram. För tillfället alltid satt till "standard" (den enda typ som för närvarande stöds).
- id
Det id som kan användas för att hämta komponenten (för att placera den i menyn, se nedan, eller för inbäddning). Se namnrymden <document> ovan.
- file
Krävs åtminstone för komponenter av type="standard": Filnamnet på XML-filen som beskriver det grafiska användargränssnittet.
- label
Komponentens rubrik när den placeras i menyhierarkin.
- <attribute>
Definierar en egenskap för en komponent. Hittills bara meningsfull för importinsticksprogram. Bara tillåten som ett direkt underliggande objekt till <component>. Egenskaper:
- id
Egenskapens id
- value
Egenskapens värde
- labels
Rubrik som hör ihop med egenskapen
- <hierarchy>
Måste finnas exakt en gång som ett direkt underliggande objekt till elementet <document>. Beskriver var komponenten som deklareras ovan ska placeras i menyhierarkin. Accepterar bara <menu>-element som direkt underliggande objekt. Inga egenskaper.
- <menu>
Ett eller flera menyelement, <menu>, ska anges som direkt underliggande objekt till elementet <hierarchy>. Deklarerar en ny (under-)meny. Om en meny med angivet id (se nedan) redan finns, sammanfogas de två menyerna. Elementet <menu> tillåts antingen som ett direkt underliggande objekt till elementet <hierarchy> (toppnivåmeny) eller som ett direkt underliggande objekt till någon annan <menu> (undermeny). Omvänt, accepterar elementet <menu> andra <menu> eller <entry> som underliggande objekt. Egenskaper:
- id
En identifierarsträng för menyn. Användbar när menydefinitioner läses från flera
.pluginmap-filer, för att försäkra att insticksprogram kan placeras i samma meny eller menyer. Vissa menyidentifierare såsom "file" refererar till fördefinierade menyer (i detta fall, menyn "Arkiv"). Var noga med att kontrollera befintliga.pluginmap-filer för att använda överensstämmande identifierare.- label
En rubrik för menyn.
- group
Gör det möjligt att bestämma menyalternativens ordning. Se gruppering av menyalternativ. Valfri.
- <entry>
En menypost, dvs. ett menyalternativ för att starta ett insticksprogram. Kan bara användas som ett direkt underliggande objekt till elementet <menu>, accepterar inga underliggande element. Egenskaper:
- component
Id för komponenten som ska anropas när menyalternativet aktiveras.
- group
Gör det möjligt att bestämma menyalternativens ordning. Se gruppering av menyalternativ. Valfri.
- <group>
Deklarerar en grupp av objekt i menyn. Se gruppering av menyalternativ. Egenskaper:
- id
Namnet på den här gruppen.
- separated
Valfritt. Om det sätts till "true" är objektet i gruppen visuellt avskilt från omgivande objekt.
- group
Namnet på gruppen som den här gruppen ska läggas till sist i (valfri).
- <context>
Deklarerar posterna i ett context. tillåts bara som direkt underliggande objekt till noden <document>. Accepterar bara <menu>-taggar som direkt underliggande objekt. Egenskaper:
- id
Sammanhangets id. Hittills är bara två sammanhang implementerade: "xll" och "import".
- <require>
Inkludera en annan
.pluginmap-fil. Denna.pluginmap-fil läses bara in en gång, även om den krävs från flera andra filer med <require>. Det viktigaste användarfallet är att inkludera en pluginmap-fil som deklarerar några komponenter, som inbäddas av komponenter i denna.pluginmap. Elementen <require> tillåts bara som direkt underliggande objekt till noden <document>. Egenskaper:- file
Filnamnet för den
.pluginmapsom ska inkluderas. Det betraktas som relativt till katalogen för den aktuella.pluginmap-filen plus base_prefix (se ovan för elementet <document>). Om den relativa sökvägen till den.pluginmapsom ska inkluderas inte är känd, använd istället egenskapenmapför att referera till den enligt id.- map
För att inkludera en
.pluginmap-fil från ett annat paket (eller en RKWard.pluginmapfrån din externa.pluginmap), som kan refereras till mednamespacename::id, som angivet i elementet <document> som krävs för denna.pluginmap. Inkluderingen misslyckas om ingen.pluginmapmed detta id är känd, t.ex. inte är installerad på användarens system). Metoden bör bara användas för att inkludera en.pluginmaputanför ditt paket. För de som är inne i ditt paket, är en relativ sökväg snabbare och tillförlitligare (egenskapenfile).