http://docs.kde.org/
 Próxima

Introdução à escrita de plugins para o RKWard

Thomas Friedrichsmeier

Meik Michalke

Tradução: Marcus Gama
revisão 0.8.2 (03/05/2025)

Copyright © 2006-2024 Thomas Friedrichsmeier

Este é um guia para escrever plugins para o RKWard.

Índice

1. Introdução
2. Preliminares: O que são plugins no RKWard? Como eles funcionam?
3. Criando entradas no menu
Controlar a ordem dos itens do menu
4. Definir a GUI
Definir um diálogo
Adicionar uma interface de assistente
Algumas considerações sobre design da GUI
<radio> vs. <checkbox> vs. <dropdown>
5. Gerar código R a partir de configurações da GUI
Usar JavaScript em plugins do RKWard
preprocess()
calculate()
printout()
Convenções, políticas e contexto
Compreendendo o ambiente local()
Formatação do código
Lidar com opções complexas
Dicas e truques
6. Escrevendo uma página de ajuda
7. Interações lógicas entre elementos da GUI
Lógica da GUI
Lógica da GUI com script
8. Embutindo plugins dentro de plugins
Casos de uso para embutir
Incorporar dentro de uma caixa de diálogo
Geração de código ao incorporar
Incorporação dentro de um assistente
Menos incorporação embutida: Botão de Opções adicionais
Incorporação/definição de plugins incompletos
9. Lidar com muitos plugins semelhantes
Visão geral das diferentes abordagens
Usando a instrução include do JavaScript
Incluir arquivos .xml
Usar <snippets>
<include> e <snippets> vs. <embed>
10. Conceitos para uso em plugins especializados
Plugins que geram um gráfico
Desenhar um gráfico na janela de saída
Adicionando funcionalidade de pré-visualização
Opções genéricas do gráfico
Um exemplo canônico
Pré-visualizações de dados, resultados e outras informações
Pré-visualizações de saída (HTML)
Pré-visualização dos dados (importados)
Pré-visualizações personalizadas
Plugins dependentes do contexto
Contexto do dispositivo X11
Contexto de importação de dados
Consultando o R para obter informações
Referenciando o objeto atual ou o arquivo atual
Opções repetidas (um conjunto de)
"Driven" optionsets
Alternativas: Quando não usar conjuntos de opções
11. Lidar com dependências e problemas de compatibilidade
Compatibilidade com a versão do RKWard
Compatibilidade de versão do R
Dependências de pacotes R
Dependências de outros .pluginmap do RKWard
Um exemplo
12. Traduções de plugin
Considerações gerais
i18n em arquivos xml do RKWard
i18n nos arquivos e seções js do RKWard
i18n e aspas
Manutenção da tradução
Escrevendo traduções para plugin
13. Informações de autor, licença e versão
14. Compartilhar seu trabalho com outras pessoas
Plugins externos
Por que usar plugins externos?
Estrutura de um pacote de plugins
Hierarquia de arquivos
Construindo o pacote do plugin
15. Desenvolvimento de plugins com o pacote rkwarddev
Visão geral
Exemplo prático
Descrição da GUI
Código JavaScript
Mapa de plugin
Página de ajuda
Gerar arquivos do plugin
O script completo
Adicionar páginas de ajuda
Traduzir plugins
A. Referência
Tipos de propriedades/Modificadores
Elementos de uso geral para serem utilizados em qualquer arquivo XML (.xml, .rkh, .pluginmap)
Elementos a serem usados ​​na descrição XML do plugin
Elementos gerais
Definições da interface
Elementos do layout
Elementos ativos
Seção de lógica
Propriedades dos elementos do plugin
Plugins incorporáveis ​​incluídos na versão oficial RKWard
Elementos para uso em arquivos .pluginmap
Elementos para uso em arquivos .rkh (ajuda)
Funções disponíveis para scripts de lógica de GUI
B. Solução de problemas durante o desenvolvimento de plugins
C. Licença

Lista de Tabelas

A.1. Plugins padrão incorporáveis