Las ayudas emergentes se describen asociando el ID de contexto declarado en el código de la UI con una descripción y una lista de enlaces a temas relacionados de la ayuda en línea.
Estas asociaciones se efectúan dentro de un archivo XML. Puede crear cualquier número de archivos XML que contengan asociaciones de ayudas emergentes para cada conector. La
descripción y los enlaces de cada ID de contexto se efectúan dentro de elementos
<context> del archivo XML. Cada elemento de contexto puede tener un elemento <description> opcional, utilizado para describir el objeto de UI y cualquier número de elementos <topic> que enlazan con la documentación en línea.
<contexts> <context id="panic_button"> <description>Este es el botón Pánico.</description> <topic href="tasks/pushing_the_panic_button.htm" label="Pulsar el botón Pánico"/> <topic href="reference/panic_button.htm" label="Referencia del botón Pánico"/> </context> ... </contexts>
Una vez que se han descrito los contextos en el archivos o archivos XML, ya puede hacerse referencia a los archivos de contexto en el manifiesto del conector. Observe que el ID de contexto utilizado en el ejemplo no está totalmente calificado. Esto está permitido siempre que el archivo de contexto se añada al manifiesto del conector que ha definido el ID de contexto. En otras palabras, el ID de contexto se resuelve en el ID del conector que ha aportado el archivo XML.
Un conector aporta archivos de contexto mediante el punto de extensión org.eclipse.help.contexts.
<extension point="org.eclipse.help.contexts"> <contexts name="myInfopops.xml" /> </extension>
Podrá hacer referencia a los archivos de contexto desde otros conectores si incluye el atributo plugin. Esto le permite agrupar la totalidad de su documentación, incluso las ayudas emergentes, en un solo conector, y hacer referencia a él desde el conector del código de la UI o desde otro conector relacionado.
<extension point="org.eclipse.help.contexts"> <contexts name="myInfopops.xml" plugin="com.example.helpExample" /> </extension>
Como puede observar, dispone de gran flexibilidad para organizar las ayudas emergentes en uno o varios archivos contenidos en uno o varios conectores. La consideración principal a tener en cuenta es que los ID de contexto de los archivos deben resolverse correctamente. Si no califica totalmente un ID de contexto, debe añadir los archivos XML de contexto al conector que ha declarado los ID de contexto. Si utiliza ID de contexto totalmente calificados en el archivo XML de contexto, tiene completa libertad para elegir la ubicación de los archivos XML y el conector que aporta los contextos.
Otro nivel de flexibilidad es la capacidad de aportar ayudas emergentes para el mismo ID de contexto desde distintos conectores. Esto es de utilidad si hay, por ejemplo, distintos conjuntos de conectores de documentación que se puedan o no instalar en la configuración de un usuario. Esto permite que cada conector de documentación declare sus contextos de forma independiente. El usuario final verá el contenido fusionado de las ayudas emergentes de todos los conectores que hayan aportado contextos para el ID del widget.
Tenga presente que hay que utilizar el ID de contexto totalmente calificado del widget, porque ninguno de los conectores de documentación declaró el ID de contexto. Cuando hay varios conectores que aportan ayudas emergentes para un mismo ID de contexto, el que se muestra en primer lugar es el contenido definido en el conector que declaró el contexto (el conector de la UI). Las descripciones y los enlaces adicionales se añaden a continuación, aunque en un orden indefinido.