Sistema de ayuda
El conector del sistema de ayuda, org.eclipse.help, define dos puntos
de extensión ("contexts" y "toc") que permiten que los
conectores individuales aporten ayuda contextual y ayuda en línea para sus
componentes. Un conector típico que proporcione documentación utilizaría estos
dos puntos de extensión.
Hay otros puntos de extensión que permiten ampliar las posibilidades del
sistema de ayuda.
Para aplicaciones más avanzadas, también existe un punto de extensión
("support") que sirve para conectar una UI del sistema de ayuda.
Puntos de extensión
Para ampliar el sistema de ayuda, pueden utilizarse los siguientes puntos de
extensión:
Preferencias
Con el sistema de ayuda se pueden usar los siguientes valores de preferencias:
-
log_level: indica qué clase de información se escribe en el archivo de
anotaciones de ayuda. Los valores posibles son estos tres:
- 0: solo se anotan los errores
- 1: se anotan los errores y los avisos
- 2: se anotan los errores, los avisos y los mensajes informativos (depuración)
- banner: la vista de ayuda permite mostrar rótulos de
aplicaciones. Si desea que en
la parte superior de la vista de ayuda aparezca el logotipo de una empresa o
cualquier otro rótulo, especifique la página HTML con este formato
/idConector/vía_de/acceso_a/banner.html. Actualmente, el valor de
banner por omisión es /org.eclipse.help.webapp/banner.html. Si establece este
nombre en una serie vacía, no se mostrará ningún rótulo.
- banner_height: la altura del área del rótulo. Actualmente, el valor
por omisión es 45.
- help_home: la página que debe mostrarse en el área de
contenido al abrir la ayuda. La página HTML se debe especificar con el formato
/idConector/vía_de/acceso_a/home.html. Actualmente, el valor de
home por omisión es /org.eclipse.help/doc/help_home.html.
- linksView: establezca este valor en true o en false para controlar
la visibilidad de la vista de enlaces relacionados.
- baseTOCS: lista ordenada de las tablas de contenido de ayuda (libros)
tal como figurarían en la estantería. Las demás tablas (TOC) figurarán a
continuación de estos libros. Las tablas de contenido que no figuren en esta
lista no se tendrán en cuenta. La ubicación de cada tabla de contenido se
indica con el formato /idConector/vía_de/acceso_a/toc.xml.