Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

4 Add the help content.

It must be added in a folder named javahelp which must be created under src/main. Here, create the path which is given in the helpset.xml above. It is also mandatory that the path ends with the docs folder. Finally, you end up with a path for the sst example which looks like src/main/javahelp/org/esa/snap/snap/aatsr/sst/docs/help.hs.

...

help.hs references all help files (map.jphj,m toc.xml, search, ...)

maps.jhm make the links between help page id and urls

toc.xml is the table of content, it lists the pages to display and menu entries, telling what page is displayed where. To add an a help page on to an existing help menu it has to must match the menu organisation bellow. For example, to add a geometric processor the toc.xml file could look like that:

...

Where myGeometricProcessor is the id of the help page referenced in the map.jph jhm file. For more information about javahelp see jhug.pdf

...