Help archive

The help archive file is a zip file which is the output of the help generation. It contains:

• The articles and resources of the wiki, to use in the integrated help component
• A database which contain the list of articles, titles, and their relative paths to their files
• The files for the articles and resources
• README.txt file which indicates for which format the Help content has been generated, and also if the content allows a full text search

Database

The database^[1]

See The Help database schema

contain the list of articles, titles, and their relative paths to their files.

Content specificities

The content of the archive has some specificities depending on if it is optimized for the Help Swing API or the Help JavaFX API.

Usage

The URL of this zip file is the one which must be used in the JavaHelpFactory(URL) method. See Help API overview for more information.