Conectar la ayuda

Los servicios de ayuda de la plataforma Eclipse proporcionan los elementos esenciales en bruto que le permiten estructurar la plataforma y contribuir en ella con la documentación. Esto no indica la estructura de la documentación ni su granularidad. Puede elegir las herramientas y la estructura de la documentación que más se ajuste a sus necesidades.  El conector de la ayuda le permite describir la estructura que debe tener la documentación en la plataforma utilizando un archivo de tabla de contenido (toc).

Para contribuir con la ayuda en línea de su conector, utilizará el punto de extensión org.eclipse.help.toc. Puede contribuir con la ayuda en línea como parte del conector de código o bien proporcionarla por separado en el propio conector de documentación.

El hecho de separar la documentación en un conector aparte presenta ventajas en aquellas situaciones en las que el equipo de código y el equipo de documentación pertenezcan a grupos distintos o en aquellas en las que desee reducir el acoplamiento entre la documentación y el código.

Las características avanzadas del sistema de ayuda incluyen la ayuda según contexto con enlaces de consulta y la capacidad de invocar el código de la plataforma desde la documentación.   Hay un navegador de la ayuda que le permite ver la documentación, imprimirla y buscar en ella. A partir de la versión 3.1, se han añadido las posibilidades de ayuda dinámica e información federada en la nueva vista de Ayuda.

La mejor manera de hacer una demostración de la contribución de la ayuda es creando un conector de documentación.