Innhold i hjelp

Bygge en plugin-modul for hjelp

I dette eksempelet forutsetter vi at dokumentasjonsforfatteren allerede har utstyrt deg med grunnleggende dokumentasjon i form av HTML-filer. Hvilket detaljnivå og struktur disse filene har, avhenger helt og holdent av dokumentasjonsgruppen. Når dokumentasjonen er levert, kan plugin-modulen og emnene defineres fritt.

Vi starter eksempelet med den forutsetning at dokumentasjonen allerede er oppgitt i følgende tre.

   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

I dette eksempelet er navnet på plugin-modulen com.example.helpexample.

Som første trinn må vi opprette en plugin-katalog, com.example.helpexample under plattformkatalogen plugins. Undertreet doc\ ovenfor må kopieres til katalogen.

I likhet med plugin-moduler for kode krever plugin-moduler for dokumentasjon et manifest. Kodetypen nedenfor definerer plugin-modulen for dokumentasjon:

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