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 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:

Instalação/Empacotamento

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 toda sua documentação seja entregue como plug-ins do Eclipse e, geralmente, que você esteja familiarizado com o sistema de ajuda do eclipse.
  1. Faça o download do driver Eclipse Platform Runtime Binary a partir de www.eclipse.org.
  2. Instale (descompacte) o driver no diretório de aplicativo, por exemplo, d:\myApp. Isto 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 do Java

  1. Certifique-se de que d:\myApp\eclipse\plugins\org.eclipse.help.base_3.0.1\helpbase.jar esteja no caminho de classe do aplicativo. A classe que você utiliza para iniciar, lançar e encerrar o sistema de ajuda é org.eclipse.help.standalone.Help.
  2. Crie uma matriz de cadeias que contenha as opções que você deseja transmitir para suportar o sistema de ajuda. Normalmente, a opção eclipsehome é necessária.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" }; 
  3. Em seu aplicativo, crie uma instância da classe Help transmitindo as opções. Esse objeto deve ser retido até o final de seu aplicativo.
    Help helpSystem = new Help(options); 
  4. Para iniciar o sistema de ajuda:
    helpSystem.start(); 

  5. Para chamar ajuda quando necessário:
    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");
  6. 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.
  7. No final de seu aplicativo, para encerrar o sistema de ajuda;

    helpSystem.shutdown(); 

Como Chamar a Ajuda a Partir da Linha de Comandos

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] [-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.0.1\helpbase.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.0.1\helpbase.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.0.1\helpbase.jar org.eclipse.help.standalone.Help -command start

[Opcional] Instalando um Conjunto Mínimo de Plug-ins

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.ant
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

Consulte Preferências do Sistema de Ajuda para obter informações adicionais sobre como personalizar o sistema de ajuda.

org.eclipse.help.base preferences Avisos legais.