Ohjeen sisältö

Ohjelisäosan koonti

Tässä esimerkissä oletetaan, että dokumentaation tekijä on jo toimittanut sinulle raakadokumentaation HTML-tiedostoina. Näiden tiedostojen tarkkuus ja rakenne määräytyy täysin dokumentaatioryhmän mukaan. Kun dokumentaatio on toimitettu, lisäosan ja aiheet voi asentaa itsenäisesti.

Tässä oletetaan, että dokumentaatio on jo toimitettu seuraavassa rakenteessa.

   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

Tässä oletetaan, että lisäosan nimi on com.example.helpexample.

Luo ensiksi lisäosahakemisto, com.example.helpexample, ympäristön plugins-hakemiston alle. Edellä esitetty doc\-alirakenne on kopioitava suoraan hakemistoon.

Dokumentaation lisäosa tarvitsee ilmoitustiedoston aivan kuten koodin lisäosat. Seuraavat merkinnät määrittävät dokumentaation lisäosan.

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