Naming Conventions

General Remark

JHelpDev generates the names of the targets in a certain a way. You might take that into accout, when you choose names for your content files. Also the XML files have to be named in a certain way.

URL to Target

URL's are relative to the project directory. This makes it possible to move the helpset to another directory without making the targets invalid. The generated targets consist of the relative filenames with a . instead of the / and without the filename suffix.

Example:
URL: html/welcome.html
target: html.welcome

Of course you should avoid having two files with which only differ in the suffix *.html and *.htm or *.gif in the same directory. In that case your target would not be unique for JavaHelp and only one of the files would be found. The suffix is omitted from the target to achieve slightly better readability of the targets in the editors.

Targets within HTML files

If a target marked with <a name="xxx"></a> is recognized in a HTML file, an extra target is created. The same rules for creating the target apply as for the content file, except that the suffix _xxx is appended to the target name. xxx is the name of the target, for instance a title of a section.

Example:
URL: html/importxml.html#importTOC
target: html.importxml_importTOC

Special Targets

There are two special targets:

  • TOP is for the default content file that is shown, when the helpviewer is displayed.
  • popup_icon is reserved for the image that indicates a popup or secondary window.

XML Filenames

JHelpDev creates the following files:

  • %projectdir%/%projectname%.hs to store the main helpset file.
  • %projectdir%/Map.jhm to store the mapfile.
  • %projectdir%/%projectname%Index.xml to store the index.
  • %projectdir%/%projectname%TOC.xml to store the TOC.

See also: Import XML