Ayuda autónoma

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 eliminado 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 la ayuda contextual, la vista de ayuda y la ayuda activa integradas en el entorno de trabajo. Si una aplicación no está basada en Java o se necesita ayuda cuando la aplicación no se está ejecutando, es posible utilizar la ayuda autónoma desde una shell del sistema, un script de shell o un acceso directo de escritorio y suministrar opciones de línea de mandatos en lugar de llamar a las API de Java.

El sistema de ayuda autónomo permite pasar diversas opciones que pueden utilizarse para personalizar diversos aspectos del sistema de ayuda. Están soportadas las siguientes opciones:

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 ha recibido toda la documentación en forma plug-ins de Eclipse, y que, en general, está familiarizado con el sistema de ayuda de Eclipse.
  1. Baje el controlador binario de tiempo de ejecución de la plataforma Eclipse desde 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 necesario para la plataforma Eclipse (que incluye el sistema de ayuda).

Cómo llamar a las clases de ayuda desde Java

  1. Asegúrese de que d:\myApp\eclipse\plugins\org.eclipse.help.base_[versión].jar está en la vía de acceso de clases, donde [versión] es la versión del plugin que está utilizando (por ejemplo, org.eclipse.help.base_3.2.0.jar). La clase que se emplea para iniciar, lanzar y concluir el sistema de ayuda es org.eclipse.help.standalone.Help.
  2. Cree una matriz de objetos String que contenga las opciones que desea pasar al soporte del sistema de ayuda. Generalmente, es necesaria la opción eclipsehome.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. En la aplicación, cree una instancia de la clase Help pasando las opciones. Este objeto se debe conservar hasta el final de la aplicación.
    Help helpSystem = new Help(opciones);
  4. Para iniciar el sistema de ayuda:
    helpSystem.start(); 
  5. 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");
  6. 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.
  7. Al final de la aplicación, para concluir el sistema de ayuda:

    helpSystem.shutdown(); 

Cómo llamar a la ayuda desde la línea de mandatos

La clase org.eclipse.help.standalone.Help tiene un método main que puede utilizarse para lanzar la ayuda autónoma desde la línea de mandatos. La sintaxis de los argumentos de línea de mandatos es:

-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]

Una forma sencilla de visualizar la ayuda es llamar a

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[versión].jar org.eclipse.help.standalone.Help -command displayHelp

desde el directorio d:\myApp\eclipse, donde versión es la versión del plug-in. Para visualizar un tema o archivo TOC específico, utilice

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[versión].jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm

Las llamadas anteriores destinadas a visualizar la ayuda provocarán el inicio del sistema de ayuda, visualizarán la ayuda y mantendrán la ejecución para que el usuario pueda continuar examinándola después de ejecutar el mandato. Para controlar el ciclo de vida del sistema de ayuda, utilice los mandatos start y shutdown, además del mandato displayHelp. Por ejemplo, puede llamar a

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[versión].jar org.eclipse.help.standalone.Help -command start

[Opcional] Instalar un sistema de ayuda autónomo mínimo

La ayuda autónoma no requiere todo el paquete de la plataforma Eclipse. Es posible ejecutar la ayuda autónoma con el Binario de tiempo de ejecución RCP añadiendo los siguientes plug-ins al directorio 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: debe asegurarse de que la línea siguiente esté presente en el archivo eclipse/configuration/config.ini:

osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start

Algunos plug-ins de documentación pueden tener dependencias de otros plug-ins, habitualmente especificando los plug-ins necesarios en su manifiesto. Los plug-ins dependientes también deben instalarse. Además, los plug-ins que se diseñaron para una versión de Eclipse anterior a la 3.0 requieren implícitamente un plug-in org.eclipse.core.runtime.compatibility para poder funcionar.

Consulte la sección Personalización de productos para obtener más información acerca de la personalización del sistema de ayuda.