Editor de la ayuda de contexto

La ayuda según contexto es un mecanismo que habilita el enlace de un componente de interfaz de usuario con un tema de ayuda específico. Cuando el usuario activa el componente de interfaz de usuario, la página de ayuda se visualiza en el área de ayuda dinámica. La interfaz de usuario y las páginas de ayuda están asociadas entre sí de dos formas: un archivo XML estático o un proveedor de contexto dinámico. Para asociar páginas estáticamente, es necesario crear un archivo xml de ayuda de contexto. El editor de ayuda de contexto le ayuda a crear estas páginas.

La página Definición del editor proporciona una vista gráfica del archivo xml, separada en dos columnas. La de la izquierda se llama Ayuda según contexto y muestra los elementos xml en formato de árbol conjuntamente con acciones para añadirlos, moverlos y eliminarlos. La otra columna proporciona información más detallada acerca del elemento seleccionado en la columna de la izquierda y habilita la edición de los detalles.

La página Fuente del editor proporciona una vista textual del archivo xml. El xml puede editarse directamente y cambia, si es válido, se reflejará en la página Definición gráfica.

Añadir contexto de ayuda nuevo

Editor de contexto de ayuda con campos cumplimentados

Para añadir un contexto nuevo, pulse el botón Añadir contexto. Esto añadirá una entrada de contexto nueva al archivo xml y se visualizará en el árbol, en la página Definición. El contexto nuevo se seleccionará, abriendo una sección de detalle en la columna derecha del editor. En esta sección de detalle puede proporcionar información más detallada acerca del contexto, incluyendo lo siguiente:

Añadir temas de ayuda y mandatos

Al añadir un contexto al archivo se proporcionará una descripción básica a la ayuda dinámica para que la muestre al usuario. Normalmente querrá proporcionar enlaces adicionales a temas relacionados en el sistema de ayuda. Para hacer esto, debe añadir temas y mandatos al archivo xml.

Editor de contexto de ayuda con campos de detalles cumplimentados

Al pulsar el botón Añadir tema, añadirá una entrada de tema nueva al xml bajo uno de los contextos de ayuda. Aparecerá un tema como un enlace para el usuario. Una vez creado un tema nuevo, puede seleccionarlo para abrir la sección Detalles de tema en la columna derecha de la página Definición. En la sección de detalle puede cambiar la etiqueta que se mostrará al usuario y la ubicación del archivo enlazado. En la mayoría de casos, el archivo enlazado será una página html en el sistema de ayuda. Puede utilizar el botón Examinar... para buscar un archivo a enlazar.

Además de los temas, podrá añadir un mandato. Un mandato tiene el mismo aspecto para el usuario que un tema. Sin embargo, cuando se activa el enlace, se ejecuta un mandato de código en lugar de abrir un archivo. Los mandatos pueden utilizarse para abrir páginas de preferencias y ejecutar otras acciones.

Añadir mandato de editor de contexto de ayuda

Pulse el botón Añadir mandato para añadir un mandato nuevo. Puede editar los detalles de los mandatos de la misma forma que edita los temas.

Mandatos eliminar, subir y bajar

Hay tres botones adicionales en la página Definición que permiten manipular el orden de los elementos en la lista de contexto o suprimir los elementos.

Contexto de ayuda con botones de manipulación

Estos botones son:

Registrar el archivo de ayuda de contexto

Para que Eclipse reconozca el archivo xml de ayuda de contexto como origen del sistema de ayuda dinámico, debe registrarse a través del punto de ampliación org.eclipse.help.contexts. El editor proporciona una forma de registrar automáticamente el archivo de ayuda de contexto. En la esquina superior derecha del editor, hay un enlace llamado "Registra este archivo de ayuda de contexto". Al pulsar sobre este enlace se añadirá la entrada correcta al archivo plugin.xml.