Java Help Systems Supported By Helpinator

As of version 3.10 Helpinator supports the following Java-oriented help systems:

  1. OracleHelp,
  2. JavaHelp
  3. HelpGUI


1. OracleHelp

The most powerful and well-thought help system for Java created by Oracle Corporation. Has two “branches”: OracleHelp for Java and OracleHelp for Web. New versions come out regularly.

Blog post about OracleHelp:

2. JavaHelp

Original Java help system. Outdated and is not under active development.

Blog post about JavaHelp:

3. HelpGUI

A lightweight help system with a limited set of features.

Version 3.10: OracleHelp

Version 3.10 adds new output format: OracleHelp. This format and help system is maintained by Oracle. It has two “modes”

1. OracleHelp for Java – for use with Java applications

2. OracleHelp for Web – for use as a WebHelp.


Using Helpinator you can create source data for both “modes”. It creates “books” for all languages in the project and OracleHelp for Web configuration file.

Also Helpinator creates “launcher.cmd” file for easy testing of your help system.

You can read more about OracleHelp here:


How to compile OracleHelp:

1. Download and install JDK:

2. Download and install OracleHelp

3. Set Helpinator options (Main Menu->Tools->Options, “Compilers” tab)



4. Now you can click “Compile OracleHelp” on the main tool bar.



Compiled OracleHelp looks like this:



Version 3.10: Publish to WordPress

Version 3.10 introduces new feature: “Publish to WordPress”. WebHelp is a great thing, but if your website has CMS you have to manage static HTML pages of WebHelp and dynamic content of CMS separately. It’s far better to use built-in features of CMS to organize online help system. Now Helpinator allows you to work with the most popular CMS in the world – WordPress. You can:

  • publish topics to your WordPress-powered website, with tree-like structure of pages
  • publish documentation under selected page (For example, if you have a page named “Support” you can publish documentation under this page)
  • select one of the page templates available in your WordPress theme
  • republish changed topics

Helpinator also creates root “Table of Contents” page with hierarchical links to topics.

You can also turn your WordPress installation into a knowledge base website using Helpinator as a client for it.

Visit this sample WordPress site to see Helpinator documentation published to WordPress:


How to set up Helpinator to publish to WordPress:

1. Open your project

2. Click “Publish to WordPress” button on the toolbar:



3. Click “+” button to add new profile



4. Fill in Blog URL, username and password to connect to WordPress installation.



5. Click “Check connection” to check that URL, username and password are correct



6. Click “Refresh” button next to “Page Template” drop-down list. This will populate the list of available page templates (in your current WordPress theme).



7. Select page template to use for documentation topics


8. If you need to place online documentation under certain wordpress page:

8.1. Click “Refresh” button next to “Parent page” drop-down list and select one of existing pages

8.2. Select “Root page order” – this number defines position of documentation root page in the list of child pages of “Parent Page”.

9. Now you can click “Save” to save your account or click “Publish” right away.

Note that:

1. To enable REpublish feature you have to save your project after Helpinator finishes publishing.

2. Helpinator does not store your password for security reasons

3. WordPress XML RPC protocol at this time doesn’t allow to update or delete images (there’s a bug in it) so after you REpublish your documentation you will have to remove excessive images manually.

How To Add Templates for New Formats to Existing Projects

By default projects creates with earlier versions of Helpinator has empty fields for the new formats and no specialized templates in them (For EPUB, MOBI and JavaHelp for example). So you need to add them manually.

First of all select “HTML-based templates” node in the project tree view and click “+” sign. “Add Template” dialog appears.

Add Template


Note the list of compatible formats under the “Built-in” templates drop-down list. When you select a template it shows what formats you can compile using it. Say, we need to add a template for EPUB format, so we select “epubmobi-default” template and click “OK”. Helpinator adds this template to the list of available templates.

Now you can select this template in the project options, “Templates” tab.

Helpinator 3.9 - Untitled (Unregistered)

Version 3.9: More WebHelp Options

Version 3.9 introduces several new options for WebHelp generation. Their aim is to provide more compatibility with browsers and security settings. First of all, now there are two additional “Modes” besides old “With Frames”:

  1. Frameless. In this mode Helpinator generates a set of HTML files and index.html with TOC. There will be no frames and left-hand menu.
  2. Single page. In this mode Helpinator generates single HTML page with all topics in it and TOC at the top.

All three available modes (“With Frames”, “Frameless”, “Single Page”) have additional switch “Plain HTML (No Scripts)”. This switch disables all system JavaScripts (like Jquery, Syntax highlighter, Google Analytics and etc.) and plain HTML is used instead for syntax highlighter and step-by-step-guides.

Toolbar button “WebHelp” function remain the same – “With frames” and Scripts turned on. To alter WebHelp mode you have to use new “Batch Compile” function.


Version 3.9: Batch Compilation

New version introduces new “Compile All” command, now called “Batch compile”. In previous version you were able to compile only one version of target file at a time. Now you can compile different variations of the same format (or all formats if you prefer). For example you can compile CHM files for all supported languages and variable presets present in the project.



At the bottom left corner there are two buttons: “Save Batch” and “Load Batch”. Using them you can save created batch to external file and load it back. (Helpinator stores current batch to the project file). Also you can use created batch file with command-line utility chelpinator.exe passing it as the first parameter.