Elementos para uso em arquivos .pluginmap

<document>

Precisa estar presente em cada arquivo .pluginmap como nó raiz (exatamente uma vez). Atributos:

base_prefix

Os nomes de arquivo especificados no arquivo .pluginmap são considerados relativos ao diretório do arquivo .pluginmap + o prefixo especificado aqui. Útil, especialmente se todos os seus componentes estiverem localizados em um único subdiretório.

namespace

Um espaço de nomes para os IDs dos componentes. Ao procurar componentes para incorporação, os componentes poderão ser recuperados por meio da string "namespace::component_id". Definido como "rkward" por enquanto.

id

Uma string identificadora opcional para este .pluginmap. Especificar isso permite que autores terceirizados se refiram ao seu .pluginmap e o carreguem a partir do deles (consulte o capítulo sobre como lidar com dependências).

priority

Uma das opções "hidden", "low", "medium" ou "high". Os .pluginmap com prioridade "medium" ou "high" são ativados automaticamente quando o RKWard os encontra pela primeira vez. Use priority="hidden" para .pluginmaps que não devem ser ativados, diretórios (apenas para inclusão). Na implementação atual, isso não oculta o .pluginmap. (Opcional, o padrão é "medium").

<dependencies>

Este elemento, que especifica dependências, é permitido como filho direto do elemento <document> (uma vez) e como filho de elementos <component> (uma vez para cada elemento <component>). Especifica as dependências que devem ser atendidas para usar o(s) plugin(s). Consulte o capítulo sobre dependências para uma visão geral. Atributos:

rkward_min_version, rkward_max_version

Versão mínima e máxima permitida do RKWard. As especificações de versão podem incluir sufixos não numéricos, como "0.5.7z-devel1". Se uma dependência especificada não for atendida, o(s) plugin(s) ao(s) qual(is) ela se aplica serão ignorados. Mais informações. Opcional; se não for especificado, nenhuma versão mínima/máxima do RKWard será exigida.

R_min_version, R_max_version

Versão mínima e máxima permitida do R. As especificações de versão não podem incluir sufixos não numéricos, como "0.5.7z-devel1". A dependência da versão do R será exibida nas páginas de ajuda dos plugins, mas não tem efeito direto, a partir da versão 0.6.1 do RKWard. Mais informações. Opcional; se não for especificado, nenhuma versão mínima/máxima do R será exigida.

platforms

Plataformas onde este plugin está disponível. Os valores suportados são "unix", "windows", "macos", "any" e combinações separadas por dois pontos (por exemplo, "unix:macos"). "unix" inclui quaisquer variantes de Linux e BSD, mas não MacOS. Se o seu plugin não depender de plataforma, basta omitir este atributo.

Elementos-filho:

<package>

Adiciona uma dependência a um pacote R específico. Atributos:

name

Nome do pacote (obrigatório).

min_version, max_version

Versão mínima/máxima permitida (opcional).

repository

Repositório onde o pacote pode ser encontrado. Opcional, mas altamente recomendado, caso o pacote não esteja disponível no CRAN.

<pluginmap>

Adiciona uma dependência a um específico .pluginmap do RKWard. Atributos:

name

String de identificação do .pluginmap obrigatório (obrigatório).

min_version, max_version

Versão mínima/máxima permitida (opcional).

url

URL onde o .pluginmap pode ser encontrado. Obrigatório.

<about>

Pode estar presente exatamente uma vez como filho direto do elemento <document>. Contém metainformações sobre o .pluginmap (ou plugin). Consulte o capítulo sobre informações do 'about' para obter uma visão geral. Atributos:

name

Nome visível do usuário. Opcional. Não precisa ser o mesmo que o "id".

version

Número da versão. Opcional. O formato não é restrito, mas para maior segurança, siga esquemas de versionamento comuns, como "x.y.z".

releasedate

Especificação da data de lançamento. Opcional, no formato "YYYY-MM-DD".

shortinfo

Uma breve descrição do plugin / .pluginmap. Opcional.

url

URL onde você pode encontrar mais informações. Opcional, mas recomendado.

copyright

Especificação de direitos autorais, por exemplo: "2012-2013 por John Doe". Opcional, mas recomendado.

licence

Especificação da licença, por exemplo, "GPL" ou "BSD". Certifique-se de acompanhar seus arquivos com uma cópia completa da licença relevante. Opcional, mas recomendado.

category

Categoria de plugin(s), por exemplo, "Teoria de resposta ao item". A partir da versão 0.6.1, nenhuma categoria está predefinida. Opcional.

Elementos-filho:

<author>

Adiciona informações sobre um autor. Atributos:

name, given, family

Especifique o nome completo para name, ou especifique given e family separadamente.

role

Descrição da função do autor (opcional).

email

Endereço de e-mail para contato com o autor. Obrigatório. Pode ser definido como a lista de discussão rkward-devel, caso você esteja inscrito e seu plugin seja destinado a ser incluído na versão oficial do RKWard.

url

URL com mais informações sobre o autor, por exemplo página inicial (opcional).

<components>

Precisa estar presente exatamente uma vez como filho direto do elemento <document>. Contém os elementos <component> individuais descritos abaixo. Sem atributos.

<component>

Um ou mais elementos <component> devem ser fornecidos como filhos diretos do elemento <components> (e somente lá). Registra um componente/plugin com o rkward. Atributos:

type

Para futuras extensões: O tipo de componente/plugin. Por enquanto, sempre definido como "padrão" (o único tipo atualmente suportado).

id

O ID pelo qual este componente pode ser recuperado (para colocá-lo no menu (veja abaixo), ou para incorporá-lo). Veja <document>-namespace acima.

file

Requerido pelo menos para componentes do tipo "padrão": O nome do arquivo XML que descreve a GUI.

label

A legenda para este componente, quando colocado na hierarquia do menu.

optional

Só faz sentido para componentes com dependencies definidas: Normalmente, é considerado um erro reportável se um componente não for compatível com esta versão do RKWard. No entanto, se o componente realmente não for necessário no ambiente atual, definir este atributo como "true" suprime qualquer aviso ("false" por padrão).

<attribute>

Define um atributo de um componente. Até o momento, só faz sentido para plugins de importação. Permitido apenas como um filho direto de <component>. Atributos:

id

Id do atributo

value

Valor do atributo

labels

Legenda associada ao atributo

<hierarchy>

Precisa estar presente exatamente uma vez como filho direto do elemento <document>. Descreve onde os componentes declarados acima devem ser colocados na hierarquia do menu. Aceita apenas elementos <menu> como filhos diretos. Sem atributos.

<menu>

Um ou mais elementos <menu> devem ser fornecidos como filhos diretos do elemento <hierarchy>. Declara um novo (sub)menu. Se um menu com o ID fornecido (veja abaixo) já existir, os dois menus serão mesclados. O elemento <menu> pode ser um filho direto do elemento <hierarchy> (menu de nível superior) ou um filho direto de qualquer outro elemento <menu> (submenu). Por outro lado, o elemento <menu> aceita outros elementos <menu> ou <entry> como filhos. Atributos:

id

Uma string identificadora do menu. Útil quando as definições de menu são lidas de vários arquivos .pluginmap para garantir que os plugins possam ser colocados no(s) mesmo(s) menu(s). Alguns IDs de menu, como "file", referem-se a menus predefinidos (neste caso, o menu "File"). Certifique-se de verificar os arquivos .pluginmap existentes para usar IDs consistentes.

label

Uma legenda para o menu.

group

Permite controlar a ordem dos itens do menu. Consulte ordem dos itens do menu. Opcional.

<entry>

Uma entrada de menu, isto é, uma opção de menu para invocar um plugin. Pode ser usado apenas como filho direto de um elemento <menu>, não aceitando elementos filhos. Atributos:

component

O ID do componente que deve ser invocado quando esta entrada de menu for ativada.

group

Permite controlar a ordem dos itens do menu. Consulte ordem dos itens do menu. Opcional.

<group>

Declara um grupo de itens no menu. Consulte ordenação de itens do menu. Atributos:

id

O nome deste grupo.

separated

Opcional. Se definido como "verdadeiro", o item neste grupo será visualmente separado dos itens ao redor.

group

Nome do grupo ao qual este grupo será adicionado (opcional).

<context>

Declara as entradas em um contexto. Permitido apenas como filho direto da tag <document>. Aceita apenas tags <menu> como filhos diretos. Atributos:

id

O ID do contexto. Até o momento, apenas dois contextos foram implementados: "x11" e "import".

<require>

Inclui outro arquivo .pluginmap. Este arquivo .pluginmap é carregado apenas uma vez, mesmo que seja <require> de vários outros arquivos. O caso de uso mais importante é incluir um arquivo pluginmap, que declara alguns componentes, que são incorporados por componentes declarados neste .pluginmap. Elementos <require> são permitidos apenas como filhos diretos do nó <document>. Atributos:

file

O nome do arquivo do .pluginmap a ser incluído. Isso é visto em relação ao diretório do arquivo .pluginmap atual + o prefixo base (veja acima, elemento <document>). Se você não souber o caminho relativo para o .pluginmap a ser incluído, use o atributo map para referenciá-lo pelo id.

map

Para incluir um arquivo .pluginmap de um pacote diferente (ou um .pluginmap do RKWard de seu .pluginmap externo), você pode se referir a ele pelo seunamespacename::id, conforme especificado no elemento<document> do .pluginmap obrigatório. A inclusão falhará se nenhum .pluginmap com esse id for conhecido (por exemplo, não estiver instalado no sistema do usuário). Você deve usar este método apenas para incluir .pluginmaps fora do seu pacote. Para mapas dentro do seu pacote, especificar um caminho relativo (atributo file) é mais rápido e confiável.