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 empacotar e instalar o sistema de ajuda independente, uma versão muito pequena do Eclipse que tem tudo, exceto o sistema de ajuda tirado dele. Em seguida, seu aplicativo pode fazer chamadas API de seu menu Ajuda ou de objetos da UI, para lançar o navegador de ajuda. O sistema de ajuda independente tem todos os recursos do sistema de ajuda integrada, exceto ajuda de contexto integrada ao ambiente de trabalho, visualização de ajuda e ajuda ativa. Quando um aplicativo não tiver base no Java, ou a ajuda for requerida quando o aplicativo não estiver em execução, é possível utilizar a ajuda independente a partir do shell do sistema, de um script de shell ou de um atalho no desktop e fornecer as opções da linha de comandos em vez de chamar as APIs Java.
O sistema de ajuda independente permite transmitir várias opções que podem ser utilizadas para personalizar vários aspectos do sistema de ajuda. As seguintes opções são suportadas:
-nl fr_FR
iniciará o sistema de ajuda no idioma francês em vez de um idioma especificado pelo locale da máquina.d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar
esteja no
caminho de classe, em que [version]
é a versão do plugin que você está
utilizando (por exemplo, org.eclipse.help.base_3.2.0.jar
). A classe
utilizada para iniciar, ativar e encerrar o sistema de ajuda é
org.eclipse.help.standalone.Help
.
Cadeia
contendo as opções que você
deseja transmitir ao suporte de sistema de ajuda. Normalmente, a opção
eclipsehome
é necessária.
String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
Ajuda
transmitindo as
opções. Esse objeto deve ser retido até o final de seu aplicativo.Help helpSystem = new Help(options);
helpSystem.start();
helpSystem.displayHelp();
Você também pode chamar ajuda 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");
No final de seu aplicativo, para encerrar o sistema de ajuda;
helpSystem.shutdown();
A classe org.eclipse.help.standalone.Help
tem um método principal que
você pode utilizar para ativar a ajuda independente na linha de comandos. A sintaxe dos argumentos da linha de comandos é:
-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]
Uma maneira simples de exibir a ajuda é chamar
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp
no
diretório d:\myApp\eclipse, em que version
é a versão do plug-in. Para
exibir um arquivo TOC ou um tópico específico, utilize
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm
As chamadas acima para exibir a ajuda farão com que o sistema de ajuda seja iniciado, exiba a ajuda e continue em execução para permitir ao usuário continuar procurando por ajuda após o comando ser executado. Para controlar o ciclo de vida do sistema de ajuda, utilize os comandos start e shutdown, além do comando displayHelp. Por exemplo, você pode chamar
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command start
A ajuda independente não exige todo o pacote de Plataforma Eclipse. É possível executar a
ajuda independente com o RCP Runtime Binary, com os seguintes plug-ins incluídos no
diretório eclipse/plugins
:
org.apache.lucene
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.ui
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.ui.forms
Nota: assegure-se de que a seguinte linha esteja presente no arquivo
eclipse/configuration/config.ini
:
osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start
Alguns plug-ins de documentação podem ter dependências de outros plug-ins, normalmente
especificando os plug-ins requeridos em seu manifesto. Os plug-ins dependentes precisam
ser instalados também. Além disso, os plug-ins designados para versões anteriores à 3.0
do eclipse exigem implicitamente a presença do plug-in
org.eclipse.core.runtime.compatibility
para funcionar.
Consulte Customização do Produto para obter informações adicionais sobre como customizar o sistema de ajuda.