Hjälpinnehåll

Bygga ett insticksprogram för hjälp

I det här exemplet utgår vi ifrån att en författare av dokumentation redan har försett dig med den råa dokumentation i form av HTML-filer. Detaljrikedomen och strukturen i de filerna är helt upp till dokumentationsgruppen. När dokumentationen har levererats går det att konfigurera insticksprogrammet och avsnitten separat.

Vi börjar med att utgå ifrån att dokumentationen redan har tillhandahållits i följande trädstruktur.

   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

Vi antar att insticksprogrammets namn är com.example.helpexample.

Första steget är att skapa en katalog för insticksprogrammet, com.example.helpexample under plattformens katalog plugins. Underträdet doc\ som visas ovan borde kopieras in i katalogen.

Insticksprogram för dokumentation behöver ett manifest precis som insticksprogram för kod. Följande märkord definierar insticksprogrammet för dokumentation.

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