Elementos a serem usados ​​na descrição XML do plugin

As propriedades mantidas pelos elementos são listadas em uma seção separada.

Elementos gerais

<document>

Precisa estar presente em cada arquivo description.xml como nó raiz. Sem função especial. Sem atributos.

<about>

Informações sobre este plugin (autor, licença, etc..). Este elemento é permitido tanto no arquivo .xml de um plugin individual quanto nos arquivos .pluginmap. Consulte a referência do arquivo .pluginmap para obter detalhes de referência e o o capítulo sobre informações do 'about' para uma introdução.

<code>

Define onde procurar o modelo JS para o plugin. Use apenas uma vez por arquivo, como filho direto da tag document. Atributos:

file

Nome do arquivo do modelo JS, relativo ao diretório onde o arquivo xml do plugin está localizado.

<help>

Define onde procurar o arquivo de ajuda do plugin. Use apenas uma vez por arquivo, como um filho direto da tag document. Atributos:

file

Nome do arquivo de ajuda, relativo ao diretório onde o arquivo xml do plugin está localizado.

<copy>

Pode ser usado como filho (direto ou indireto) dos elementos de layout principais, isto é, <dialog> e <wizard>. Isso é usado para copiar um bloco inteiro de elementos XML 1:1. Atributos:

id

O ID a ser procurado. A tag <copy> procurará um elemento XML anterior que tenha recebido o mesmo ID e o copiará, incluindo todos os elementos descendentes.

copy_element_tag_name

Em alguns casos, você desejará uma cópia quase literal, mas alterará o nome da tag do elemento a ser copiado. O exemplo mais importante disso é quando você deseja copiar uma <tab> inteira de uma interface de diálogo para a <page> de uma interface de assistente. Nesse caso, você definiria copy_element_tag_name="page" para fazer essa conversão automaticamente.

Definições da interface

<dialog>

Define uma interface do tipo diálogo. Coloque a definição GUI dentro desta tag. Use apenas uma vez por arquivo, como filho direto da tag document. Pelo menos uma das tags "dialog" ou "wizard" é necessária para um plugin. Atributos:

label

Legenda para o diálogo

recommended

O diálogo deve ser usado como a interface "recomendada" (isto é, a interface que será exibida por padrão, a menos que o usuário tenha configurado o RKWard para usar uma interface específica por padrão)? Este atributo não tem efeito atualmente, pois é implicitamente "verdadeiro", a menos que o assistente seja recomendado.

<wizard>

Define uma interface do tipo assistente. Coloque a definição da GUI dentro desta tag. Use apenas uma vez por arquivo, como filho direto da tag document. Pelo menos uma das tags "dialog" ou "wizard" é necessária para um plugin. Aceita apenas tags <page> ou <embed> como filhos diretos. Atributos:

label

Legenda para o assistente

recommended

O assistente deve ser usado como a interface "recomendada" (isto é, a interface que será exibida por padrão, a menos que o usuário tenha configurado o RKWard para usar uma interface específica por padrão)? Opcional, o padrão é "false".

Elementos do layout

Todos os elementos desta seção aceitam um atributo id="identifierstring". Este atributo é opcional para todos os elementos. Ele pode ser usado, por exemplo, para ocultar/desativar todo o elemento de layout e todos os elementos contidos nele (consulte o capítulo lógica da GUI). A string de identificação não pode conter "." (ponto) ou ";" (ponto e vírgula) e deve geralmente ser limitada a caracteres alfanuméricos e ao sublinhado ("_"). Apenas os atributos adicionais estão listados.

<page>

Define uma nova página dentro de um assistente. Só é permitido como filho direto de um elemento <wizard>.

<row>

Todos os filhos diretos de uma tag "row" serão colocados da esquerda para a direita.

<column>

Todos os filhos diretos de uma tag "column" serão colocados de cima para baixo.

<stretch>

Por padrão, os elementos da GUI ocupam todo o espaço disponível. Por exemplo, se você tiver duas colunas lado a lado, a da esquerda está repleta de elementos, mas a da direita contém apenas um botão de opção (<radio>), o controle <radio> se expandirá verticalmente, mesmo que não precise do espaço disponível, e ficará com uma aparência ruim. Nesse caso, você realmente deseja adicionar um espaço em branco abaixo do <radio>. Para isso, use o elemento <stretch>. Ele simplesmente ocupará um pouco de espaço. Não abuse desse elemento, geralmente é uma boa prática que os elementos da GUI ocupem todo o espaço disponível, apenas ocasionalmente o layout ficará espaçado. O elemento <stretch> não aceita nenhum argumento, nem mesmo um "id". Além disso, você não pode colocar nenhum filho dentro do elemento <stretch> (em outras palavras, você o usará apenas como "<stretch/>").

<frame>

Desenha uma moldura/caixa ao redor de seus filhos diretos. Pode ser usado para agrupar visualmente opções relacionadas. O layout dentro de uma moldura é de cima para baixo, a menos que você coloque uma <row> dentro dela. Atributos:

label

Legenda para a moldura (opcional)

checkable

Os frames podem ser marcados. Nesse caso, todos os elementos contidos neles serão desativados quando o frame estiver desmarcado e ativados quando estiver marcado. (opcional, o padrão é "false")

checked

Somente para frames marcáveis: Se o frame deve ser marcado por padrão? O padrão é "true". Não é interpretado para frames não marcáveis.

<tabbook>

Organiza elementos em um livro de abas. Aceita apenas tags <tab> como filhos diretos.

<tab>

Você define a página em um livro de abas. Coloque a definição da GUI para a aba dentro desta tag. Pode ser usada apenas como filha direta de uma tag <tabbook>. Em um <tabbook>, deve haver pelo menos duas abas definidas. Atributos:

label

Legenda para a página da aba (obrigatória)

<text>

Exibe o texto contido nesta tag na GUI. Algumas marcações simples em estilo HTML são suportadas (principalmente <b>, <i>, <p> e <br/>). No entanto, mantenha a formatação ao mínimo. Inserir uma linha completamente vazia adiciona uma quebra de linha. Atributos:

type

Tipo de texto. Um dos seguintes: "normal", "aviso" ou "erro". Isso influencia a aparência do texto (opcional, o padrão é normal)

Elementos ativos

Todos os elementos desta seção aceitam um atributo id="identifierstring". Este atributo é obrigatório para todos os elementos. Somente os atributos adicionais estão listados. A string de identificação não pode conter "." (pontos).

<varselector>

Fornece uma lista de objetos disponíveis a partir da qual o usuário pode selecionar um ou mais. Requer um ou mais <varslots> como contrapartida para ser útil. Atributos:

label

Legenda para o seletor de variáveis ​​(opcional, o padrão é "Selecionar variável(eis)")

<varslot>

Usado em conjunto com um "seletor de variáveis" para permitir que o usuário selecione uma ou mais variáveis. Atributos:

label

Legenda para o varslot (recomendado, o padrão é "Variável:")

source

O seletor de variáveis ​​para obter a seleção (obrigatório, a menos que você se conecte manualmente ou usando source_property)

source_property

Uma propriedade arbitrária da qual copiar valores quando o botão de seleção é clicado. Se especificada, esta propriedade substitui o atributo "source".

required

Se - para submeter o código - é necessário que este varslot contenha um valor válido. Consulte required-property (opcional, o padrão é falso)

multi

Indica se o varslot contém apenas um objeto (padrão, "false") ou vários objetos

allow_duplicates

Se o varslot pode aceitar apenas objetos únicos (padrão, "false") ou se o mesmo objeto pode ser adicionado várias vezes.

min_vars

Só faz sentido se multi="true": Número mínimo de variáveis ​​a serem selecionadas para que a seleção seja considerada válida (opcional, o padrão é "1")

min_vars_if_any

Só faz sentido se multi="true": Alguns espaços para variáveis ​​podem ser considerados válidos, se, por exemplo, o espaço para variáveis ​​estiver vazio ou contiver pelo menos dois valores. Isso especifica quantas variáveis ​​devem ser selecionadas, se houver alguma (2 no exemplo). (opcional, o padrão é "1")

max_vars

Só faz sentido se multi="true": Número máximo de variáveis ​​a selecionar (opcional, o padrão é "0", o que significa que não há máximo)

classes

Se você especificar um ou mais nomes de classe R (separados por espaços (" ")), aqui, o varslot aceitará apenas objetos pertencentes a essas classes (opcional, use com muita cautela, o usuário não deve ser impedido de fazer escolhas válidas, e R possui muitas classes diferentes)

types

Se você especificar um ou mais tipos de variáveis ​​(separados por espaços (" ")), aqui, o varslot aceitará apenas objetos desses tipos. Os tipos válidos são "unknown", "number", "string", "factor", "invalid". (Opcional, use com muita cautela, o usuário não deve ser impedido de fazer escolhas válidas, e o RKWard nem sempre sabe o tipo de uma variável)

num_dimensions

O número de dimensões que um objeto precisa ter. "0" (o padrão) Significa que qualquer número de dimensões é aceitável. (opcional, o padrão é "0")

min_length

O comprimento mínimo que um objeto precisa ter para ser aceitável. (opcional, o padrão é "0")

max_length

O comprimento máximo que um objeto precisa ter para ser aceitável. (opcional, o padrão é o maior número inteiro representável no sistema)

<valueselector>

Fornece uma lista de strings disponíveis (não objetos R) para serem selecionadas em um ou mais <valueslots> acompanhantes. As opções de string podem ser definidas usando tags <option> como filhos diretos (veja abaixo) ou definidas usando propriedades dinâmicas. properties. Atributos:

label

Legenda para o seletor de valores (opcional, o padrão é nenhuma legenda)

<valueslot>

Usado em conjunto com um <valueselector> para permitir que o usuário selecione um ou mais itens de string. Este elemento é praticamente idêntico a <varslot>, e compartilha os mesmos atributos, exceto aqueles que se referem às propriedades dos itens aceitáveis ​​(ou seja, classes, tipos, num_dimensions, min_length, max_length).

<radio>

Define um grupo de botões exclusivos de rádio (apenas um pode ser selecionado por vez). Requer pelo menos duas tags <option> como filhos diretos. Nenhuma outra tag é permitida como filho. Atributos:

label

Legenda para o controle remoto (recomendado, o padrão é "Selecione uma opção:")

<dropdown>

Define um grupo de opções, das quais apenas uma pode ser selecionada por vez, usando uma lista suspensa. Isso é funcionalmente equivalente a um <radio>, mas tem uma aparência diferente. Requer pelo menos duas tags <option> como filhos diretos. Nenhuma outra tag é permitida como filha. Atributos:

label

Legenda para a lista suspensa (recomendado, o padrão é "Selecione uma opção:")

<select>

Fornece uma lista de strings disponíveis a partir das quais o usuário pode selecionar um número arbitrário. As opções de string podem ser definidas usando tags <option> como filhos diretos (veja abaixo) ou definidas usando properties dinâmicas. Atributos:

label

Legenda para o <select> (opcional, o padrão é nenhuma legenda)

single

Se definido como verdadeiro, apenas um único valor poderá ser selecionado, em vez de vários valores simultaneamente. (booleano, padrão é falso)

<option>

Só pode ser usado como filho direto de um elemento <radio>, <dropdown>, <valueselector> ou <select>. Representa uma opção selecionável em um controle de rádio ou lista suspensa. Como os elementos <option> são sempre parte de um dos elementos de seleção, eles normalmente não têm um "id" próprio, mas veja abaixo. Atributos:

label

Legenda para a opção (obrigatória)

value

O valor da string que o elemento pai retornará se esta opção estiver marcada/selecionada (obrigatório)

checked

Indica se a opção deve ser marcada/selecionada por padrão "true" ou "false". Em um <radio> ou <dropdown>, apenas uma opção pode ser definida como checked="true", e se nenhuma opção for definida como marcada, a primeira opção no elemento pai será marcada/selecionada automaticamente. Em um <select>, qualquer número de opções pode ser definido como marcado. (opcional, padrão "false")

id

Especificar o "id" do parâmetro para os elementos <option> é opcional (e, na verdade, é recomendado não definir um "id", a menos que você realmente precise de um). No entanto, especificar um "id" permitirá que você habilite/desabilite <option> dinamicamente, conectando-se à propriedade booleana id_of_radio.id_of_optionX.enabled. Atualmente, isso funciona apenas para opções dentro de elementos <radio> ou <dropdown>. As opções <valueselector> e <select> não suportam IDs no momento.

<checkbox>

Define uma caixa de seleção, isto é, uma única opção que pode ser ativada ou desativada. Atributos:

label

Legenda para a caixa de seleção (obrigatória)

value

O valor que a caixa de seleção retornará se estiver marcada (obrigatório)

value_unchecked

O valor que será retornado se a caixa de seleção não estiver marcada (opcional, o padrão é "", isto é, uma string vazia)

checked

Indica se a opção deve ser marcada por padrão como "verdadeiro" ou "falso" (opcional, padrão "falso")

<frame>

O elemento frame é geralmente usado como um elemento de layout puro e está listado na seção sobre elementos de layout. No entanto, ele também pode ser marcado, funcionando assim como uma caixa de seleção simples. Ao mesmo tempo,

<input>

Define um campo de entrada de texto livre. Atributos:

label

Legenda para o campo de entrada (obrigatória)

initial

Texto inicial do campo de texto (opcional, o padrão é "", ou seja, uma string vazia)

size

Uma das opções "small" (pequeno), "medium" (médio) ou "large" (grande). "Grande" define um campo de entrada com várias linhas, "pequeno" e "médio" são campos de linha única (opcional, o padrão é "medium")

required

Se - para submeter o código - é necessário que esta entrada não esteja vazia. Consulte required-property (opcional, o padrão é falso)

<matrix>

Uma tabela para inserir dados matriciais (ou vetores) na GUI.

Nota

Este elemento de entrada não está otimizado para inserir/editar grandes quantidades de dados. Embora não haja um limite estrito para o tamanho de uma <matrix>, em geral, ela não deve exceder cerca de dez linhas/colunas. Se você espera dados maiores, permita que os usuários os selecionem como um objeto R (o que pode ser uma boa ideia como opção alternativa, em quase todos casos em que você usa um elemento de matriz).

Atributos:

label

Legenda para a tabela (obrigatória)

mode

Um dos seguintes valores: "integer" (inteiro), "real" ou "string". O tipo de dados que será aceito na tabela (obrigatório)

min

Valor mínimo aceitável (para matrizes do tipo "inteiro" ou "real") (opcional, o padrão é o menor valor representável)

max

Valor máximo aceitável (para matrizes do tipo "inteiro" ou "real") (opcional, o padrão é o maior valor representável)

allow_missings

Indica se valores ausentes (vazios) são permitidos na matriz. Isso está implícito para matrizes ou modo "string" (opcional, o padrão é falso).

allow_user_resize_columns

Quando definido como verdadeiro, o usuário pode adicionar colunas digitando nas células mais à direita (inativas) (opcional, o padrão é verdadeiro).

allow_user_resize_rows

Quando definido como verdadeiro, o usuário pode adicionar linhas digitando nas células mais inferiores (inativas) (opcional, o padrão é verdadeiro).

rows

Número de linhas na matriz. Não tem efeito para allow_user_resize_rows="true". "

Nota

Isso também pode ser controlado definindo a propriedade "rows".

(opcional, o padrão é 2).

columns

Número de colunas na matriz. Não tem efeito para allow_user_resize_columns="true".

Nota

Isso também pode ser controlado definindo a propriedade "columns".

(opcional, o padrão é 2).

min_rows

Número mínimo de linhas na matriz. A matriz não será reduzida abaixo desse tamanho. (opcional, o padrão é 0; veja também: allow_missings.).

min_columns

Número mínimo de colunas na matriz. A matriz não será reduzida abaixo desse tamanho. (opcional, o padrão é 0; veja também: allow_missings.).

fixed_height

Força o elemento da GUI a permanecer em sua altura inicial. Não use em combinação com matrizes, onde o número de linhas pode mudar de alguma forma. Útil, especialmente ao criar um elemento de entrada vetorial (columns="1"). Com esta opção definida como verdadeira, nenhuma barra de rolagem horizontal será exibida, mesmo que a matriz exceda a largura disponível (pois isso afetaria a altura). (opcional, o padrão é falso).

fixed_width

Ligeiramente mal nomeado: Assume que a contagem de colunas não mudará. A última (ou normalmente a única) coluna será esticada para ocupar a largura disponível. Não use em combinação com matrizes, onde o número de colunas pode mudar de alguma forma. Útil, especialmente ao criar um elemento de entrada vetorial (linhas="1"). (opcional, o padrão é falso).

horiz_headers

Textos a serem usados ​​para o cabeçalho horizontal, separados por ";". O cabeçalho ficará oculto se definido como "". (opcional, o padrão é o número da coluna).

vert_headers

Strings a serem usadas para o cabeçalho vertical, separadas por ";". O cabeçalho ficará oculto se definido como "". (opcional, o padrão é o número da linha).

<optionset>

Uma interface de usuário para repetir um conjunto de opções para um número arbitrário de itens (introdução a conjuntos de opções). Atributos:

min_rows

Se especificado, o conjunto será marcado como inválido, a menos que tenha pelo menos este número de linhas (opcional, inteiro).

min_rows_if_any

Semelhante a min_rows, mas só será testado se houver pelo menos uma linha. (opcional, inteiro).

max_rows

Se especificado, o conjunto será marcado como inválido, a menos que tenha no máximo este número de linhas (opcional, inteiro).

keycolumn

ID da coluna que atuará como coluna-chave. Um conjunto de opções com uma coluna-chave (válida) atenderá como um conjunto de opções "controlado". Um conjunto de opções sem coluna-chave permitirá a inserção/remoção manual de itens. A coluna-chave deve ser marcada como externa. (opcional, o padrão é nenhuma coluna-chave).

Elementos-filho:

<optioncolumn>

Declara uma coluna de opções do conjunto. Para cada valor que você deseja obter do conjunto de opções, você deve declarar um <optioncolumn> separado. Atributos:

id

O ID da coluna de opções (obrigatório, string).

external

Defina como verdadeiro se a coluna de opções for controlada externamente ao conjunto de opções. (opcional, booleano, o padrão é falso).

label

Se fornecida, a coluna de opções será exibida em uma coluna com esse rótulo. (opcional, texto, o padrão é não exibir).

connect

A propriedade à qual esta coluna de opções será conectada, fornecida como id dentro da área de <content>. Para <optioncolumn> externas, o valor correspondente será definido como o valor definido externamente. Para <optioncolumn> regulares (não externas), a linha correspondente da propriedade da <optioncolumn> será definida quando a propriedade for alterada dentro da área de conteúdo. (opcional, string, o padrão é não conectado).

default

Apenas para colunas externas: O valor a ser assumido para esta coluna, caso nenhum valor seja conhecido para uma entrada. Raramente útil. (Opcional, o padrão é uma string vazia)

<content>

Declare o conteúdo/interface do usuário do conjunto. Sem atributos. Todos os elementos ativos, passivos e de layout usuais são permitidos como elementos childname. Além disso, em versões anteriores do RKWard (até a 0.6.3), o elemento filho especial <optiondisplay> era permitido. Isso está obsoleto na versão 0.6.4 do RKWard e deve ser simplesmente removido dos plugins existentes.

<logic>

Especificação opcional da lógica da interface do usuário para aplicar dentro da região de conteúdo do conjunto de opções. Consulte a referência sobre <logic>

<browser>

Um elemento projetado para selecionar um único nome de arquivo (ou nome de diretório). Observe que este campo aceita qualquer string, embora seja destinado ao uso exclusivo de arquivos.

label

Legenda para o navegador (opcional, o padrão é "Digite o nome do arquivo")

initial

Texto inicial do navegador (opcional, o padrão é "", ou isto é, uma string vazia)

type

Uma das opções "file", "dir" ou "savefile". Para selecionar um arquivo existente, um diretório existente ou um arquivo inexistente, respectivamente (opcional, o padrão é "file")

allow_urls

Se URLs (não locais) podem ser selecionadas (opcional, o padrão é "false")

filter

Filtro de tipo de arquivo, por exemplo ("*.txt *.csv" para arquivos .txt e .csv). Uma entrada separada para "Todos os arquivos" é adicionada automaticamente (opcional, o padrão é "", ou seja, Todos os arquivos)

required

Se - para submeter o código - é necessário que o campo não esteja vazio. Observe que isso não significa necessariamente que o nome do arquivo selecionado seja válido. Consulte required-property (opcional, o padrão é verdadeiro)

<saveobject>

Um elemento projetado para selecionar o nome de um objeto R para salvar (isto é, geralmente não existente, ao contrário de um varslot):

label

Legenda para o campo de entrada (opcional, o padrão é "Salvar em:")

initial

Texto inicial da entrada (opcional, o padrão é "my.data")

required

Para submeter o código, é necessário que o campo contenha um nome de objeto permitido? Consulte a propriedade required-property (opcional, o padrão é verdadeiro)

checkable

Em muitos casos de uso, salvar em um objeto R é opcional. Nesses casos, uma caixa de seleção pode ser integrada ao elemento saveobject usando este atributo. Quando definido como verdadeiro, o objeto salvo será ativado/desativado pela caixa de seleção. Consulte a active-property do elemento saveobject (opcional, o padrão é falso)

checked

Somente para elementos saveobject verificáveis: Se o controle está marcado/habilitado por padrão (opcional, o padrão é falso)

<spinbox>

Uma caixa de seleção numérica na qual o usuário pode escolher um valor numérico, usando entrada direta pelo teclado ou pequenas setas para cima/para baixo. Atributos:

label

Legenda para a caixa de seleção (recomendado, o padrão é "Digite o valor:")

min

O menor valor que o usuário pode inserir na caixa de seleção (opcional, o padrão é o menor valor tecnicamente representável na caixa de seleção)

max

O maior valor que o usuário pode inserir na caixa de seleção (opcional, o padrão é o maior valor tecnicamente representável na caixa de seleção)

initial

O valor inicial exibido na caixa de seleção (opcional, o padrão é "0")

type

Uma das opções "real" ou "integer" (inteiro). Indica se a caixa de seleção aceitará números reais ou apenas números inteiros (opcional, o padrão é "real")

default_precision

Só faz sentido se a caixa de seleção for do tipo "real". Especifica o número padrão de casas decimais exibidas na caixa de seleção (apenas essa quantidade de zeros à direita será exibida). Quando o usuário pressionar as setas para cima/para baixo, esse número de casas decimais será alterado. O usuário ainda poderá inserir valores com uma precisão maior, no entanto (veja abaixo) (opcional, o padrão é "2")

max_precision

O número máximo de dígitos que podem ser representados de forma significativa (opcional, o padrão é "8")

<formula>

Este elemento avançado permite ao usuário selecionar uma fórmula/conjunto de interações a partir de variáveis ​​selecionadas. Por exemplo, para um GLM, este elemento pode ser usado para permitir que o usuário especifique os termos de interação no modelo. Atributos:

fixed_factors

O ID do varslot que contém os fatores fixos selecionados (obrigatório)

dependent

O ID do varslot que contém a variável dependente selecionada (obrigatório)

<embed>

Incorpora um plugin diferente no atual (consulte o capítulo sobre incorporação). Atributos:

component

O nome registrado do componente a ser incorporado (consulte o capítulo sobre registro de componentes) (obrigatório)

as_button

Se definido como "true", apenas um botão será colocado na GUI incorporada. A GUI incorporada só será exibida (em uma janela separada) quando o botão for pressionado (opcional, o padrão é "false")

label

Só faz sentido se as_button="true": A legenda do botão (recomendado, o padrão é "Opções")

<preview>

Caixa de seleção para ativar/desativar a funcionalidade de pré-visualização. Observe que, a partir da versão 0.6.5 do RKWard os elementos <preview> (pré-visualização) são tratados de forma especial em diálogos de plugins (não em assistentes): Eles serão colocados na coluna de botões, independentemente de onde estejam definidos na interface do usuário. Ainda é uma boa prática defini-los em um local adequado no layout, para manter a compatibilidade com versões anteriores. Atributos:

label

Legenda da caixa (opcional, o padrão é "Pré-visualização")

mode

Tipo de pré-visualização. Os tipos suportados são "plot" (consulte o capítulo sobre pré-visualizações de gráficos), "output" (consulte o capítulo sobre pré-visualizações de saída (HTML)), "data" (consulte o pré-visualizações de dados) e "custom" (consulte o pré-visualizações personalizadas). (opcional, o padrão é "plot")

placement

Posicionamento da pré-visualização: "attached" (à área de trabalho principal), "detached" (janela independente), "docked" (anexada à caixa de diálogo do plugin) e "default" (atualmente, é igual a "docked", mas poderá ser configurável pelo usuário em algum momento). Em geral, recomenda-se manter esta configuração como padrão para melhor consistência da interface do usuário (opcional, o padrão é "default").

active

Indica se a pré-visualização está ativa por padrão. Em geral, apenas as pré-visualizações ancoradas (docked) devem ser ativadas por padrão e, mesmo para estas, há um motivo para que o padrão seja pré-visualizações inativas (opcional, o padrão é "false")

Seção de lógica

<logic>

O elemento que contém a seção de lógica. Todos os elementos abaixo são permitidos somente dentro do elemento <logic>. O elemento <logic> é permitido somente como filho direto do elemento <document> (no máximo uma vez por documento) ou de elementos <optionset> (no máximo uma vez por optionset). A seção de lógica do documento se aplica tanto a GUIs <dialog> quanto a <wizard> da mesma forma.

<external>

Cria uma nova propriedade (string) que deve ser conectada a uma propriedade externa caso o plugin seja incorporado. Consulte a seção sobre plugins "incompletos". Atributos:

id

O ID da nova propriedade (obrigatório)

default

O valor de string padrão da nova propriedade, isto é, o valor usado se a propriedade não estiver conectada a uma propriedade externa (opcional, o padrão é uma string vazia)

<i18n>

Cria uma nova propriedade (string) que deve fornecer uma legenda internacionalizado (i18n). Atributos:

id

O ID da nova propriedade (obrigatório)

label

A legenda. Isto será traduzido. (obrigatório)

<set>

Define uma propriedade com um valor fixo (é claro que, se você conectar a propriedade a alguma outra propriedade, o valor não permanecerá fixo). Por exemplo, se você incorporar um plugin, mas quiser ocultar alguns de seus elementos, você pode definir a propriedade de visibilidade desses elementos como falsa. Útil especialmente para plugins incorporados. Nota: Se houver vários elementos <set> para um único id, o último a ser definido terá precedência. Isso às vezes será útil ao usar partes <include>. Atributos:

id

O ID da propriedade a ser definida (obrigatório)

to

O valor da string para definir a propriedade (obrigatório). Observação: Para propriedades booleanas, como visibilidade e habilitação, você normalmente definirá o atributo como "true" ou "false".

<convert>

Cria uma nova propriedade booleana que depende do estado de uma ou mais propriedades diferentes. Atributos:

id

O ID da nova propriedade (obrigatório)

sources

Os IDs das propriedades das quais esta propriedade dependerá. Uma ou mais propriedades podem ser especificadas, separadas por ";" (obrigatório)

mode

O modo de conversão/operação. Um dos seguintes: "equals" (igual a), "notequals" (diferente de), "range" (intervalo), "and" (E lógico) ou "or" (OU lógico). Se o modo for "igual a", a propriedade será verdadeira somente se: o valor de todas as suas fontes for igual ao padrão do atributo (veja abaixo). Se o modo for "diferente de", a propriedade será verdadeira somente se o valor de todas assuas fontes for diferente do padrão do atributo (veja abaixo). Se o modo for "intervalo", as fontes devem ser numéricas (inteiras ou reais). A propriedade será verdadeira somente se todas as fontes estiverem no intervalo especificado pelos atributos mínimo e máximo (veja abaixo). Se o modo for "E", as fontes devem ser propriedades booleanas. A propriedade será verdadeira somente se todas as fontes forem verdadeiras simultaneamente. Se o modo for "OU", as fontes devem ser propriedades booleanas. A propriedade será verdadeira somente se pelo menos uma das fontes for verdadeira. (obrigatório)

standard

Só faz sentido nos modos equals ou notequals: o valor da string a ser comparado contra (obrigatório se estiver em um desses modos)

min

Somente significativo no modo range: o valor mínimo para comparação (opcional, o padrão é o menor número de ponto flutuante representável na máquina)

max

Somente significativo no modo range: o valor máximo para comparação (opcional, o padrão é o maior número de ponto flutuante representável na máquina)

require_true

Se definida como "true", a propriedade se tornará obrigatória e só será considerada válida se seu estado for verdadeiro/ativado. Portanto, se a propriedade for falsa, ela bloqueará o botão Enviar (opcional, o padrão é "false").

Cuidado

Se você usar isso, certifique-se de que o usuário possa detectar facilmente o que está errado, por exemplo, mostrando um <text> explicativo.

<switch>

Cria uma nova propriedade que será repassada para diferentes propriedades de destino (ou strings fixas) com base no valor de uma propriedade de condição. Isso permite criar uma lógica semelhante às construções if() ou switch(). Atributos:

id

O ID da nova propriedade (obrigatório)

condition

O ID da propriedade de condição (obrigatório)

Elementos-filho:

<true>

Se a propriedade de condição for booleana, você pode especificar os dois elementos filhos: <true> e <false> (e somente estes). (Obrigatório, se <false> também for fornecido)

<false>

Se a propriedade de condição for booleana, você pode especificar os dois elementos filhos: <true> e <false> (e somente estes). (Obrigatório, se <true> também for fornecido)

<case>

Se a propriedade de condição não for booleana, você pode fornecer um número arbitrário de elementos <case>, um para cada valor da propriedade de condição que você deseja corresponder (pelo menos um elemento desse tipo é necessário se a propriedade de condição não for booleana).

<default>

Se a propriedade de condição não for booleana, o elemento opcional <default> permite especificar o comportamento caso nenhum elemento <case> corresponda ao valor da propriedade de condição (opcional, permitido apenas uma vez, em combinação com um ou mais elementos <case>).

Os elementos filhos <true>, <false>, <case> e <default> assumem os seguintes atributos:

standard

Apenas para elementos <case>: O valor para comparar a propriedade de condição contra (obrigatório, string).

fixed_value

Uma string fixa que deve ser fornecida como o valor da propriedade <switch> se a condição atual for atendida (obrigatório, se dynamic_value não for fornecido).

dynamic_value

O id da propriedade de destino que deve ser fornecido como o valor da propriedade <switch> se a condição atual corresponder (obrigatório, se fixed_value não for fornecido).

<connect>

Conecta duas propriedades. A propriedade do cliente será alterada sempre que a propriedade do governador for alterada (mas não o contrário). Atributos:

client

O ID da propriedade do cliente, ou seja, a propriedade que será ajustada (obrigatório)

governor

O ID da propriedade do governador, isto é, a propriedade que ajustará a propriedade do cliente. Isso pode incluir um modificador (obrigatório)

reconcile

Se "verdadeiro", a propriedade do cliente ajustará a propriedade do governador na conexão de forma que a propriedade do governador aceite apenas valores que também sejam aceitáveis ​​pelo cliente (por exemplo, suponha que o governador seja uma propriedade numérica com valor mínimo "0" e o cliente seja uma propriedade numérica com valor mínimo "100". O mínimo de ambas as propriedades será ajustado para 100, se reconcile="true"). Geralmente funciona apenas para propriedades do mesmo tipo básico (opcional, padrão "falso").

<dependency_check>

Cria uma propriedade booleana que é verdadeira se as dependências especificadas forem atendidas, e falsa caso contrário. A sintaxe XML do elemento é a mesma do elemento <dependencies>, descrito na referência de .pluginmap. A partir da versão 0.6.1, apenas as especificações de versão do RKWard e R são consideradas, e não as dependências de pacotes ou pluginmaps.

<script>

Define o código do script para controlar a lógica da interface do usuário. Consulte a seção sobre lógica GUI com script para obter detalhes. O código do script a ser executado pode ser fornecido usando o atributo "file", ou como um texto (comentado) do elemento. O elemento <script> não é permitido na seção <logic> de um conjunto de opções. Atributos:

file

Nome do arquivo de script. (obrigatório)