Si desea permitir a sus usuarios acceder al sistema de ayuda por Internet o por una intranet, puede instalar un centro informativo y los plug-ins 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, excepto la ayuda contextual, la ayuda activa, el soporte de mandatos y la vista de ayuda.
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:
osgi.instance.area
o osgi.instance.area.default
-nl en -locales
de en es fr
it ja ko pt_BR zh_CN zh_TW
hará que el centro informativo opere en 10 entornos
locales. Todos los demás entornos locales recibirán el contenido del entorno local
en
. -vmargs -Xmx256M
aumentará la
memoria disponible para el centro informativo y permitirá dar servicio a una colección de
manuales más amplia.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.
d:\miAplic
. Así se creará un subdirectorio de Eclipse,
d:\miAplic\eclipse
, que contendrá el código necesario para la plataforma
Eclipse (que
incluye el sistema de ayuda).
La clase org.eclipse.help.standalone.Infocenter
contiene un método
main()
que puede utilizarse para lanzar el centro informativo desde la línea
de mandatos. La sintaxis de los argumentos de línea de mandatos es:
-command start | shutdown | [-eclipsehome VíaAccesoInstalaciónEclipse] [-data ÁreaInstancia] [-host HostServidorAyuda] [-locales ListaEntornosLocales] [-port PuertoServidorAyuda] [-dir rtl] [-noexec] [opciones de plataforma] [-vmargs ArgumentosVMJava]
Para iniciar un centro informativo en el puerto 8081, emita un mandato start
ejecutando
java -classpath d:\miAplic\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\miAplic\eclipse -port 8081
Para cerrar el centro informativo, emita un mandato shutdown
ejecutando
java -classpath d:\miAplic\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\miAplic\eclipse
Inicie el centro informativo siguiendo las instrucciones anteriores. Haga que un
navegador Web señale a la aplicación Web "/help" ejecutada en el puerto
especificado al iniciar el centro informativo (por ejemplo, 8081). Por ejemplo
desde la máquina
en la que está instalado el centro informativo, sería http://localhost:8081/help/
.
Al incluir un centro informativo como parte de otra aplicación, puede ser más conveniente iniciarlo o detenerlo mediante llamadas a las API de Java en lugar de utilizar mandatos del sistema. Si este es el caso, siga estos pasos:
d:\miAplic\eclipse\plugins\org.eclipse.help.base_3.1.0.jar
se encuentra en la vía de acceso de clases de la aplicación. La clase que se
emplea para iniciar y concluir el centro informativo es
org.eclipse.help.standalone.Infocenter
.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:\\miAplic\\eclipse" , "-port", "8081" };
Help
pasando las
opciones. Infocenter infocenter = new Help(opciones);
helpSystem.start();
helpSystem.shutdown();
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 permitir el
acceso directo por parte de los clientes, 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://miempresa.com/miproducto/infocenter
a http://servidorinterno:8081/help
, que ejecuta un centro
informativo. Esto puede lograrse añadiendo las líneas
LoadModule proxy_module modules/ApacheModuleProxy.dll ProxyPass /miproducto/infocenter http://servidorinterno:8081/help ProxyPassReverse /miproducto/infocenter http://servidorinterno:8081/help
al archivo conf/httpd.conf
del servidor Apache que ejecuta el sitio web de
miempresa.
Algunas versiones del servidor Apache HTTP pueden contener una directiva AddDefaultCharset habilitada en el archivo de configuración. Elimine la directiva o sustitúyala por
AddDefaultCharset Off
para que los navegadores visualicen los documentos mediante el juego de caracteres correcto.
Pueden ejecutarse varias instancias de un centro informativo en una máquina desde una
instalación.
Cada instancia iniciada debe utilizar su propio puerto y tener un espacio de trabajo;
por tanto, deben especificarse las opciones -port
y -data
.
Las instancias pueden servir documentación desde diversos conjuntos de plug-ins,
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 conjuntos de entornos
locales solapados, debe asegurarse de 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 las instancias del centro informativo.
El soporte de filtrado se desactiva al ejecutar la ayuda en modalidad infocenter, que hace que todo el contenido, incluido el contenido filtrado, sea visible. Si tiene previsto alojar la documentación tanto en la modalidad de entorno de trabajo como en la de infocenter, debe utilizar los filtros de forma que tenga sentido aunque el filtrado esté desactivado.
El centro informativo no requiere todo el paquete de la plataforma Eclipse.
Es posible ejecutar un centro informativo con los siguientes plug-ins (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 plug-ins de documentación pueden tener dependencias de otros plug-ins, habitualmente especificando los plug-ins necesarios en su manifiesto de paquete compuesto. Los plug-ins dependientes tienen que instalarse también en el centro informativo.
Los plug-ins del centro informativo pueden actualizarse sin reiniciar el centro
informativo, utilizando los mandatos descritos en el tema
Actualizar un centro informativo en ejecución
desde la línea de mandatos. Para utilizar estas funciones, el conjunto mínimo de
plug-ins también debe incluir el plug-in org.eclipse.update.core
.
Consulte la sección Personalización de productos para obtener más información acerca de la personalización del sistema de ayuda.