Компоновка модуля справки

В этом примере предполагается, что документация уже предоставлена авторами в виде файлов HTML. Структура и степень подробности этих файлов полностью определяются группой разработки документации. После доставки документации настройку модуля и разделов справки можно выполнить независимо друг от друга.

Предположим, что предоставлена следующая структура документации.

   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

Кроме того, предположим, что модулю присвоено имя com.example.helpexample.

В первую очередь в каталоге plugins платформы необходимо создать каталог модуля com.example.helpexample. Затем в этот каталог следует скопировать дерево doc\, показанное выше.

Для модулей документации, также как для модулей исходного кода, необходимо указать манифест. Ниже приведен пример текста на языке описания, описывающего модуль документации.

   <?xml version="1.0" ?>
   <plugin name="Пример электронной справки"
      id="com.example.helpexample"
      version="1.0"
      provider-name="MyExample" />