Elementen voor gebruik in .pluginmap-bestanden- <document>
Moet in elk
.pluginmap-bestand aanwezig zijn als de root-node (precies een keer). Attributen:- base_prefix (basis voorvoegsel)
Bestandsnamen opgegeven in het
.pluginmap-bestand worden relatief aangenomen ten opzichte van de directory van het.pluginmap-bestand + het voorvoegsel dat u hier opgeeft. Nuttig, vooral indien al uw componenten onder een enkele subdirectory zijn geplaatst.- namespace (onvertaalbaar, naamruimte)
Een namespace voor de component-ids (componentnamen). Wanneer bij inbedding de componenten worden gezocht, worden die vindbaar via een string "namespace::component_id". Stel dit voorlopig in op "rkward".
- id
Een optionele identificatiestring voor deze
.pluginmap. Dit opgeven maakt het mogelijk dat derde auteurs naar deze.pluginmapkunnen verwijzen en die kunnen inlezen vanuit die van hun (zie hoofdstuk voor omgaan met dependencies).- prioriteit (voorrang)
Een van
"hidden"(verborgen, niet zichtbaar),"low"(laag),"medium"(midden), of"high"(hoog)..pluginmaps met "medium" of "high" priority worden automatisch actief gemaakt, op de plek waar RKWard ze de eerste keer vindt. Gebruikpriority="hidden"voor.pluginmaps die niet actief mogen worden, directory (?) (alleen bedoeld voor insluiten). Maar in de huidige implementatie wordt hierdoor de.pluginmapniet werkelijk verborgen. (Optioneel, standaard is "medium").
- <dependencies> (afhankelijkheden)
Dit element, dat afhankelijkheden opgeeft, kan een directe child zijn van het <document>-element (een keer), en als een child van <component> -elementen (een keer voor elk <component>-element). Bevat de afhankelijkheden van de plugin waaraan moet worden voldaan. Zie het hoofdstuk over dependencies voor een overzicht. Attributen:
- rkward_min_version, rkward_max_version
Toegestane maximum- en minimumversies van RKWard. Versie-specificaties kunnen niet-numerieke toevoegingen hebben, zoals "0.5.7z-devel1". Indien er aan een bepaalde afhankelijkheid niet wordt voldaan, worden de ontbrekende plugin(s) waar die op betrekking hebben, genegeerd. Meer informatie. Optioneel; indien niet opgegeven, zijn er geen minimum / maximum versies vereist van RKWard.
- R_min_version, R_max_version
Toegestane maximum- en minimumversies van R. Versie-specificaties kunnen niet -numerieke toevoegingen hebben, zoals "0.5.7z-devel1". De afhankelijkheid van de R-versie wordt getoond in de help-pagina's van de plugin, maar heeft vanaf RKWard 0.6.1 geen direct effect.Meer informatie. Optioneel; indien niet opgegeven, zijn er geen minimum / maximum versies vereist van R.
Child elementen: (een child is een voortzetting van een parent. Dit soort termen zijn algemeen in een moderne computertaal)
- <package> (pakket)
Voegt een afhankelijkheid (dependency) toe van een opgegeven R-pakket. Attributen:
- naam
Pakketnaam (vereist)
- min_version, max_version
Minimum / maximum toegestane versie (optioneel).
- repository
Repository waarin het programma kan worden gevonden. Optioneel, maar hoogst gewenst, indien het pakket niet op CRAN beschikbaar is.
- <pluginmap>
Voegt een afhankelijkheid toe van een specifieke RKWard
.pluginmap. Attributen:- naam
Id-string (naamstring) van de vereiste
.pluginmap(vereist).- min_version, max_version
Minimum / maximum toegestane versie (optioneel).
- url
URL waar de
.pluginmapkan worden gevonden. Vereist.
- <about> (over)
Kan precies een keer aanwezig zijn als een directe child van het <document>- element. Bevat meta-informatie over de
.pluginmap(of plugin). Zie het hoofdstuk ' over' informatie voor een overzicht. Attributen:- naam
Naam zichtbaar voor de gebruiker. Optioneel. Hoeft niet gelijk te zijn aan de "id".
- versie
Versienummer. Optioneel. Er zijn geen beperkingen voor het formaat, maar voor de zekerheid kunt u de algemene versieschema's gebruiken, zoals "x.y.z".
- releasedate (datum van uitgifte)
pecificatie van de uitgiftedatum. Optionele formaat is "YYYY-MM-DD" (JJJJ-MM-DD)
- shortinfo (korte informatie)
Een korte beschrijving van de plugin /
.pluginmap. Optioneel.- url
URL waar meer informatie kan worden gevonden. Optioneel, maar aanbevolen.
- copyright
Copyright-specificatie, bijv. "2012-2013 door Pietje Puk". Optioneel, maar aanbevolen.
- licentie
Licentiegegevens, bijv. "GPL" of "BSD". Zorg ervoor dat u bij uw bestanden een complete kopie toevoegt van de erbij horende licentie! Optioneel, maar aanbevolen.
- categorie
Categorie van de plugin(s), bijv. "Item response theorie". Vanaf RKWard 0.6.1. worden geen categorieën vooraf gedefinieerd. Optioneel.
Child elementen: (een child is een voortzetting van een parent. Dit soort termen zijn algemeen in een moderne computertaal)
- <author> (auteur)
Voegt informatie toe over een auteur. Attributen:
- naam, voornaam, familienaam
Geef de volledige naam op voor
naam, of geef devoornaamen defamilienaam, apart op.- rol
Beschrijving rol van de auteur (optioneel)
E-mail adres van de auteur. Vereist. Kan een rkward-devel mailing list adres zijn, als u er op bent ingeschreven, en uw plugin in de officiële RKWard uitgave moet worden opgenomen.
- url
URL met nadere informatie over de auteur, bijv. homepage (optioneel).
- <components>
Moet precies één keer aanwezig zijn als een directe child van het <document>-element. Bevat de afzonderlijke <component>-elementen zoals hieronder beschreven.Geen attributen.
- <component>
Een of meer <component>-elementen moeten worden gegeven als directe children van het <componenten>-element (en alleen daar). Registreert een component/plugin met rkward. Attributen:
- type
Voor toekomstige uitbreiding: Het type van component/plugin. Zet deze voorlopig steeds op "standaard" (het enige ondersteunde type).
- id
De ID (naam) waarmee deze component kan worden opgehaald (om die in het menu te plaatsen (zie onder), of voor inbedding). Zie <document>-namespace boven.
- bestand
Tenminste vereist voor componenten van het type="standard": de bestandsnaam van het XML-bestand dat de GUI beschrijft.
- label
De naam voor deze component, wanneer die in de menu-hiërarchie wordt geplaatst.
- <attribute> (attribuut)
Definieert een attribuut van een component. Tot nu toe allen van betekenis voor importeren van plugins. Alleen toegestaan als een directe child van <component>. Attributen:
- id
Id (naam) van het attribuut
- waarde
Waarde van het attribuut
- labels
Naam behorende bij het attribuut
- <hierarchy> (hiërarchie)
Moet precies een keer aanwezig zijn als een directe child van het <document>-element. Beschrijft waar de hierboven gedeclareerde componenten moeten worden geplaatst in de menu-hiërarchie. Accepteert alleen <menu>-elementen als directe children. Geen attributen.
- <menu>
Een of meer <menu>-elementen moeten worden gegeven als directe children van het <hierarchy> element. Declareert een nieuw (sub)menu. Indien er al een menu bestaat met de opgegeven ID (zie onder), worden de twee menu's samengevoegd (merged). Het <menu>-element is toegestaan zowel als een directe child van het <hierarchy>-element (topniveau menu), of als de directe child van elk ander <menu>-element (submenu). Omgekeerd, accepteert het <menu>-element andere <menu>-elementen of <ingangs> (entry)-elementen als children. Attributen:
- id
Een identificerende string van het menu. Nuttig wanneer menudefinities worden gelezen uit verschillende
.pluginmap-bestanden, zodat zeker is dat plugins in het zelfde menu kunnen worden opgenomen. Sommige menu-namen, zoals "bestand" refereren aan bestaande menu's (in dit geval het "Bestand"-menu). Zorg ervoor dat bestaande.pluginmap-bestanden hiermee consistente namen hebben.- label
Een naam voor het menu.
- groep
Maakt het ordenen mogelijk van menu-ingangen. Zie Ordenen menu-ingangen. Optioneel.
- <entry> (ingang)
Een menu-ingang, bijv. een menu-optie voor het aanroepen van een plugin. Kan alleen worden gebruikt als een directe child van een <menu>-element, en accepteert geen child-elementen (onderliggende elementen). Attributen:
- component
De ID (naam) van de component die moet worden aangeroepen, wanneer deze menu-ingang wordt geactiveerd.
- groep
Maakt het ordenen mogelijk van menu-ingangen. Zie Ordenen menu-ingangen. Optioneel.
- <group> (groep)
Declareert een groep van ingangen in het menu. Zie Ordenen menu-ingangen. Attributes:
- id
De naam van deze groep.
- gescheiden
Optioneel. Indien ingesteld op "true" wordt de item van deze groep visueel gescheiden van de omringende items.
- groep
De naam van de groep die aan deze groep moet worden gegeven (optioneel).
- <context>
Declareert de ingangen in een context. Alleen toegestaan als een directe child van de <document>-tag. Accepteert alleen <menu>-tags als directe children. Attributen:
- id
De ID (naam) van de context. Tot dusver zijn slechts twee contexts geïmplementeerd: "x11" en "import".
- <require> (vereisen)
Een andere
.pluginmap-bestand insluiten. Dit.pluginmap-bestand wordt slechts een keer ingelezen, zelfs als het voor verschillende andere bestanden <require>d is. Het belangrijkste voorbeeld hiervan is het opnemen van een pluginmap-bestand waarin componenten worden gedeclareerd, die ingebed zijn in componenten gedeclareerd in deze.pluginmap. <require>d elementen zijn alleen toegestaan als directe children van de <document>-node. Attributen:- bestand
De bestandsnaam van de op te nemen
.pluginmap. Deze is relatief ten opzichte van de directory van het huidige.pluginmap-bestand + de base_prefix (zie boven, <document>-element).Indien u het relatieve pad naar de op te nemen.pluginmapniet kent, verwijst u in plaats daarvan naar de naam in hetmap-attribuut.- map
U kunt een
.pluginmap-bestand uit een ander pakket opnemen (of een RKWard.pluginmapuit uw externe.pluginmap), door er naar te verwijzen met zijnnamespacename::id, zoals opgegeven in het vereiste.pluginmaps <document>-element. Dit zal niet lukken indien geen.pluginmapmet die naam bekend is (bijv. niet op uw systeem is geïnstalleerd). u mag dit alleen doen voor.pluginmaps die niet in uw pakket aanwezig zijn. Voor maps in uw pakket,is het opgeven van een relatief pad (fileattribuut) sneller en betrouwbaarder.