Instalando o Sistema de Ajuda Independente
Se você estiver criando um aplicativo que não é baseado na
estrutura do Eclipse, ainda será possível utilizar o sistema de ajuda do Eclipse. Seu
aplicativo pode compactar e instalar o sistema de ajuda independente, uma versão muito
pequena do Eclipse que teve tudo, exceto o sistema de ajuda tirado
dele. Em seguida, seu aplicativo pode fazer chamadas API de seu menu em seguida Ajuda ou de
objetos da UI, para lançar o navegador de ajuda. O sistema de ajuda independente possui todos os
recursos do sistema d ajuda integrado, exceto infopops e ajuda ativa.
Instalação/Compactação
Essas etapas são destinadas ao integrador do sistema de ajuda
e não se destinam a endereçar todos os cenários possíveis. Supõe-se
que o aplicativo de lançamento esteja no Java e que
toda sua documentação seja entregue como plug-ins do Eclipse e, geralmente, que você esteja familiarizado
com o sistema de ajuda do eclipse.
- Faça download do driver Platform Runtime Binary do Eclipse Release 2.0 de
www.eclipse.org.
- Instale (descompacte) o driver no diretório de aplicativo, por
exemplo, d:\myApp. Este irá criar um subdiretório do eclipse, d:\myApp\eclipse que
contém o código requerido para a plataforma Eclipse (que inclui o sistema de
ajuda).
Como chamar as classes de ajuda
- Certifique-se de que d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar esteja
em seu classpath de aplicativo. A classe que você utiliza para iniciar, lançar e encerrar o sistema de ajuda é
org.eclipse.help.standalone.Help.
- Em seu aplicativo, crie uma instância da classe de Ajuda, transmitindo o diretório de
plug-ins. Esse objeto deve ser retido até o final de seu aplicativo.
Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins");
- Para iniciar o sistema de ajuda:
helpSystem.start();
No final de seu aplicativo, para encerrar o sistema de ajuda;
helpSystem.shutdown();
- Para chamar ajuda quando necessário:
helpSystem.displayHelp();
Você também pode ajudar nos arquivos ou tópicos TOC principais e específicos:
helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
- Para lançar a ajuda dependente de contexto, chame
helpSystem.displayContext(contextId, x, y) em que contextId é o ID de contexto
completo. A tela que coordena, x e y, atualmente, não é utilizada.
Testando Ajuda Independente
A classe org.eclipse.help.standalone.Help possui um programa principal simples que você
pode lançar e ver como a ajuda independente funciona para uso. Em uma linha de
comandos, execute o seguinte comando:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar
org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins