Treść pomocy

Tworzenie wtyczki 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 wtyczki 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ą wtyczki jest com.example.helpexample.

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

Wtyczka dokumentacji wymagają plików manifestu tak samo, jak wtyczki kodu. Poniższy fragment kodu definiuje wtyczkę dokumentacji.

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