Elementi za uporabo v XML opis vtičnika

Lastnosti elementov so navedene v ločenem razdelku.

Splošni elementi

<document>

Prisoten mora biti v vsaki datoteki description.xml kot korensko vozlišče. Brez posebne funkcije. Brez atributov

<about>

Informacije o tem vtičniku (avtor, licenca itd.). Ta element je dovoljen v datoteki .xml posameznega vtičnika in v .pluginmap datoteke. Glejte .pluginmap sklic na datoteko za podrobnosti o sklicu, poglavje o informacijah 'o' za uvod.

<code>

Določa, kje iskati predlogo JS za vtičnik. Uporabite samo enkrat na datoteko kot neposredni podrejeni element oznake dokumenta. Lastnosti:

file

Ime datoteke predloge JS glede na imenik, v katerem je plugin-xml

<help>

Določa, kje iskati datoteko pomoči za vtičnik. Uporabite samo enkrat na datoteko kot neposredni podrejeni element oznake dokumenta. Lastnosti:

file

Ime datoteke za pomoč glede na imenik, v katerem je plugin-xml

<copy>

Lahko se uporablja kot podrejeni (neposredni ali posredni) glavnih elementov postavitve, tj. <pogovorno okno> in <čarovnik>. To se uporablja za kopiranje celotnega bloka XML elementi 1:1. Lastnosti:

id

ID, ki ga je treba iskati. <copy> bo iskal prejšnji XML element, ki je dobil isti ID, in ga kopirajte, vključno z vsemi podrejenimi elementi.

copy_element_tag_name

V nekaj primerih boste želeli skoraj dobesedno kopijo, vendar spremenite ime oznake elementa za kopiranje. Najpomembnejši primer tega je, ko želite kopirati celoten <tab> iz pogovornega vmesnika na <stran> vmesnika čarovnika. V tem primeru bi nastavili copy_element_tag_name="stran" za samodejno pretvorbo.

Definicije vmesnikov

<dialog>

Definira vmesnik pogovornega okna tipa dialog. Postavite GUI definicija znotraj te oznake. Uporabite samo enkrat na datoteko kot neposredni podrejeni element oznake dokumenta. Za vtičnik je potrebna vsaj ena od oznak "dialog" ali "wizard". Lastnosti:

label

Napis za pogovorno okno

recommended

Ali naj se pogovorno okno uporabi kot "recommended - priporočeni" vmesnik (tj. vmesnik, ki bo privzeto prikazan, razen če je uporabnik RKWard konfiguriral tako, da privzeto uporablja določen vmesnik)? Ta atribut trenutno nima učinka, saj je implicitno "true", razen če je priporočen čarovnik.

<wizard>

Definira vmesnik vrste čarovnika. Postavite GUI definicijo znotraj te oznake. Uporabite samo enkrat na datoteko kot neposredni podrejeni element oznake dokumenta. Za vtičnik je potrebna vsaj ena od oznak "dialog" ali "wizard". Sprejme samo <page> ali <embed>-oznake kot neposredni podrejene. Lastnosti:

label

Napis za čarovnika

recommended

Ali naj se čarovnik uporablja kot "recommended - priporočen" vmesnik (tj. vmesnik, ki bo prikazan privzeto, razen če je uporabnik konfiguriral RKWard za privzeti vmesnik)? Izbirno, privzeto je "false".

Elementi postavitve

Vsi elementi v tem razdelku sprejemajo atribut id="identifierstring". Ta atribut je neobvezen za vse elemente. Uporabite ga lahko na primer za skrivanje/onemogočanje celotnega elementa postavitve in vseh elementov, ki jih vsebuje (glejte poglavje GUI logic). Id-string ne sme vsebovati "." (pike) ali ";" (podpičja) in bi moralo biti na splošno omejeno na alfanumerične znake in podčrtaj (»_«). Navedeni so le dodatni atributi.

<page>

Določa novo stran v čarovniku. Dovoljeno samo kot neposredni podrejeni element elementa <wizard>.

<row>

Vsi neposredni podrejeni elementi oznake "row - vrstica" bodo postavljeni od leve proti desni.

<column>

Vsi neposredni podrejeni elementi oznake "column - stolpec" bodo postavljeni od zgoraj navzdol.

<stretch>

Privzeto so elementi v GUI zasedejo ves razpoložljivi prostor. Na primer, če imate dva stolpca drug ob drugem, je levi poln elementov, desni pa vsebuje samo en ukaz <radio>, nadzor <radio> se bo razširil navpično, čeprav v resnici ne potrebuje razpoložljivega prostora, in videti bo bo grdo. V tem primeru res želite dodati "blank" pod <radio>. Za to uporabite <stretch> element. Preprosto bo porabil nekaj prostora. Ne pretiravajte s tem elementom, običajno je dobra ideja za GUI elemente, da dobijo ves razpoložljivi prostor, le včasih bo postavitev razmaknjena. <stretch> element ne sprejema nobenih argumentov, niti "id". Prav tako ne smete postaviti otrok v <stretch> element (z drugimi besedami, vedno ga boste uporabljali samo kot "<stretch/>")

<frame>

Nariše okvir/polje okoli svojih neposrednih podrejenih elementov. Uporablja se lahko za vizualno združevanje povezanih možnosti. Postavitev znotraj okvirja je od zgoraj navzdol, razen če postavite <row> znotraj. Lastnosti:

label

Napis za okvir (neobvezno)

checkable

Okvirje je mogoče narediti checkable - označljive. V tem primeru bodo vsi vsebovani elementi onemogočeni, ko okvir ni odkljukan, in omogočeni, ko je odkljukan. (izbirno, privzeto je "false")

checked

Samo za okvirje vrste chackable: Ali naj bo okvir privzeto odkljukan? Privzeto je "true". Ni interpretirano za okvirje, ki niso checkable.

<tabbook>

Organizira elemente v tabbook - knjižico zavihkov. Sprejema le oznake <tab> kot neposredne podrejene.

<tab>

Določa stran v tabbook - knjižici zavihkov. Postavite GUI definicija za zavihek znotraj te oznake. Lahko se uporablja samo kot neposredni podrejeni element <tabbook> oznaka. <tabbook> mora imeti vsaj dva definirana zavihka. Lastnosti:

label

Napis za stran zavihka (obvezno)

<text>

Prikaže text besedilo, obdano s to oznako v GUI. Podprto je nekaj preprostih HTML slogovnih oznak (zlasti <b>, <i>, <p> in <br/>). Kljub temu naj bo formatiranje čim manjše. Vstavljanje popolnoma prazne vrstice doda trd prelom vrstice. Lastnosti:

type

Vrsta besedila. Eno izmed "normalno", "warning" ali "error". To vpliva na videz besedila (neobvezno, privzeto je normalno)

Aktivni elementi

Vsi elementi v tem razdelku sprejemajo atribut id="identifierstring". Ta atribut je obvezen za vse elemente. Navedeni so le dodatni atributi. Id-string ne sme vsebovati "." (pik).

<varselector>

Zagotavlja seznam razpoložljivih predmetov, med katerimi lahko uporabnik izbere enega ali več. Za uporabnost potrebuje enega ali več <varslot> kot protipostavko. Lastnosti:

label

Oznaka za varselector - izbirnik spremenljivk (neobvezno, privzeto je "Izberi spremenljivko(e)")

<varslot>

Uporablja se v povezavi z "varselector", da uporabniku omogoči izbiro ene ali več spremenljivk. Lastnosti:

label

Oznaka za varslot (priporočeno, privzeto je "Variable:")

source

Varselektor iz katerega pridobite izbor (obvezno, razen če se povežete ročno ali z uporabo source_property)

source_property

Poljubna lastnost za kopiranje vrednosti, ko kliknete gumb za izbiro. Če je navedeno, to preglasi atribut "source".

required

Ali je za oddajo kode potrebno, da ta varslot vsebuje veljavno vrednost. Oglejte si required-property (izbirno, privzeto je false)

multi

Ali varslot vsebuje samo enega (privzeto, "false") ali več predmetov

allow_duplicates

Ali sme varslot sprejeti samo edinstvene objekte (privzeto, »false«) ali če je lahko isti objekt dodan večkrat.

min_vars

Pomembno samo, če je multi="true": Najmanjše število spremenljivk, ki jih je treba izbrati, da bo izbor veljaven (neobvezno, privzeto je "1")

min_vars_if_any

Pomembno samo, če je multi="true": nekatere reže varslot se lahko štejejo za veljavne, če je na primer reža varslot prazna ali vsebuje vsaj dve vrednosti. To določa, koliko spremenljivk mora biti izbranih, če sploh katere (2 v primeru). (izbirno, privzeto je "1")

max_vars

Smiselno samo, če je multi="true": največje število spremenljivk za izbiro (neobvezno, privzeto je "0", kar pomeni, da ni največjega števila)

razredi

Če podate enega ali več R imen razredov (ločena s presledki (" ")), bo varslot tukaj sprejemal samo predmete, ki pripadajo tem razredom (neobvezno, uporabljajte zelo previdno, uporabniku ne sme biti preprečeno sprejemanje veljavnih izbir in R ima veliko različnih razredov)

vrste

Če podate eno ali več vrst spremenljivk (ločenih s presledki (" ")), bo tukaj varslot sprejel samo objekte teh vrst. Veljavni tipi so "unknown", "number", "string", "factor", "invalid". (Izbirno, uporabljajte zelo previdno, uporabniku ne bi smeli preprečiti veljavnih izbir in RKWard ne pozna vedno vrste spremenljivke)

num_dimensions

Število dimenzij, ki jih mora imeti objekt. "0" (privzeto) pomeni, da je sprejemljivo poljubno število dimenzij. (izbirno, privzeto je "0")

min_length

Najmanjša dolžina, ki jo mora imeti predmet, da je sprejemljiv. (izbirno, privzeto je "0")

max_length

Največja dolžina, ki jo mora imeti predmet, da je sprejemljiv. (izbirno, privzeto je največje celo število, ki ga je mogoče predstaviti v sistemu)

<valueselector>

Zagotavlja seznam razpoložljivih nizov (ne R objektov), ki jih je treba izbrati v enem ali več spremljajočih <valuesslot>s. Možnosti nizov je mogoče definirati z uporabo oznak <option> kot neposredne podrejene (glejte spodaj) ali nastaviti z uporabo dinamičnih lastnosti. Lastnosti:

label

Oznaka za izbirnik vrednosti (neobvezno, privzeto ni oznake)

<valueslot>

Uporablja se v povezavi z <valueselector> da uporabniku omogoči izbiro enega ali več elementov niza. Ta element je večinoma identičen <varslot> in ima enake atribute, razen tistih, ki se nanašajo na lastnosti sprejemljivih elementov (tj. razredi, tipi, num_dimensions, min_length, max_length).

<radio>

Določa skupino radijskih ekskluzivnih gumbov (hkrati je mogoče izbrati samo enega). Zahteva vsaj dve oznaki <option> kot neposredne podrejene. Nobene druge oznake niso dovoljene kot podrejene. Lastnosti:

label

Oznaka za radijski nadzor (priporočeno, privzeto je »Izberite eno:«)

<dropdown>

Določa skupino možnosti, od katerih je mogoče hkrati izbrati eno in samo eno s spustnim seznamom. To je funkcionalno enakovredno <radio>, vendar je videti drugače. Zahteva vsaj dve oznaki <option> kot neposredne podrejene. Nobene druge oznake niso dovoljene kot podrejene. Lastnosti:

label

Oznaka za spustni seznam (priporočeno, privzeto je »Izberite enega:«)

<select>

Zagotavlja seznam razpoložljivih nizov, iz katerih lahko uporabnik izbere poljubno število. Možnosti niza je mogoče definirati z uporabo oznak <option> kot neposredne podrejene (glejte spodaj) ali nastaviti z uporabo dinamičnih lastnosti. Lastnosti:

label

Oznaka za <select> (izbirno, privzeto ni oznake)

single

Če je nastavljeno na true, bo mogoče izbrati samo eno vrednost namesto več vrednosti hkrati (boolean, privzeto je false)

<option>

Lahko se uporablja samo kot neposredni podrejeni element <radio>, <dropdown>, <valueselector> ali <select> element. Predstavlja eno izbirno možnost v radijskem nadzoru ali spustnem seznamu. Kot <option> elementi so vedno del enega od izbirnih elementov, običajno nimajo lastnega "id-ja", vendar glejte spodaj. Lastnosti:

label

Oznaka za možnost (obvezno)

value

Vrednost niza, ki jo bo nadrejeni element vrnil, če je ta možnost označena/izbrana (obvezno)

checked

Ali naj bo možnost označena/izbrana privzeto "true" ali "false". V <radio> ali <dropdown>, je lahko samo ena možnost nastavljena na checked="true", in če nobena možnost ni označena, bo prva možnost v nadrejenem elementu samodejno označeno/izbrano. V <select> je lahko izbranih poljubno število možnosti. (izbirno, privzeto je "false")

id

Določanje parametra "id" za <option> elementov ni obvezen (in pravzaprav je priporočljivo, da ne nastavite "id-ja", razen če ga res potrebujete). Vendar pa vam bo podajanje "id-ja" omogočilo, da dinamično omogočite/onemogočite <option>, tako da se povežete z logično lastnostjo id_of_radio.id_of_optionX.enabled. Trenutno to deluje za možnosti znotraj <radio> ali <dropdown> samo elementi; <valueselector> in <select> možnosti trenutno ne podpirajo ID-jev.

<checkbox>

Določa potrditveno polje, tj. eno samo možnost, ki jo je mogoče vklopiti ali izklopiti. Lastnosti:

label

Oznaka za potrditveno polje (obvezno)

value

Vrednost, ki jo potrditveno polje vrne, če je označeno (obvezno)

value_unchecked

Vrednost, ki bo vrnjena, če potrditveno polje ni potrjeno (izbirno, privzeto je "", tj. prazen niz)

checked

Ali naj bo možnost privzeto potrjena "true" ali "false" (neobvezno, privzeto je "false")

<frame>

Element okvirja se na splošno uporablja kot čisti element postavitve in je naveden v razdelku o elementih postavitve. Lahko pa ga tudi preverite, tako da hkrati deluje kot preprosto potrditveno polje.

<input>

Določa polje za prosti vnos besedila. Lastnosti:

label

Oznaka za vnosno polje (obvezno)

initial

Začetno besedilo besedilnega polja (neobvezno, privzeto je "", tj. prazen niz)

size

Eden izmed "small", "medium" ali "large". "large" definira večvrstično vnosno polje, "small in "medium" sta enovrstični polji (izbirno, privzeto je "medium")

required

Ali se za oddajo kode zahteva, da ta vnos ni prazen. Oglejte si required-property (izbirno, privzeto je false)

<matrix>

Tabela za vnos matričnih podatkov (ali vektorjev) v GUI.

Opomba

Ta vnosni element ni optimiziran za vnos/urejanje velikih količin podatkov. Čeprav ni stroge omejitve glede velikosti <matrix>, na splošno ne sme preseči približno desetih vrstic/stolpcev. Če pričakujete večje podatke, dovolite uporabnikom, da jih izberejo kot R objekt (kar je lahko dobra ideja kot alternativna možnost, v skoraj vseh primerih, kjer uporabljate matrični element).

Lastnosti:

label

Oznaka za tabelo (obvezno)

način

Eno od "integer", "real" ali "string". Vrsta podatkov, ki bodo sprejeti v tabeli (obvezno)

min

Najmanjša sprejemljiva vrednost (za matrike tipa "integer" ali "real") (neobvezno, privzeta vrednost je najmanjša predstavljiva vrednost)

max

Največja sprejemljiva vrednost (za matrike tipa "integer" ali "real") (neobvezno, privzeta vrednost je največja predstavljiva vrednost)

allow_missings

Ali so v matriki dovoljene manjkajoče (prazne) vrednosti. To je implicirano za matrike ali način "string" (neobvezno, privzeto je false).

allow_user_resize_columns

Ko je nastavljeno na true, lahko uporabnik dodaja stolpce tako, da vnese v skrajno desne (neaktivne) celice (neobvezno, privzeto je true).

allow_user_resize_rows

Ko je nastavljeno na true, lahko uporabnik dodaja vrstice s tipkanjem v najnižje (neaktivne) celice (izbirno, privzeto je true).

rows

Število vrstic v matriki. Nima učinka za allow_user_resize_rows="true".

Opomba

To lahko nadzirate tudi z nastavitvijo lastnosti "rows".

(izbirno, privzeto je 2).

columns

Število stolpcev v matriki. Nima učinka za allow_user_resize_columns="true".

Opomba

To lahko nadzirate tudi z nastavitvijo lastnosti "columns".

(izbirno, privzeto je 2).

min_rows

Najmanjše število vrstic v matriki. Matrica se ne bo skrčila pod to velikost. (izbirno, privzeto je 0; glejte tudi: allow_missings.).

min_columns

Najmanjše število stolpcev v matriki. Matrica se ne bo skrčila pod to velikost. (izbirno, privzeto je 0; glejte tudi: allow_missings.).

fixed_height

Prisilite da GUI element ostane na začetni višini. Ne uporabljajte v kombinaciji z matricami, kjer se lahko število vrstic kakor koli spremeni. Uporabno, posebej pri ustvarjanju vektorskega vhodnega elementa (columns="1"). Če je ta možnost nastavljena na true, ne bo prikazan noben vodoravni drsnik, tudi če matrika presega razpoložljivo širino (ker bi to vplivalo na višino). (neobvezno, privzeto je false).

fixed_width

Nekoliko napačno imenovan: Predpostavimo, da se število stolpcev ne bo spremenilo. Zadnji (ali običajno samo) stolpec bo raztegnjen, da zavzame razpoložljivo širino. Ne uporabljajte v kombinaciji z matrikami, kjer se lahko število stolpcev kakor koli spremeni. Uporabno, posebej pri ustvarjanju vektorskega vhodnega elementa (rows="1"). (neobvezno, privzeto je false).

horiz_headers

Nizi za vodoravno glavo, ločeni z ";". Glava bo skrita, če je nastavljena na "". (izbirno, privzeto je številka stolpca).

vert_headers

Nizi, ki se uporabljajo za navpično glavo, ločeni z ";". Glava bo skrita, če je nastavljena na "". (izbirno, privzeto številka vrstice).

<optionset>

Uporabniški vmesnik za ponavljanje nabora možnosti za poljubno število elementov (uvod v nabore možnosti). Lastnosti:

min_rows

Če je naveden, bo nabor označen kot neveljaven, razen če ima vsaj toliko vrstic (neobvezno, celo število).

min_rows_if_any

Kot min_rows, vendar bo preizkušen le, če obstaja vsaj ena vrstica (neobvezno, celo število).

max_rows

Če je določen, bo niz označen kot neveljaven, razen če ima največ to število vrstic (neobvezno, celo število).

keycolumn

ID stolpca, ki bo deloval kot ključni stolpec. Nabor možnosti z (veljavnim) ključnim stolpcem bo deloval kot "nastavljen" nabor možnosti. Nabor možnosti brez ključnega stolpca bo omogočil ročno vstavljanje/odstranjevanje elementov. Ključni stolpec mora biti označen kot zunanji. (izbirno, privzeto ni ključnega stolpca).

Podrejeni elementi:

<optioncolumn>

Določa en neobvezen stolpec niza. Za vsako vrednost, ki jo želite pridobiti iz nabora možnosti, morate deklarirati ločen <optioncolumn>. Lastnosti:

id

ID neobveznega stolpca (obvezno, niz).

external

Nastavite na true, če je neobvezni stolpec nadzorovan zunaj nabora možnosti optionset (neobvezno, logično, privzeto na false).

label

Če je podan, bo optioncolumn prikazan v stolpcu s to oznako (neobvezno, niz, privzeto ni prikazano).

connect

Lastnost za povezavo tega stolpca z možnostmi, podana kot id znotraj območja <content>. Za zunanji <optioncolumn> bo ustrezna vrednost nastavljena na zunanje nastavljeno vrednost. Za navadne (nezunanje) <optioncolumn> bo ustrezna vrstica lastnosti <optioncolumn> nastavljena, ko se lastnost spremeni znotraj področja vsebine. (izbirno, niz, privzeto ni povezano).

default

Samo za zunanje stolpce: vrednost, ki naj se predpostavi za ta stolpec, če za vnos ni znana nobena vrednost. Redko uporabno. (Izbirno, privzeto prazen niz)

<content>

Deklarirajte vsebino / UI nabora. Brez atributov. Kot podrejeni elementi so dovoljeni vsi običajni aktivni, pasivni in postavitveni elementi. Poleg tega je v starejših različicah RKWard (do 0.6.3) bil dovoljen poseben podrejeni element <optiondisplay>. To je zastarelo v RKWard 0.6.4 in ga je treba preprosto odstraniti iz obstoječih vtičnikov.

<logic>

Izbirna specifikacija logike uporabniškega vmesnika za uporabo znotraj območja vsebine nabora možnosti. Oglejte si sklic na <logic>

<browser>

Element, zasnovan za izbiro enega imena datoteke (ali imena imenika). Upoštevajte, da bo to polje sprejelo poljuben niz, čeprav je namenjen uporabi za datoteke, samo:

label

Oznaka za brskalnik (neobvezno, privzeto je "Vnesite ime datoteke")

initial

Začetno besedilo brskalnika (neobvezno, privzeto je "", tj. prazen niz)

type

Eden izmed "file", "dir" ali "savefile". Za izbiro obstoječe datoteke, obstoječega imenika ali neobstoječe datoteke (neobvezno, privzeto je "file")

allow_urls

Ali je mogoče izbrati (nelokalne) URL (neobvezno, privzeto je "false")

filter

Filter vrste datoteke, npr. ("*.txt *.csv" za datoteke .txt in .csv). Samodejno je dodan ločen vnos za "Vse datoteke" (izbirno, privzeto je "", tj. Vse datoteke)

required

Ali je za oddajo kode potrebno, da polje ni prazno. Upoštevajte, da to ne pomeni nujno, da je izbrano ime datoteke veljavno. Oglejte si required-property (neobvezno, privzeto na true)

<saveobject>

Element, zasnovan za izbiro imena R predmet, v katerega želite shraniti (tj. na splošno še ne obstaja, v nasprotju z varslot):

label

Oznaka za vnos (neobvezno, privzeto je "Shrani v:")

initial

Začetno besedilo vnosa (neobvezno, privzeto je "my.data")

required

Ali je za oddajo kode zahtevano, da polje vsebuje dovoljeno ime objekta. Oglejte si required-property (neobvezno, privzeto na true)

checkable

V mnogih primerih uporabe je shranjevanje v R predmet neobvezno. V teh primerih lahko s tem atributom v element saveobject-element vključite potrditveno polje. Ko je nastavljeno na true, bo saveobject aktiviran / deaktiviran s potrditvenim poljem. Oglejte si active-property saveobject (neobvezno, privzeto je false)

checked

Samo za preverljive saveobject-elemente: Ali je kontrolnik privzeto označen / omogočen (neobvezno, privzeto je false)

<spinbox>

Vrtilno polje, v kateri lahko uporabnik izbere številsko vrednost z uporabo neposrednega vnosa s tipkovnice ali majhnih puščic gor/dol. Lastnosti:

label

Oznaka vrtilnega polja (priporočeno, privzeto "Vnesite vrednost:")

min

Najnižja vrednost, ki jo lahko uporabnik vnese v vrtilno polje (neobvezno, privzeto je najnižja vrednost, ki jo je tehnično mogoče predstaviti v vrtilnem polju)

max

Največja vrednost, ki jo lahko uporabnik vnese v vrtilno polje (neobvezno, privzeta vrednost je najvišja vrednost, ki jo je tehnično mogoče predstaviti v vrtilnem polju)

initial

Začetna vrednost, prikazana v vrtilnem polju (neobvezno, privzeto je "0")

type

En od "real" ali "integer". Ali bo vrtilno polje sprejelo realna števila ali samo cela števila (neobvezno, privzeto je "real")

default_precision

Smiselno samo, če ima vrtilno polje type="real". Podaja privzeto število decimalnih mest, prikazanih v vrtilnem polju (prikazano bo samo toliko ničel na koncu). Ko uporabnik pritisne puščice gor/dol, se to decimalno mesto spremeni. Vendar bo uporabnik morda še vedno lahko vnesel vrednosti z večjo natančnostjo (glejte spodaj) (neobvezno, privzeto je "2")

max_precision

Največje število števk, ki jih je mogoče smiselno predstaviti (neobvezno, privzeto je "8")

<formula>

Ta napredni element omogoča uporabniku, da iz izbranih spremenljivk izbere formulo/niz interakcij. Na primer za GLM lahko ta element uporabite, da uporabniku omogočite določitev interakcijskih pogojev v modelu. Lastnosti:

fixed_factors

ID reže varslot, ki vsebuje izbrane fiksne faktorje (obvezno)

dependent

ID reže varslot, ki vsebuje izbrano odvisno spremenljivko (obvezno)

<embed>

V ta vtičnik vdelajte drug vtičnik (glejte poglavje o vdelavi). Lastnosti:

component

Registrirano ime komponente za vdelavo (glejte poglavje o registraciji komponent) (obvezno)

as_button

Če je nastavljeno na "true", bo v vdelani GUI nameščen samo gumb pushbutton, vdelani GUI bo prikazan samo (v ločenem oknu), ko pritisnete gumb pushbutton (neobvezno, privzeto je "false")

label

Smiselno samo, če je as_button="true": oznaka gumba (priporočljivo, privzeto je "Options")

<preview>

Potrditveno polje za preklop funkcije predogleda. Upoštevajte, da od različice 0.6.5 RKWard so elementi predogleda <preview> označeni s posebnimi črkami v pogovornih oknih vtičnikov (ne v čarovnikih): postavljeni bodo v stolpec z gumbi, ne glede na to, kje so točno definirani v uporabniškem vmesniku. Še vedno je dobra ideja, da jih definirate na smiselnem mestu v postavitvi zaradi združljivosti za nazaj. Lastnosti:

label

Oznaka polja (neobvezno, privzeto je "Preview")

način

Vrsta predogleda. Podprte vrste so "plot" (glejte poglavje o predogledih grafov), "output" (glejte poglavje o (HTML) predogledih izhodov), "data" (glejte predoglede podatkov) in "custom" (glejte predoglede po meri). (izbirno, privzeto je "plot")

placement

Postavitev predogleda: "attached" (na glavno delovno mesto), "detached" (samostojno okno), "docked" (priloženo pogovornemu oknu vtičnika) in "default" (trenutno je to enako kot "docked", lahko pa na neki točki lahko konfigurira uporabnik). Na splošno je priporočljivo, da to pustite kot privzeto nastavitev za najboljšo skladnost uporabniškega vmesnika (izbirno, privzeto je "default")

active

Ali je predogled privzeto aktiven. Na splošno bi morali biti privzeto aktivni samo zasidrani predogledi in tudi za te obstaja razlog, zakaj so privzeti predogledi neaktivni (neobvezno, privzeto je "false")

Logic section

<logic>

Element, ki vsebuje logični odsek - Logic section. Vsi spodnji elementi so dovoljeni samo znotraj elementa <logic>. Element <logic> je dovoljen samo kot neposredni podrejeni element elementa <document> (največ enkrat na dokument) ali elementov <optionset> (največ enkrat na nabor možnosti optionset). Logični razdelek dokumenta se nanaša na oba <dialog> in <wizard> GUI na enak način.

<external>

Ustvari novo lastnost (niz), ki naj bi bila povezana z zunanjo lastnostjo, če bo vtičnik vdelan. Oglejte si razdelek o nedokončanih - "incomplete" vtičnikih. Lastnosti:

id

ID nove lastnosti (obvezno)

default

Privzeta vrednost niza nove lastnosti, tj. uporabljena vrednost, če lastnost ni povezana z zunanjo lastnostjo (neobvezno, privzeto je prazen niz)

<i18n>

Ustvari novo lastnost (niz), ki naj bi zagotavljala internacionalizirano oznako. Lastnosti:

id

ID nove lastnosti (obvezno)

label

Oznaka. To bo prevedeno. (obvezno)

<set>

Lastnost nastavite na fiksno vrednost (seveda, če lastnost dodatno povežete s kakšno drugo lastnostjo, vrednost ne ostane fiksna). Na primer, če vdelate vtičnik, vendar želite skriti nekatere njegove elemente, lahko nastavite lastnost vidnosti teh elementov na false. Uporabno npr. za vdelane/vdelane vtičnike. Opomba: če obstaja več <set> elementov za en sam id, ima prednost tisti, ki je zadnji definiran. To se bo včasih koristno zanesti pri uporabi <include>d delov. Lastnosti:

id

ID lastnosti za nastavitev (obvezno)

to

Vrednost niza, na katero želite nastaviti lastnost to (obvezno). Opomba: Za logične lastnosti, kot sta vidnost, omogočenost, boste atribut običajno nastavili na =="true" ali na="false".

<convert>

Ustvarite nove logične lastnosti, ki so odvisne od stanja ene ali več različnih lastnosti. Lastnosti:

id

ID nove lastnosti (obvezno)

sources

ID-ji lastnosti, od katerih bo ta lastnost odvisna. Določite lahko eno ali več lastnosti, ločenih z ";" (obvezno)

način

Način pretvorbe/delovanja. Eden izmed "equals", "notequals", "range", "and", "or". Če je v načinu equals, bo lastnost resnična le, če je vrednost vseh njenih virov enaka standardu atributa (glejte spodaj). Če je v načinu notequals, bo lastnost resnična samo, če se vrednost vseh njenih virov razlikuje od standarda atributa (glejte spodaj). Če je v območju načina "range", morajo biti viri numerični (celoštevilo ali realno). Lastnost bo resnična samo, če so vsi viri v območju, ki ga določata atributa min in max (glejte spodaj). Če je v načinu in, morajo biti viri logične lastnosti. Lastnost bo resnična le, če so resnični vsi viri hkrati. Če je v načinu ali, morajo biti viri logične lastnosti. Lastnost bo resnična le, če je resničen vsaj eden od virov. (obvezno)

standard

Pomembno samo v načinih equals ali notequals: vrednost niza za primerjavo (obvezno, če je v enem od teh načinov)

min

Pomembno samo v načinu range: najmanjša vrednost za primerjavo (neobvezno, privzeto je najnižje število s plavajočo vejico, ki ga lahko predstavi stroj)

max

Pomembno samo v načinu range: največja vrednost za primerjavo (neobvezno, privzeto je največje število s plavajočo vejico, ki ga lahko predstavi stroj)

require_true

Če je nastavljeno na "true", bo lastnost postala obvezna in bo veljavna samo, če je njeno stanje true/on. Torej, če je lastnost false, bo blokirala gumb Pošlji (izbirno, privzeto je "false").

Opozorilo

Če uporabljate to, poskrbite, da lahko uporabnik zlahka zazna, kaj je narobe, na primer s prikazom pojasnjevalnega <besedila>.

<switch>

Ustvarite novo lastnost, ki se bo nanašala na različne ciljne lastnosti (ali fiksne nize) na podlagi vrednosti lastnosti pogoja. To omogoča ustvarjanje logike, podobne konstruktom if() ali switch(). Lastnosti:

id

ID nove lastnosti (obvezno)

condition

ID lastnosti pogoja (obvezno)

Podrejeni elementi:

<true>

Če je lastnost pogoja boolovs vrednost, lahko podate dva podrejena elementa <true> in <false> (in samo te). (Obvezno, če je podan tudi <false>)

<false>

Če je lastnost pogoja boolova vrednost, lahko podate dva podrejena elementa <true> in <false> (in samo te). (Obvezno, če je podan tudi <true>)

<case>

Če lastnost pogoja ni boolova vrednost, lahko navedete poljubno število elementov <case>, enega za vsako vrednost lastnosti pogoja, ki jo želite ujemati (potreben je vsaj en tak element, če lastnost pogoja ni boolova)

<default>

Če lastnost pogoja ni boolova vrednost, neobvezni element <default> omogoča določitev vedenja, če se noben <case> element ne ujema z vrednostjo lastnosti pogoja (neobvezno, dovoljeno samo enkrat, v kombinaciji z enim ali več elementi <case>).

Podrejeni elementi <true>, <false>, <case> in <default> prevzamejo naslednje atribute:

standard

Samo za elemente <case>: Vrednost, ki se ujema z lastnostjo pogoja (obvezno, niz).

fixed_value

Fiksni niz, ki mora biti naveden kot vrednost lastnosti <switch>, če se trenutni pogoj ujema (obvezno, če dinamična_vrednost ni podana).

dynamic_value

id ciljne lastnosti, ki naj bo naveden kot vrednost lastnosti <switch>, če se trenutni pogoj ujema (obvezno, če ni podana fixed_value).

<connect>

Povezuje dve lastnosti. Lastnost odjemalca bo spremenjena vsakič, ko se spremeni lastnost guvernerja (vendar ne obratno). Lastnosti:

client

ID lastnosti stranke, tj. lastnost, ki bo prilagojena (obvezno)

governor

ID lastnosti guvernerja, tj. lastnost, ki bo prilagodila lastnost stranke. To lahko vključuje modifikator (obvezno)

reconcile

Če je "true", bo lastnost odjemalca prilagodila lastnosti guvernerja ob povezavi tako, da bo lastnost guvernerja sprejemala le vrednosti, ki jih sprejema tudi odjemalec (npr. predpostavimo, da je regulator številska lastnost z najmanjšo vrednostjo "0" ", odjemalec pa je številska lastnost z najmanjšo vrednostjo "100". Najmanjša vrednost obeh lastnosti bo prilagojena na 100, če je reconcile="true"). Na splošno deluje samo za lastnosti istega osnovnega tipa (neobvezno, privzeto je "false")

<dependency_check>

Ustvari boolovo lastnost, ki je true, če so podane odvisnosti izpolnjene, sicer pa false. Sintaksa elementa XML je enaka sintaksi elementa <dependencies>, ki je opisan v referenci .pluginmap. Od RKWard 0.6.1, samo RKWard in R upoštevane so specifikacije različice, ne pa odvisnosti od paketov ali pluginmap.

<skript>

Definirajte kodo skripta za nadzor logike uporabniškega vmesnika. Za podrobnosti glejte razdelek o skriptirani logiki GUJI. Kodo skripta za zagon je mogoče podati z uporabo atributa "file" ali kot (komentirano) besedilo elementa. Element <script> ni dovoljen v razdelku <logic> nabora možnosti optionset. Lastnosti:

file

Ime datoteke skriptne datoteke. (obvezno)