Budowanie modułu dodatkowego pomocy

W tym przykładzie założono, że dokumentacja w formie plików HTML została dostarczona wcześniej przez autora. Stopień szczegółowości i struktura tych plików zależą całkowicie od zespołu zajmującego się dokumentacją. Po dostarczeniu dokumentacji konfigurowanie modułu dodatkowego i tematów pomocy może przebiegać niezależnie.

Zakłada się, że dokumentacja została dostarczona w strukturze poniższego drzewa.

   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

Zakładaną nazwą modułu dodatkowego jest com.example.helpexample.

Pierwszym krokiem jest utworzenie na platformie katalogu modułu dodatkowego o nazwie com.example.helpexample w katalogu plugins. Pokazane powyżej poddrzewo doc\ powinno zostać skopiowane do tego katalogu.

Moduły dodatkowe dokumentacji wymagają plików manifestu tak samo, jak moduły dodatkowe kodu. Poniższy fragment kodu definiuje moduł dodatkowy dokumentacji.

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