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:

http://www.helpinator.com/blog/2013/02/24/version-3-10-oraclehelp/

2. JavaHelp

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

Blog post about JavaHelp:

http://www.helpinator.com/blog/2013/01/10/version-3-9-javahelp/

3. HelpGUI

A lightweight help system with a limited set of features.

http://www.helpinator.com/helpgui.html

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:

http://www.oracle.com/technetwork/topics/index-083946.html

 

How to compile OracleHelp:

1. Download and install JDK:

2. Download and install OracleHelp

http://www.oracle.com/technetwork/developer-tools/help/utilsoft-ohw-422139.html

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

enoptionsoraclehelp

 

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

oraclehelptoolbar

 

Compiled OracleHelp looks like this:

oraclehelp-contents

oraclehelp-topic

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:

http://helpinatortest.wordpress.com

 

How to set up Helpinator to publish to WordPress:

1. Open your project

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

wptoolbar

 

3. Click “+” button to add new profile

publishtowordress-empty

 

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

account

 

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

accountcheck

 

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).

pagetemplate

 

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.

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.

webhelpnew

Version 3.9: QtHelp

Version 3.9 introduces support of QtHelp format. QtHelp is a help system built-in in Qt library, a cross-platform framework used by a lot of developers around the globe. QtHelp has very thoughtful design with help file collections, good HTML support and all essential features of modern help system and has detailed documentation.

To learn more please visit

http://doc.qt.digia.com/qt/qthelp-framework.html

To compile QtHelp you will need to download and install Qt SDK.

http://qt.digia.com/

Note that we recommend to use version 4.8 and higher.

You will also have to change Helpinator Compiler options (Main Menu->Tools->Options, “Compilers” tab).

enoptionsqtcompiler

 

Then you can compile QtHelp file in one click:

maintop

 

Compiled QtHelp file looks like this:

Contents:

qthelp

Index:

qthelp1

Search:

qthelp2

 

Note that for testing purposes Helpinator automatically creates separate help file collection for your project.

Version 3.9: JavaHelp

From version 3.9 Helpinator supports JavaHelp output format. JavaHelp is a native file format (html and xml files packed as JAR file) and a set of tools that allow you to use JavaHelp in desktop and web applications written using Java.

You can learn more about this format from it’s webpage:

http://javahelp.java.net/

 

To compile JavaHelp you will need the following prerequisites

1. Java SE Development Kit

http://www.oracle.com/technetwork/java/javase/downloads/index.html

2. JavaHelp SDK

http://javahelp.java.net/

 

Install both then update Helpinator options (Main Menu->Tools-Options)

 

enoptionsjavahelpcompiler

 

Then you can compile JavaHelp with a single mouse click:

maintop

 

Compiled JavaHelp help file looks like this:

Contents:

en-javahelp

 

Index:

en-javahelp1

 

Search:

en-javahelp2

 

Note that JavaHelp has outdated HTML viewer so only a subset of modern HTML features is supported. Therefore it requires it’s own HTML templates, templates for CHM/WebHelp/QtHelp are not compatible with this format.

 

To allow you to view resulting JavaHelp file Helpinator also compiles several supplementary files from JavaHelp SDK into the target folder.

 

testjavahelp