Contenido de la ayuda

Construir un plug-in 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 la documentación. Una vez entregada la documentación, la configuración del plug-in y los temas se puede hacer de manera independiente.

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

   html/
      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 plug-in es com.example.helpexample.

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

Al igual que los plug-ins de código, los plug-ins de documentación necesitan un manifiesto. Los siguientes códigos XML definen el plug-in de documentación.

   <?xml version="1.0" ?>
   <plugin name="Ejemplo de ayuda en línea"
      id="com.example.helpexample"
      version="1.0"
      provider-name="MyExample" />