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 possui todos os recursos do sistema de ajuda integrado, exceto infopops 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.String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
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 possui um método main que pode ser utilizado para ativar a ajuda independente a partir da 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_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp
a partir do diretório d:\myApp\eclipse. Para exibir o arquivo de índice ou tópico específico utilize
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.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_3.1.0.jar org.eclipse.help.standalone.Help -command start
A ajuda independente não requer o pacote da Plataforma Eclipse inteiro.
É possível executar a ajuda independente com os seguintes plug-ins (localizados
no diretório eclipse\plugins):
org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator
No Windows e no Linux, os plug-ins e fragmentos a seguir são requeridos no topo da configuração mínima para fornecer um suporte potente ao navegador (um Internet Explorer incorporado ao SWT no Windows e Mozilla no Linux ou um navegador de sistema independente no Windows).
org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 ou org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench
Alguns plug-ins da documentação podem ter dependências sobre outros plug-ins,
geralmente especificando plug-ins requeridos em seu plugin.xml.
Os plug-ins dependentes precisam ser instalados no infocenter igualmente.
Adicionalmente, os plug-ins que foram designados para a versão anterior à 3.0 do Eclipse requerem implicitamente um org.eclipse.core.runtime.compatibility
estando presente no plug-in para funcionamento.
Consulte Preferências do Sistema de Ajuda para obter informações adicionais sobre como customizar o sistema de ajuda.
Preferências org.eclipse.help.base