Comparison with JavaHelp

As explained in wikipedia, JavaHelp is both an application and a format for online help files that can be displayed by the JavaHelp browser.

The main difference between the help feature of docJGenerator and JavaHelp is that JavaHelp does NOT help (excuse the pun) for producing the content. You still need to write by hand the html files which constitutes the help articles, or find another tool to produce them, and then process the result to fit with how Javahelp need the content to be^[1]

And also create the HelpSet and Table of content

. Also JavaHelp can not be directly integrated in a JavaFX application^[2]

Except maybe by wrapping a Swing node in the JavaFX content

.

Comparison table

Concept	JavaHelp	docJGenerator help
Articles	Does NOT help for producing the content. You still need to write by hand the html files which constitutes the help articles, or find another tool to produce them, and then process the result to fit with how JavaHelp need the content to be	The content is generated by docJGenerator
Table of content	Specified manually	Automatically generated using the articles categories
Articles map	Specified manually	Automatically generated
Help content archive and HelpSet	The Help content archive is a Jar file. The HelpSet merge notions about the articles map, the table of content, and the classes implementing the help system. The Jar file containing the help content refers to the Java implementation of the Help system	The Help content archive is an implementation-independant zip file containing the articles
Merge help content	Supported	Supported
Use hand-written HTML articles	Supported	Supported
Use autogenerated HTML articles	Not supported	Supported
JavaFX integration	Not supported	Supported
Context-sensitive help	Supported	Supported
Full text search	Supported	Supported

More information about JavaHelp

JavaHelp code has moved to javaee.github.io/javahelp/. Oracle informations on how to use JavaHelp can be found here.

Converting JavaHelp content

It is possible to convert a JavaHelp content (stored in a jar file) to the docJGenerator Help content format to use it in the Help system.