http://docs.kde.org/
NazajReferencaNaprej

Elementi za uporabo v datotekah .pluginmap

<document>

Prisoten mora biti v vsaki datoteki .pluginmap kot korensko vozlišče (natanko enkrat). Lastnosti:

base_prefix

Imena datotek, navedena v datoteki .pluginmap, so pričakovano relativne glede na imenik datoteke .pluginmap + predpono, ki jo navedete tukaj. Uporabno, zlasti če se vse vaše komponente nahajajo pod enim samim podimenikom.

namespace

Imenski prostor za ID-je komponent. Ko iščete komponente za vdelavo, jih bo mogoče pridobiti prek niza "namespace::component_id". Zaenkrat nastavite na "rkward".

id

Izbirni identifikatorski niz za ta .pluginmap. Če navedete to možnost, lahko tretji avtorji sklicujejo in naložijo vašo datoteko .pluginmap od njihovih (glejte poglavje o ravnanju z odvisnostmi).

priority

En od "hidden", "low", "medium" ali "high". .pluginmap s prioriteto "medium" ali "high" se aktivirajo samodejno, ko jih RKWard prvič najde. Uporabite priority="hidden" za .pluginmap, ki niso namenjeni za aktiviranje, imenik (namenjen samo za vključitev). V trenutni izvedbi pa to dejansko ne skrije .pluginmap. (Izbirno, privzeto je "medium").

<dependencies>

Ta element, ki določa odvisnosti, je dovoljen kot neposredni podrejeni element elementa <document> (enkrat) in kot podrejeni element <component> elementov (enkrat za vsak element <component>). Podaja odvisnosti, ki morajo biti izpolnjene za uporabo vtičnika(-ov). Za pregled glejte poglavje o odvisnostih. Lastnosti:

rkward_min_version, rkward_max_version

Najmanjša in največja dovoljena različica RKWard. Specifikacije različice lahko vključujejo neštevilske pripone, kot je "0.5.7z-devel1". Če določena odvisnost ni izpolnjena, bodo vtičniki, na katere se nanaša, prezrti. Več informacij. Neobvezno; če ni navedeno, ni najmanjše/največje različice RKWard bo zahtevano.

R_min_version, R_max_version

Najmanjša in največja dovoljena različica R. Specifikacije različice morda ne vključujejo neštevilske pripone, kot je "0.5.7z-devel1". R odvisnost od različice bo prikazana na straneh s pomočjo vtičnikov, vendar nima neposrednega učinka, saj od RKWard 0.6.1. Več informacij. Neobvezno; če ni navedeno, ni najmanjše/največje različice R bo obvezno.

platforme

Platforme, kjer je ta vtičnik na voljo. Podprte vrednosti so "unix", "windows", "macos", "any" in kombinacije ločene z dvopičjem (npr. "unix:macos"). "unix" vključuje vse različice Linuxa in BSD, vendar ne MacOS. Če vaš vtičnik ni odvisen od platforme, preprosto izpustite ta atribut.

Podrejeni elementi:

<package>

Doda odvisnost od določenega R paketa. Lastnosti:

name

Ime paketa (obvezno).

min_version, max_version

Najmanjša / največja dovoljena različica (neobvezno).

repository

Repozitorij, kjer je paket mogoče najti. Izbirno, vendar zelo priporočljivo, če paket ni na voljo na CRAN.

<pluginmap>

Doda odvisnost od določene RKWard .pluginmap. Lastnosti:

name

Id niz zahtevane .pluginmap (obvezno).

min_version, max_version

Najmanjša / največja dovoljena različica (neobvezno).

url

URL kjer je .pluginmap mogoče najti. Obvezno.

<about>

Lahko je prisoten natanko enkrat kot neposredni podrejeni element elementa <document>. Vsebuje meta informacije o .pluginmap (ali o vtičniku). Za pregled si oglejte poglavje o informacijah 'o'. Lastnosti:

name

Uporabniku vidno ime. Neobvezno. Ni nujno, da je enak "id".

version

Številka različice. Neobvezno. Oblika zapisa ni omejena, vendar zaradi varnosti upoštevajte običajne sheme za ustvarjanje različic, kot je "x.y.z".

releasedate

Specifikacija datuma izdaje. Izbirno v obliki "YYYY-MM-DD".

shortinfo

short opis vtičnika / .pluginmap. Neobvezno.

url

URL kjer lahko najdete več informacij. Neobvezno, vendar priporočljivo.

copyright

Specifikacija avtorskih pravic, npr. "2012-2013 avtor John Doe". Neobvezno, vendar priporočljivo.

licence

Specifikacija licence, npr. "GPL" ali "BSD". Svojim datotekam ne pozabite priložiti popolne kopije ustrezne licence. Neobvezno, vendar priporočljivo.

category

Kategorija vtičnikov, npr. ""Item response theory". Od RKWard 0.6.1, nobena kategorija ni vnaprej določena. Neobvezno.

Podrejeni elementi:

<author>

Doda podatke o avtorju. Lastnosti:

ime, ime2, družina

Bodisi navedite polno ime za name ali pa navedite tako given kot family ločeno.

role

Opis vloge avtorja (neobvezno).

email

Elektronski naslov, na katerega je avtor dosegljiv. Obvezno. Lahko se nastavi na poštni seznam rkward-devel, če ste naročeni in je vaš vtičnik namenjen vključitvi v uradno izdajo RKWard.

url

URL z več podatki o avtorju, npr. domača stran (neobvezno).

<components>

Prisoten mora biti natanko enkrat kot neposredni podrejeni element <document> element. Vsebuje posamezne elemente <component>, opisane spodaj. Brez atributov.

<component>

Ena ali več elementov <component> je treba podati kot neposredne podrejene elemente <components> element (in samo tam). Registrira komponento/vtičnik z rkward. Lastnosti:

type

Za prihodnjo razširitev: Vrsta komponente/vtičnika. Zaenkrat vedno nastavljen na "standard" (edina trenutno podprta vrsta).

id

ID, po katerem je mogoče pridobiti to komponento (za postavitev v meni (glejte spodaj) ali za vdelavo). Glejte <document>-namespace zgoraj.

file

Zahtevano vsaj za komponente type="standard": ime datoteke XML datoteka, ki opisuje GUI.

label

Oznaka za to komponento, ko je postavljena v hierarhijo menija.

neobvezno

Smiselno samo za komponente z definiranimi odvisnostmi: Običajno velja za napako, ki jo je treba prijaviti, če komponenta ni združljiva s to različico RKWard. Vendar, če komponenta v trenutnem okolju res ni potrebna, nastavitev tega atributa na "true" privzeto zavrne vsa opozorila ("false").

<attribute>

Določa atribut komponente. Zaenkrat smiselno samo za vtičnike za uvoz. Dovoljeno samo kot neposredni podrejeni <component>. Lastnosti:

id

ID atributa

value

Vrednost atributa

labels

Oznaka, povezana z atributom

<hierarchy>

Prisoten mora biti natanko enkrat kot neposredni podrejeni element <document>. Opisuje, kje v hierarhiji menija naj bodo postavljene zgoraj navedene komponente. Sprejme samo elemente <menu> kot neposredno podrejene. Brez atributov.

<menu>

En ali več elementov <menu> je treba podati kot neposredne potomce elementa <hierarchy>. Razglasi nov (pod)meni. Če meni z danim ID-jem (glejte spodaj) že obstaja, se oba menija združita. Element <menu> je dovoljen kot neposredni podrejeni element <hierarchy> element (meni najvišje ravni) ali kot neposredni podrejeni element katerega koli drugega elementa <menu> (podmeni). Nasprotno pa element <menu> sprejme druge elemente <menu> ali elemente <entry> kot podrejene. Lastnosti:

id

Identifikacijski niz menija. Uporabno, ko so definicije menija prebrane iz več datotek .pluginmap, da zagotovite, da je vtičnike mogoče postaviti v iste menije. Nekateri ID-ji menijev, kot je "file", se nanašajo na vnaprej določene menije (v tem primeru meni "File"). Ne pozabite preveriti z obstoječo datoteko .pluginmap za uporabo doslednih ID-jev.

label

Oznaka za meni.

group

Omogoča nadzor vrstnega reda vnosov v meniju. Glejte razvrstitev elementov menija. Neobvezno.

<entry>

Vnos v meni, tj. možnost menija za priklic vtičnika. Lahko se uporablja samo kot neposredni podrejeni element <menu> elementa, ne sprejema podrejenih elementov. Lastnosti:

component

ID komponente, ki jo je treba priklicati, ko je aktiviran ta menijski vnos.

group

Omogoča nadzor vrstnega reda vnosov v meniju. Glejte razvrstitev elementov menija. Neobvezno.

<group>

Razglasi skupino elementov v meniju. Glejte razvrstitev elementov menija. Lastnosti:

id

Ime te grupe.

separated

Neobvezno. Če je nastavljeno na "true", bo element v tej grupi vizualno ločen od okoliških elementov.

group

Ime grupe, ki ji želite dodati to grupo (neobvezno).

<context>

Razglasi vnose v context. Dovoljeno samo kot neposredni podrejeni element oznake <document>. Sprejme samo oznake <menu> kot neposredno podrejene. Lastnosti:

id

ID konteksta. Zaenkrat sta implementirana samo dva konteksta: "x11" in "import".

<require>

Vključi še eno datoteko .pluginmap. Ta datoteka .pluginmap se naloži samo enkrat, tudi če je zahtevana - <require>d iz več drugih datotek. Najpomembnejši primer uporabe je vključitev datoteke pluginmap, ki deklarira nekatere komponente, ki so vdelane s komponentami, deklariranimi v tem .pluginmap. Elementi <require> so dovoljeni samo kot neposredno podrejeni vozlišča <document>. Lastnosti:

file

Ime datoteke vključeno v .pluginmap. To je vidno glede na imenik trenutne datoteke .pluginmap + base_prefix (glejte zgoraj, element <document>). Če ne poznate relativne poti do datoteke .pluginmap če jo želite vključiti, uporabite atribut map, da se nanj sklicujete z ID-jem.

map

Če želite vključiti .pluginmap datoteke iz drugega paketa (ali RKWard .pluginmap iz vaše zunanje .pluginmap), se lahko nanjo sklicujete po njenem namespacename::id, kot je določeno v zahtevanem elementu .pluginmap <document>. Vključitev ne bo uspela, če .pluginmap s tem ID-jem ni znan (npr. ni nameščen v uporabnikovem sistemu). To metodo uporabite samo za vključitev .pluginmap zunaj vašega paketa. Za mape v vašem paketu je podajanje relativne poti (atribut file) hitrejše in zanesljivejše.