Element att använda i insticksprogrammets XML-beskrivning

Egenskaper som elementen innehåller listas i ett separat avsnitt.

Allmänna element

<document>

Måste finnas i alla beskrivning.xml-filer som rotnoden. Ingen specialfunktion. Inga egenskaper

<about>

Information om insticksprogrammet (upphovsman, licens, etc.). Elementet tillåts i både ett individuellt insticksprograms .xml-fil, och i .pluginmap-filer. Se .pluginmap filreferens för detaljerad referensinformation, och kapitlet om 'om' information för en introduktion.

<code>

Definierar var JS-mallen för insticksprogrammet kan hittas. Använd bara en gång per fil, som ett direkt underliggande objekt till taggen document. Egenskaper:

file

JS-mallens filnamn, relativt till katalogen som insticksprogrammets XML finns i

<help>

Definierar var hjälpfilen för insticksprogrammet kan hittas. Använd bara en gång per fil, som ett direkt underliggande objekt till taggen document. Egenskaper:

file

Hjälpfilens filnamn, relativt till katalogen som insticksprogrammets XML finns i

<copy>

Kan användas som underliggande objekt (direkt eller indirekt) till huvudelementen för layout, dvs. <dialog> och <wizard>. Används för att kopiera ett helt block av XML-element ett-till-ett. Egenskaper:

id

Id att söka efter. Taggen <copy> söker efter ett tidigare XML-element som har givits samma id, och kopierar det inklusive alla underliggande element.

copy_element_tag_name

I några få fall, vill man ha en nästan exakt kopia, men ändra taggnamnet på elementet som kopieras. Det viktigaste exemplet på det är när man vill kopiera en hel flik, <tab>, från ett dialoggränssnitt till en sida, <page>, i ett guidegränssnitt. I detta fall, skulle man ange copy_element_tag_name="page" för att automatiskt utföra konverteringen.

Gränssnittsdefinitioner

<dialog>

Definierar ett gränssnitt av dialogtyp. Placera definitionen av det grafiska användargränssnittet inne i taggen. Använd bara en gång per fil, som ett direkt underliggande objekt till taggen document. Åtminstone en av taggarna "dialog" eller "wizard" krävs för ett insticksprogram. Egenskaper:

label

Dialogrutans rubrik

recommended

Ska dialogrutan användas som det "rekommenderade" gränssnittet (dvs. gränssnittet som normalt visas, om användaren inte har ställt in RKWard att använda ett specifikt förvalt gränssnitt)? Egenskapen har inte någon effekt för närvarande, eftersom den implicit är "sann", om inte guiden rekommenderas.

<wizard>

Definierar ett gränssnitt av guidetyp. Placera definitionen av det grafiska användargränssnittet inne i taggen. Använd bara en gång per fil, som ett direkt underliggande objekt till taggen document. Åtminstone en av taggarna "dialog" eller "wizard" krävs för ett insticksprogram. Accepterar bara taggarna <page> eller <embed> som direkt underliggande objekt. Egenskaper:

label

Guidens rubrik

recommended

Ska guiden användas som det "rekommenderade" gränssnittet (dvs. gränssnittet som normalt visas, om användaren inte har ställt in RKWard att använda ett specifikt förvalt gränssnitt)? Valfri, förvalt värde är "false".

Layoutelement

Alla element i den här sektionen accepterar egenskapen id="identifierarsträng". Egenskapen är valfri för alla element. Den kan exempelvis användas för att dölja eller inaktivera hela layoutelementet och alla element som finns i det (se kapitlet om logik i det grafiska användargränssnittet). Id-strängen får inte innehålla "." (punkt) eller ";" (semikolon), och bör i allmänhet begränsas till alfanumeriska tecken och understreck ("_"). Bara ytterligare egenskaper listas.

<page>

Definierar en ny sida i en guide. Tillåts bara som ett direkt underliggande objekt av elementet <wizard>.

<row>

Alla direkt underliggande objekt till taggen "row" placeras från vänster till höger.

<column>

Alla direkt underliggande objekt till taggen "column" placeras uppifrån och ner.

<stretch>

Normalt upptar elementen i det grafiska användargränssnittet allt tillgängligt utrymme. Om man exempelvis har två kolumner sida vid sida, där den vänstra är fylld med element, medan den högra bara innehåller en ensam alternativknapp, <radio>, expanderas <radio>-knappen vertikalt även om den inte egentligen behöver det tillgängliga utrymmet, och det ser fult ut. I det här fallet vill man egentligen lägga till ett "tomrum" under <radio>-knappen. Använd elementet <stretch> för det. Det upptar helt enkelt ett visst utrymme. Använd inte elementet i onödan, oftast är det en god idé att låta elementen i det grafiska användargränssnittet få allt tillgängligt utrymme. Det är bara ibland som layouten blir utsträckt. Elementet <stretch> har inga argument, inte ens "id". Det går inte heller att placera några underliggande objekt inne i elementet <stretch> (med andra ord, används det bara som "<stretch/>").

<frame>

Ritar en ram eller ruta omkring sina direkt underliggande objekt. Kan användas för att visuellt gruppera relaterade alternativ. Layouten inne i en ram är uppifrån och ner, om man inte placerar en <row> inne i den. Egenskaper:

label

Ramens rubrik (valfri)

checkable

Ramar kan göras markeringsbara. I detta fall, inaktiveras alla ingående element när ramen avmarkeras, och aktiveras när den är markerad (valfri, förvalt värde "false")

checked

Bara för markeringsbara ramar: Ska ramen normalt vara markerad? Förvalt värde är "true". Tolkas inte för ramar som inte är markeringsbara.

<tabbook>

Organiserar elementen i en flikbok. Accepterar bara <tab>-taggar som direkt underliggande objekt.

<tab>

Definierar en sida i en flikbok. Placera flikens definition i det grafiska användargränssnittet inne i taggen. Kan bara användas som ett direkt underliggande objekt till taggen <tabbook>. En <tabbook> måste ha minst två flikar definierade. Egenskaper:

label

Fliksidans rubrik (krävs)

<text>

Visar texten innesluten i taggen i det grafiska användargränssnittet. Viss enkel HTML-liknande markering stöds (i synnerhet <b>, <i>, <p> och <br/>). Håll dock formatering till ett minimum. Att infoga en helt tom rad lägger till en hård radbrytning. Egenskaper:

type

Textens typ. Antingen "normal", "warning" (varning) eller "error" (fel). Det påverkar textens utseende (valfri, förvalt värde är normal)

Aktiva element

Alla element i den här sektionen accepterar egenskapen id="identifierarsträng". Egenskapen krävs för alla element. Bara ytterligare egenskaper listas. Id-strängen får inte innehålla "." (punkt).

<varselector>

Tillhandahåller en lista över tillgängliga objekt, där användaren kan välja ett eller flera. Kräver en eller flera <varslot> som motpart för att vara användbar. Egenskaper:

label

Beteckning för en varselector (valfri, förvalt värde är "Select variable(s)")

<varslot>

Används tillsammans med en "varselector" för att låta användare välja en eller flera variabler. Egenskaper:

label

Beteckning för en varslot (rekommenderas, förvalt värde är "Variable:")

source

Den varselector som valet hämtas från (krävs, om man inte ansluter manuellt eller använder source_property)

source_property

En godtycklig egenskap att kopiera värden från, när valknappen klickas. Om den anges, överskrider den egenskapen "source".

required

Om det krävs att en varslot innehåller ett giltigt värde för att verkställa koden. Se required-property (valfri, förvalt värde false)

multi

Om en varslot innehåller bara ett (förval, "false"), eller flera objekt

allow_duplicates

Om en varslot bara kan acceptera unika objekt (förval, "false"), eller om samma objekt kan läggas till flera gånger.

min_vars

Bara meningsfull om multi="true": Minimalt antal variabler som kan markeras för att markeringen ska anses giltig (valfri, förvalt värde "1")

min_vars_if_any

Bara meningsfull om multi="true": En varslot kan anses giltig om den exempelvis antingen är tom eller innehåller minst två värden. Det anger hur många variabler som måste väljas, om några överhuvudtaget (2 i exemplet). (valfri, förvalt värde "1")

max_vars

Bara meningsfull om multi="true": Minimalt antal variabler som kan markeras (valfri, förvalt värde "0", vilket betyder inget maximum)

classes

Om ett eller flera R klassnamn anges (åtskilda av mellanslag (" ")) här, accepterar denna varslot bara objekt som hör till klasserna (valfri, använd med stor försiktighet, användaren ska inte förhindras att göra giltiga val, och R har många olika klasser).

types

Om en eller flera variabeltyper anges (åtskilda med mellanslag (" ")) här, accepterar bara denna varslot objekt av typerna. Giltiga typer är "unknown", "number", "string", "factor", "invalid". (valfri, använd med stor försiktighet, användaren ska inte förhindras att göra giltiga val, och RKWard känner inte alltid till en variabels typ)

num_dimensions

Antal dimensioner som ett objekt måste ha. "0" (förvalt värde) betyder att godtyckligt antal dimensioner är acceptabla. (valfritt, förvalt värde "0")

min_length

Den minimala längden som ett objekt måste ha för att vara acceptabelt. (valfri, förvalt värde "0")

max_length

Den maximala längden som ett objekt måste ha för att vara acceptabelt. (valfri, förvalt värde är det största heltal som kan representeras i systemet)

<valueselector>

Tillhandahåller en lista över tillgängliga strängar (inte R-objekt) att väljas i en eller flera medföljande <valueslot>. Strängalternativ kan definieras genom att använda taggarna <option> som direkt underliggande objekt (se nedan), eller anges med dynamiska egenskaper. Egenskaper:

label

Beteckning för en valueselector (valfri, förvalt värde är ingen beteckning)

<valueslot>

Används tillsammans med en <valueselector> för att låta användaren välja ett eller flera strängobjekt. Elementet är i huvudsak identiskt med <varslot> och delar samma egenskaper, utom de som refererar till egenskaper för acceptabla objekt (dvs. klasser, typer, antal dimensioner, minimal längd, maximal längd).

<radio>

Definierar en grupp av exkluderande alternativknappar (bara en kan väljas åt gången). Kräver minst två <option>-taggar som direkt underliggande objekt. Inga andra taggar tillåts som underliggande objekt. Egenskaper:

label

Alternativknapparnas beteckning (rekommenderas, förvalt värde "Select one:")

<dropdown>

Definierar en grupp alternativ där ett och endast ett kan väljas åt gången, med en kombinationslista. Den är funktionellt ekvivalent med en <radio>, men ser annorlunda ut. Kräver minst två <option>-taggar som direkt underliggande objekt. Inga andra taggar tillåts som underliggande objekt. Egenskaper:

label

Kombinationslistans beteckning (rekommenderas, förvalt värde "Select one:")

<select>

Tillhandahåller en lista över tillgängliga strängar där användaren kan välja ett godtyckligt antal. Strängalternativ kan definieras genom att använda <option>-taggar som direkt underliggande objekt (se nedan), eller anges med dynamiska egenskaper. Egenskaper:

label

Beteckning för <select> (valfri, förval är ingen beteckning)

enkel

Om satt till sant, går det bara att välja ett enda värde, istället för flera värden på en gång (Booleskt, förvalt värde falskt)

<option>

Kan bara användas som ett direkt underliggande objekt till elementen <radio>, <dropdown>, <valueselector> eller <select>. Representerar ett valbart alternativ i en alternativknapp eller kombinationslista. Eftersom elementen <option> alltid ingår som en del av ett av urvalselementen, har de normalt ingen egen "id", men se nedan. Egenskaper:

label

Alternativets beteckning (krävs)

value

Strängvärdet det överliggande objektet returnerar om alternativet är markerat eller valt (krävs)

checked

Om alternativet normalt ska vara markerat/valt, "true" eller "false". I en <radio> eller <dropdown>, kan bara ett alternativ anges som checked="true", och om inget alternativ är angett som markerat, blir det första alternativet i det överliggande objektet automatiskt markerat/valt. I en <select> kan godtyckligt antal alternativ anges som markerade. (valfritt, förvalt värde "false")

id

Att ange "id" parametrar för <option>-element är valfritt (och det rekommenderas i själva verket att inte ange "id", om det inte verkligen behövs). Dock blir det möjligt att aktivera/inaktivera en <option> dynamiskt om "id" anges, genom att ansluta till den Booleska egenskapen id_of_radio.id_of_optionX.enabled. För närvarande fungerar det bara för egenskaper inne i elementen <radio> och <dropdown>. Alternativen <valueselector> och <select> stöder för närvarande inte "id".

<checkbox>

Definierar en kryssruta, dvs. ett enstaka alternativ som antingen kan vara av eller på. Egenskaper:

label

Kryssrutans beteckning (krävs)

value

Värdet som kryssrutan returnerar om den är markerad (krävs)

value_unchecked

Värdet som returneras om kryssrutan inte är markerad (valfritt, förvalt värde är "", dvs. en tom sträng)

checked

Om alternativet normalt ska vara markerat, "true" eller "false" (valfritt, förvalt värde "false")

<frame>

Ramelementet används i allmänhet som ett rent layoutelement och det listas i avsnittet om layoutelement. Det kan dock också göras markeringsbart, och sålunda samtidigt fungera som en enkel kryssruta.

<input>

Definierar ett fritt inmatningsfält. Egenskaper:

label

Inmatningsfältets beteckning (krävs)

initial

Textfältets ursprungliga text (valfri, förvalt värde "", dvs. en tom sträng)

size

Ett av "small", "medium", or "large". "large" definierar ett inmatningsfält med flera rader, medan "small" och "medium" är fält med en rad (valfri, förvalt värde "medium")

required

Om det krävs att indata inte är tomt för att verkställa koden. Se required-property (valfri, förvalt värde false)

<matrix>

En tabell för att mata in matrisdata (eller vektorer) i det grafiska användargränssnittet.

Notera

Det här inmatningselementet är inte optimerat för att mata in eller redigera stora mängder data. Även om det inte finns någon fast gräns för storleken hos matrisen <matrix>, bör den i allmänhet inte överstiga omkring tio rader eller kolumner. Om du förväntar dig mer data, låt användaren välja den som ett R-objekt (vilket kan vara en god idé som ett alternativ vid nästan alla tillfällen då ett matriselement används).

Egenskaper:

label

Tabellens beteckning (krävs)

mode

Ett av "integer", "real", or "string". Typ av data som accepteras i tabellen (krävs)

min

Minimalt acceptabelt värde (för matriser av typ "integer" eller "real") (valfritt, förvalt värde är det minsta värde som kan representeras)

max

Maximalt acceptabelt värde (för matriser av typ "integer" eller "real") (valfritt, förvalt värde är det största värde som kan representeras)

allow_missings

Om saknade (tomma) värden tillåts i matrisen. Det är underförstått för matriser av typen "string" (valfritt, förvalt värde false).

allow_user_resize_columns

När satt till sant, kan användaren lägga till kolumner genom att skriva i (inaktiva) cellerna längst till höger (valfritt, förvalt värde är true).

allow_user_resize_rows

När satt till sant, kan användaren lägga till rader genom att skriva i (inaktiva) cellerna längst ner (valfritt, förvalt värde är true).

rows

Antal rader i matrisen. Har ingen effekt med allow_user_resize_rows="true".

Notera

Kan också bestämmas genom att ange egenskapen "rows"

(valfritt, förvalt värde 2).

columns

Antal kolumner i matrisen. Har ingen effekt med allow_user_resize_columns="true".

Notera

Kan också bestämmas genom att ange egenskapen "columns"

(valfritt, förvalt värde 2).

min_rows

Minimalt antal rader i matrisen. Matrisen vägrar att krympa under den här storleken (valfritt, förvalt värde 0, se också: allow_missings).

min_columns

Minimalt antal kolumner i matrisen. Matrisen vägrar att krympa under den här storleken (valfritt, förvalt värde 0, se också: allow_missings).

fixed_height

Tvinga elementet i det grafiska användargränssnittet att behålla sin ursprungliga höjd. Använd det inte i kombination med matriser, där antal rader kan ändras på vilket sätt som helst. Användbar i synnerhet när ett inmatningselement för en vektor skapas (columns="1"). När alternativet är satt till true, visas ingen horisontell rullningslist, även om matrisen överskrider tillgänglig bredd (eftersom det skulle påverka höjden). (valfritt, förvalt värde false).

fixed_width

Något felaktigt benämnt: Antag att kolumnantalet inte kommer att ändras. Den sista (eller oftast enda) kolumnen sträcks ut för att uppta hela tillgängliga bredden. Använd det inte i kombination med matriser, där antal kolumner kan ändras på vilket sätt som helst. Användbar i synnerhet när ett inmatningselement för en vektor skapas (rows="1"). (valfritt, förvalt värde false).

horiz_headers

Strängar att använda för den horisontella rubriken, åtskilda av ";". Rubriken döljes om satt till "". (valfri, förvalt värde är kolumnens nummer).

vert_headers

Strängar att använda för den vertikala rubriken, åtskilda av ";". Rubriken döljes om satt till "". (valfri, förvalt värde är radens nummer).

<optionset>

Ett användargränssnitt för att upprepa en mängd alternativ för ett godtyckligt antal objekt (Introduktion av optionsets). Egenskaper:

min_rows

Om angiven, markeras mängden som ogiltig, om den inte har åtminstone så här många rader (valfri, heltal).

min_rows_if_any

Som min_rows, men testas bara om det finns minst en rad (valfri, heltal).

max_rows

Om angiven kommer mängden att markeras som ogiltig, om den inte har som mest det här antalet rader (valfri, heltal).

keycolumn

Id för kolumnen som ska fungera som keycolumn. Ett optionset med en (giltig) keycolumn, fungerar som ett "drivet" optionset. Ett optionset utan keycolumn tillåter att manuellt infoga eller ta bort objekt. En keycolumn måste vara markerad som external. (valfri, förvalt värde är ingen keycolumn).

Delelement:

<optioncolumn>

Deklarerar en optioncolumn i mängden. För varje värde som ska hämtas från ett optionset, måste en separat <optioncolumn> deklareras. Egenskaper:

id

Id för en optioncolumn (krävs, sträng)

external

Sätt till sann, om en optioncolumn kontrolleras utifrån optionset (valfri, Boolean, förvalt värde är "false").

label

Om angiven visas en optioncolumn i en kolumn enligt beteckningen (valfri, sträng, förvalt värde är att inte visa den).

connect

Egenskap att ansluta till optioncolumn to, angiven som id inne i området <content>. För en extern <optioncolumn> ändras motsvarande värde till det externt inställda värdet. För en vanlig (inte extern) <optioncolumn> ändras motsvarande rad i <optioncolumn>-egenskapen när egenskapen ändras inne i innehållsområdet (valfri, sträng, förvalt värde är inte ansluten).

default

Bara för externa kolumner: Värdet att anta för kolumnen, om inget värde är känt för en post. Sällan användbar (valfri, förvalt värde är en tom sträng).

<content>

Deklarera innehållet i användargränssnittet/mängden. Inga egenskaper. Alla vanliga aktiva, passiva och layoutelement tillåts som underliggande namnelement. Dessutom tilläts det särskilda underliggande elementet <optiondisplay> i tidigare versioner av RKWard (till och med 0.6.3). Det är föråldrat i RKWard 0.6.4, och ska helt enkelt tas bort från befintliga insticksprogram.

<logic>

Valfri specifikation av logik i användargränssnitt som gäller inne i innehållsregionen för ett optionset. Se referensen om <logic>.

<browser>

Ett element konstruerat att välja ett enda filnamn (eller katalognamn). Observera att fältet accepterar vilken sträng som helst, även om det är avsett att bara användas för filer:

label

Bläddrarens beteckning (valfri, förvalt värde "Enter filename")

initial

Initialvärdet för texten i bläddraren (valfritt, förvalt värde "", dvs. en tom sträng)

type

Ett av "file", "dir" eller "savefile". För att välja respektive en befintlig fil, befintlig katalog eller icke-befintlig fil (valfri, förvalt värde "file")

allow_urls

Om (icke-lokala) webbadresser kan väljas (valfri, förvalt värde "false")

filter

Filtypsfilter, t.ex. ("*.txt *.csv" för .txt- och .csv-filer). En separat post för "Alla filer" läggs till automatiskt (valfritt, förvalt värde är "", dvs. Alla filer)

required

Om det krävs att fältet inte är tomt för att verkställa koden. Observera att det inte nödvändigtvis betyder att det valda filnamnet är giltigt. Se required-property (valfri, förvalt värde true)

<saveobject>

Ett element konstruerat för att välja namnet på ett R-objekt att spara i (dvs. i allmänhet inte redan befintligt, i motsats till en varslot):

label

Inmatningsrutans beteckning (valfri, förvalt värde "Save to:")

initial

Initialvärdet för texten i inmatningsrutan (valfritt, förvalt värde "my.data")

required

Om det krävs att fältet innehåller ett tillåtet objektnamn för att verkställa koden. Se required-property (valfri, förvalt värde true)

checkable

I många användarfall är det valfritt att spara i ett R-objekt. I dessa fall kan en kryssruta integreras i saveobject-elementet genom att använda egenskapen. När den är satt till true, aktiveras/inaktiveras saveobject-elementet av kryssrutan. Se egenskapen active för saveobject (valfri, förvalt värde false)

checked

Bara för markeringsbara saveobject-element: Om objektet normalt är markerat eller aktiverad (valfritt, förvalt värde är "false")

<spinbox>

En nummerruta där användaren kan välja ett numeriskt värde, antingen genom att använda direkt tangentbordsinmatning eller små uppåt- och neråtpilar. Egenskaper:

label

Nummerrutans beteckning (rekommenderas, förvalt värde "Enter value:")

min

Det minsta värde som användaren får mata in i nummerrutan (valfritt, förval är det minsta värdet som tekniskt kan representeras i nummerrutan)

max

Det största värde som användaren får mata in i nummerrutan (valfritt, förval är det största värdet som tekniskt kan representeras i nummerrutan)

initial

Initialvärdet som visas i nummerrutan (valfritt, förvalt värde "0")

type

Antingen "real" eller "integer". Om nummerrutan accepterar reella tal eller bara heltal (valfritt, förvalt värde är "real")

default_precision

Bara meningsfull om nummerrutan har type="real". Anger förvalt antal decimalsiffror som visas i nummerrutan (bara så här många avslutande nollor visas). När användaren klickar på uppåt- eller neråtpilen, ändras decimalsiffrorna. Användaren kan dock ändå mata in värden med större precision (se nedan) (valfri, förvalt värde "2")

max_precision

Det maximala antalet siffror som kan representeras på ett meningsfullt sätt (valfritt, förvalt värde är "8")

<formula>

Det här avancerade elementet tillåter användaren att välja en formel eller interaktionsmängd från valda variabler. För en GLM kan elementet exempelvis användas för att tillåta användaren att ange modellens interaktionstermer. Egenskaper:

fixed_factors

Id för den varslot som innehåller de markerade förbestämda faktorerna (krävs)

dependent

Id för den varslot som innehåller den valda beroende variabeln (krävs)

<embed>

Inbädda ett annat insticksprogram i det här (se kapitlet om inbäddning). Egenskaper:

component

Det registrerade namnet på komponenten att inbädda (se kapitlet om att registrera komponenter) (krävs)

as_button

Om satt till "true", läggs bara en tryckknapp till i det inbäddande grafiska användargränssnittet, det inbäddade grafiska användargränssnittet visas bara (i ett separat fönster) när tryckknappen klickas (valfri, förvalt värde är "false")

label

Bara meningsfull om as_button="true": Knappens beteckning (rekommenderas, förvalt värde är "Options")

<preview>

Kryssruta för att byta förhandsgranskningsfunktionalitet. Från version 0.6.5 av RKWard hanteras förhandsgranskningselement med <preview> speciellt i insticksprogrammens dialogrutor (inte guider). De placeras i knappkolumnen, oberoende av exakt var de definieras i användargränssnittet. Det är ändå en bra idé att definiera dem på ett vettigt ställe i layouten, för bakåtkompatibilitet.

label

Rutans beteckning (valfri, förvalt värde är "Preview")

mode

Typ av förhandsgranskning. Typer som stöds är "plot" (se kapitlet om förhandsgranskning av diagram), "output" (se kapitlet om förhandsgranskning av HTML-)utmatning), "data" (se förhandsgranskning av data) och "custom" (se anpassade förhandsgranskningar). (valfri, förvalt värde är "plot")

placement

Förhandsgranskningens placering: "attached" (ansluten till huvudarbetsplatsen), "detached" (fristående fönster), "docked" (ansluten till insticksprogrammets dialogruta) och "default" (för närvarande samma som "docked", men kan komma att bli möjligt att ställa in av användaren vid något tillfälle). I allmänhet rekommenderas att låta den förbli default, för bästa möjliga likformighet i användargränssnittet (valfri, förvalt värde är "default")

active

Om förhandsgranskningen normalt är aktiv. I allmänhet bör bara dockade förhandsgranskningar göras normalt aktiva, och till och med för dem finns en orsak att det normala värdet är inaktiva förhandsgranskningar (valfritt, förvalt värde är "false")

Logiksektion

<logic>

Det omgivande elementet för logiksektionen. Alla element nedan tillåts bara inne i elementet <logic>. Elementet <logic> tillåts bara som ett direkt underliggande objekt till <document>-elementet (som mest en gång per document), eller till <optionset>-element (som mest en gång per optionset). Dokumentets logiksektion gäller för både de grafiska användargränssnitten i <dialog> och <wizard> på samma sätt.

<external>

Skapar en ny (sträng)egenskap som är avsedd att anslutas till en egenskap utanför om insticksprogrammet inbäddas. Se avsnittet om ofullständiga insticksprogram. Egenskaper:

id

Den nya egenskapens id (krävs)

default

Den nya egenskapens förvalda strängvärde, dvs. värdet som används om egenskapen inte är ansluten till en egenskap utanför (valfri, förvalt värde är en tom sträng)

<i18n>

Skapar en ny (sträng)egenskap som är avsedd att tillhandahålla en beteckning som använder i18n. Egenskaper:

id

Den nya egenskapens id (krävs)

label

Beteckningen. Den kommer att översättas (krävs).

<set>

Ställ in en egenskap till ett konstant värde (om egenskapen dessutom ansluts till någon annan egenskap förblir naturligtvis inte värdet konstant). Om ett insticksprogram exempelvis inbäddas, men man vill dölja vissa av dess element, kan synlighetsegenskapen för elementen ställas in till false. Användbar i synnerhet för inbäddade och inbäddande insticksprogram. Observera: Om det finns flera <set>-element för en enda id, gäller den som definieras sist. Det kan ibland vara användbart att förlita sig på när inkluderade delar med <include> används. Egenskaper:

id

Egenskapens id som ska tilldelas (krävs)

to

Strängvärdet att tilldela egenskapen (krävs). Observera: För Booleska egenskaper som synlighet och aktivering, anges egenskapen antingen som to="true" eller to="false".

<convert>

Skapa en ny Boolesk egenskap som beror på tillståndet hos en eller flera egenskaper. Egenskaper:

id

Den nya egenskapens id (krävs)

sources

Id för egenskaperna som den här egenskapen kommer att bero på. En eller flera egenskaper kan anges, åtskilda med ";" (krävs)

mode

Metoden för konverteringen/operationen. Ett av "equals", "notequals", "range", "and", "or". Med metoden equals, är egenskapen bara sann om värdet på alla dess källor är lika med egenskapen standard (se nedan). Med metoden notequals, är egenskapen bara sann om värdet på alla dess källor skiljer sig från egenskapen standard (se nedan). Med metoden range, måste källorna vara numeriska (heltal eller reella tal). Egenskapen är bara sann om alla källor är inom intervallet angivet av egenskaperna min och max (se nedan). Med metoden and, måste källorna vara Booleska egenskaper. Egenskapen är bara sann om alla källor samtidigt är sanna. Med metoden or, måste källorna vara Booleska egenskaper. Egenskapen är bara sann om minst en av källorna är sann. (krävs)

standard

Bara meningsfull för lägena equals eller notequals: Strängvärdet att jämföra med (krävs för något av dessa lägen)

min

Bara meningsfull för läget "range": Det minimala värdet att jämföra med (valfritt, förvalt värde är det minsta flyttalet som datorn kan representera)

max

Bara meningsfull för läget "range": Det maximala värdet att jämföra med (valfritt, förvalt värde är det största flyttalet som datorn kan representera)

require_true

Om satt till "true", kommer egenskapen att krävas, och anses bara giltig om dess tillstånd är "true" eller "on". Sålunda blockerar egenskapen knappen Verkställ om den är falsk (valfri, förvalt värde "false").

Observera

Om det används, se till att användaren enkelt kan detektera vad som är fel, genom att exempelvis visa en förklarande <text>.

<switch>

Skapa en ny egenskap som vidarebefordrar till olika målegenskaper (eller förbestämda strängar) baserat på villkorsegenskapens värde. Det gör det möjligt att skapa logik som liknar konstruktionerna if() eller switch(). Egenskaper:

id

Den nya egenskapens id (krävs)

villkor

Villkorsegenskapens id (krävs)

Underliggande element:

<true>

Om villkorsegenskapen är Boolesk, kan två de underliggande elementen <true> och <false> anges (och bara dessa) (Krävs om <false> också anges).

<false>

Om villkorsegenskapen är Boolesk, kan två de underliggande elementen <true> och <false> anges (och bara dessa) (Krävs om <true> också anges).

<case>

Om villkorsegenskapen inte är Boolesk, kan ett godtyckligt antal element av typen <case> anges, ett för varje värde på villkorsegenskapen som ska matchas (åtminstone ett sådant element krävs om villkorsegenskapen inte är Boolesk)

<default>

Om villkorsegenskapen inte är Boolesk, gör det valfria elementet <default> det möjligt att ange beteendet om inget av elementen av typen <case> matchar villkorsegenskapens värde (valfri, tillåts bara en gång i kombination med ett eller flera element av typen <case>).

Underliggande elementen <true>, <false>, <case>, och <default> har följande egenskaper:

standard

Bara för element av typen <case>. Värdet som villkorsegenskapen ska matchas mot (krävs, sträng).

fixed_value

En bestämd sträng som ska anges som värdet på egenskapen <switch>, om om det aktuella villkoret matchar (krävs om dynamic_value inte anges).

dynamic_value

Målegenskapens id som anges som värdet på egenskapen <switch>, om det aktuella villkoret matchar (krävs, om fixed_value inte anges).

<connect>

Ansluter två egenskaper. Klientegenskapen ändras så fort den styrande egenskapen ändras (men inte det omvända). Egenskaper:

client

Klientegenskapens id, dvs. egenskapen som justeras (krävs)

governor

Den styrande egenskapens id, dvs. egenskapen som justerar klientegenskapen. Det kan inkludera en modifierare (krävs)

reconcile

Om "true", justerar klientegenskapen den styrande egenskapen i anslutningen på ett sådant sätt att den styrande egenskapen bara accepterar värden som också är acceptabla av klienten (antag t.ex. att den styrande egenskapen är en numerisk egenskap med minimalt värde "0", och klienten är en numerisk egenskap med minimalt värde "100". Minimum för båda egenskaperna justeras till 100 om reconcile="true"). I allmänhet fungerar det bara för egenskaper med samma grundtyp (valfri, förvalt värde "false")

<dependency_check>

Skapar en Boolesk egenskap som är sann om angivna beroenden uppfylls, och annars falsk. Elementets XML-syntax är likadan som för elementet <dependencies>, beskriven i .pluginmap-referensen. Från RKWard 0.6.1 tas bara hänsyn till versionerna för RKWard och R, inte beroenden av paket eller pluginmaps.

<script>

Definiera skriptkoden för att kontrollera användargränssnittets logik. Se avsnittet om skriptbaserad logik för det grafiskt användargränssnittet för detaljerad information. Skriptkoden att köra kan antingen anges med egenskapen "file" eller som en (kommenterad) text i elementet. Elementet <script> tillåts inte i sektionen <logic> i ett optionset. Egenskaper:

file

Skriptfilens filnamn (krävs).