Instalar el sistema de ayuda como centro informativo (infocenter)

Si desea permitir a sus usuarios acceder al sistema de ayuda por Internet o por una intranet, puede instalar el centro informativo y los conectores de documentación en un servidor. Los clientes visualizan la ayuda navegando a un URL, y el sistema de ayuda se muestra en el navegador Web. El sistema de ayuda del centro informativo se puede usar para las aplicaciones de cliente y para las aplicaciones Web, a cuya ayuda se puede acceder remotamente. Están soportadas todas las características del sistema de ayuda, salvo las ayudas emergentes y la ayuda activa.

El sistema de ayuda del centro informativo permite pasar diversas opciones que pueden utilizarse para personalizar diversos aspectos del centro informativo. 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 conectores 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 www.eclipse.org.
  2. Instale (extraiga del zip) el controlador en un directorio, 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 iniciar o detener el centro informativo desde la línea de mandatos

La clase org.eclipse.help.standalone.Infocenter tiene un método main que puede utilizarse para lanzar el centro informativo desde una línea de mandatos. La sintaxis de los argumentos de línea de mandatos es:

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]

Para iniciar un centro informativo en el puerto 8081, emita un mandato start ejecutando

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

Para cerrar el centro informativo, emita un mandato shutdown ejecutando

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

Utilizar el centro informativo

Inicie el servidor Web. Haga que un navegador Web señale hacia la vía de acceso de la aplicación Web "de ayuda" ejecutada en un puerto especificado al iniciar el centro informativo.  En la máquina en la que está instalado el centro informativo, sería http://localhost:8081/help/.

Cómo iniciar o detener el centro informativo desde Java

Al incluir el centro informativo como parte de otra aplicación, puede ser más conveniente iniciarlo o detenerlo utilizando las API de Java en lugar de utilizar mandatos del sistema. Si este es el caso, siga estos pasos:

  1. Asegúrese de que d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar está en la vía de acceso de clases (classpath) de la aplicación. La clase que se emplea para iniciar y concluir el centro informativo es org.eclipse.help.standalone.Infocenter.
  2. Cree una matriz de String que contenga las opciones que desea pasar al centro informativo. Generalmente, son necesarias las opciones eclipsehome y port.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" }; 
  3. En la aplicación, cree una instancia de la clase Help pasando las opciones.
    Infocenter infocenter = new Help(options); 
  4. Para iniciar el sistema de ayuda:
    helpSystem.start();
  5. Para cerrar el centro informativo:

    helpSystem.shutdown(); 

Hacer que el centro informativo esté disponible en la web

Eclipse contiene un centro informativo completo y no requiere la ejecución de otro software de servidor. Sin embargo, en un entorno inseguro como Internet, no es aconsejable que los clientes accedan directamente al centro informativo, sino hacerlo disponible a través de un servidor HTTP o un servidor de aplicaciones. La mayoría de servidores se suministran con módulos o servlets para delegar determinadas peticiones a otros recursos web. Por ejemplo, puede configurarse un módulo proxy de Apache HTTP Server para redireccionar las peticiones efectuadas a http://mycompany.com/myproduct/infocenter a http://internalserver:8081/help, que ejecuta un centro informativo. Esto puede lograrse añadiendo las líneas

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help

al archivo conf/httpd.conf del servidor Apache que ejecuta el sitio web de mycompany.

Algunas versiones del servidor Apache HTTP pueden contener la directiva AddDefaultCharset habilitada en el archivo de configuración. Elimine las directivas o sustitúyalas por

AddDefaultCharset Off

para que los navegadores visualicen los documentos mediante el juego de caracteres correcto.

Ejecutar varias instancias del centro informativo (infocenter)

Pueden ejecutarse varias instancias del centro informativo en una máquina desde una instalación. Cada instancia iniciada debe utilizar su propio puerto y tener un área de trabajo; por tanto, deben especificarse las opciones -port y -data. Las instancias pueden servir documentación desde un conjunto de conectores diferente, suministrando una configuración de plataforma válida con la opción -configuration.

Si no se utiliza la opción -configuration y el directorio de configuración se comparte entre varias instancias del centro informativo, con conjunto de entornos locales solapado, debe garantizarse que una instancia del centro informativo creará todos los índices de búsqueda antes de que se inicie otra instancia. Los índices se guardan en el directorio de configuración y el acceso de escritura no se sincroniza en los procesos del centro informativo.

[Opcional] Instalar un conjunto mínimo de conectores

El centro informativo no requiere todo el paquete de la plataforma Eclipse. Es posible ejecutar el centro informativo con los siguientes conectores (ubicados en el directorio  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

Algunos conectores de documentación pueden tener dependencias de otros conectores, habitualmente especificando los conectores necesarios en su archivo plugin.xml. Los conectores dependientes tienen que instalarse también en el centro informativo. Además, los conectores que se diseñaron para una versión de Eclipse anterior a la 3.0 necesitan que un org.eclipse.core.runtime.compatibility esté presente para que el conector funcione.

Los conectores del centro informativo pueden actualizarse sin reiniciar el centro informativo, utilizando unos mandatos que se explican en el tema Actualización de un centro informativo en ejecución desde la línea de mandatos. Para utilizar estas funciones, el conjunto mínimo de conectores debe incluir el conector org.eclipse.update.core.

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