Hjælp - indhold

Byg en hjælp-plugin

I dette eksempel antages det, at forfatteren af dokumentation allerede har stillet rådokumentationen i form af HTML-filer til rådighed for dig. Disse filers detaljeringsgrad og struktur er helt overladt til dokumentationsteamet. Når først dokumentationen er leveret, kan konfigurationen af plugin'en og emnerne udføres separat.

Det antages, at dokumentationen allerede er leveret i følgende træstruktur:

   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

Det antages, at navnet på plugin'en er com.example.helpexample.

Det første trin bestå i at oprette et plugin-bibliotek, com.example.helpexample, der ligger under platformens plugins-bibliotek. Ovenstående doc\-undertræstrutkur skal kopieres til biblioteket.

Dokumentations-plugins skal bruge et manifest på samme måde som kode-plugins. Følgende kode definerer dokumentations-plugin'en.

   <?xml version="1.0" ?>
   <plugin name="Eksempel på onlinehjælp"
      id="com.example.helpexample"
      version="1.0"
      provider-name="MitEksempel" />