Crear un conector de ayuda

En este ejemplo se presupone que el autor de una documentación ya le ha suministrado el borrador de la misma en forma de archivos HTML. La granularidad y la estructura de estos archivos depende completamente del equipo de documentación. Una vez se ha enviado la documentación, se puede establecer el conector y los temas de manera independiente.

Se presupone que la documentación ya ha sido proporcionada siguiendo este esquema de árbol:

doc/
    concepts/
        concept1.html
        concept1_1.html
        concept1_2.html
    tasks/
        task1.html
        task2.html
        task3_1.html
        task3_2.html
    ref/
        ref1.html
        ref2.html

Se presupone que el nombre del conector es com.example.helpexample.

El primer paso es crear un directorio para este conector, com.example.helpexample, debajo del directorio de plugins de la plataforma. El subárbol doc\ que se ha mostrado anteriormente debe copiarse en el directorio.

Al igual que los conectores de código, los conectores de documentación necesitan un manifiesto. La marcación siguiente define el conector de documentación.

<?xml version="1.0" ?>
<plugin name="Online Help Sample"
    id="com.example.helpexample"
    version="1.0"

    provider-name="MyExample" />