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.

webhelpnew

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.

image

 

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.

Version 3.9: EPUB and MOBI

EPUB and MOBI are one of the most popular eBook formats. Now you can crate documentation in both of this formats using Helpinator.

 

maintop

 

Helpinator created EPUBs internally, but to compile MOBI you will need KindleGen utility from Amazon:

http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211

Download and install it then update Helpinator options (Main Menu->Tools->Options, “Compilers” tab).

enoptionskindlecompiler

 

Now you can compile MOBI format.

Note that you will need EPUB and MOBI format viewers to preview compiled documentation. You can use Kindle Previewer for both:

http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765261

en-kindle

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

EPUB and MOBI

EPUB and MOBI are very popular e-book formats for handheld devices. Helpinator creates EPUB files directly, but to compile documentation in MOBI format you will need Amazon’s KindleGen command line tool and Kindle Previewer to see how your documentation will look like on Kindle.

To download KindleGen click here: http://www.amazon.com/gp/feature.html?docId=1000234621

To download Kindle Previewer click this link: http://www.amazon.com/gp/feature.html/?docId=1000765261

KindleGen comes in ZIP archive so you will have to unzip it, Kindle Previewer comes with installer.

Once you have KindleGen unzipped, run Helpinator, select Main Menu->Tools->Options, “Compilers” tab and path to the KindleGen folder into the “MOBI” field.