Instalar el sistema de ayuda autónomo

Si está creando una aplicación que no esté basada en la infraestructura de Eclipse, aun así puede utilizar el sistema de ayuda de Eclipse. La aplicación puede empaquetar e instalar el sistema de ayuda autónomo, una versión muy pequeña de Eclipse, de la que se ha quitado todo salvo el sistema de ayuda. Luego, para lanzar el navegador de la ayuda, la aplicación puede hacer llamadas a las API desde el menú Ayuda o desde los objetos de la UI. El sistema de ayuda autónomo tiene todas las características del sistema de ayuda integrado, salvo las ayudas emergentes y la ayuda activa.

Instalación/empaquetado

Estos pasos están destinados al integrador del sistema de ayuda, pero no representan una respuesta para todos los escenarios posibles. Se da por sentado que la aplicación de lanzamiento está en Java, que usted ha recibido toda la documentación en forma conectores de Eclipse, y que, en general, está familiarizado con el sistema de ayuda de Eclipse.
  1. Baje el controlador Platform Runtime Binary del nivel de release Eclipse 2.0 de www.eclipse.org.
  2. Instale (extraiga del zip) el controlador bajo el directorio de su aplicación; por ejemplo, d:\myApp. Así se creará un subdirectorio de eclipse, d:\myApp\eclipse, que contiene el código que se necesita para la plataforma Eclipse (que incluye el sistema de ayuda).

Cómo llamar a las clases de ayuda

  1. Asegúrese de que d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar está en su vía de acceso de clases de la aplicación. La clase que se emplea para iniciar, lanzar y concluir el sistema de ayuda es org.eclipse.help.standalone.Help.
  2. En su aplicación, cree una instancia de la clase Help pasando el directorio plugins. Este objeto se debe conservar hasta el final de la aplicación.
    Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins"); 
  3. Para iniciar el sistema de ayuda:
    helpSystem.start(); 

    Al final de la aplicación, para concluir el sistema de ayuda:

    helpSystem.shutdown(); 
  4. Para invocar la ayuda en el momento oportuno:
    helpSystem.displayHelp(); 

    También puede llamar a la ayuda sobre determinados temas o archivos de la tabla de contenido (TOC):

    helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
    helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
  5. Para lanzar la ayuda contextual, llame al método helpSystem.displayContext(contextId, x, y), siendo contextId un ID de contexto totalmente calificado. Las coordenadas de la pantalla, x e y, no se utilizan actualmente.

Probar la ayuda autónoma

La clase org.eclipse.help.standalone.Help tiene un programa principal simple que se puede lanzar para ver cómo funciona la ayuda autónoma prefabricada. Desde una línea de mandatos, ejecute el mandato:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar 
org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins
Copyright IBM Corp. y otros 2000, 2002.