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)

Helpinator Copy Code Button

Q: Why there’s no “copy code” button for code snippets in CHM and WebHelp?

A: Incorporating “copy code” button requires some non-js code, Flash in particular, and that will make your CHM help files completely unusable because of security settings users may have. To copy a code snippet content from CHM file just double click it to select it entirely and click Ctrl+C.

How to Prototype Help Project Quickly

Helpinator allows you to build new help project in seconds. Here’s how:

1. Add several topics at once. You can create all project structure using simple plain text format. Use “tab” to identify levels.

addtopics

Add Topics

2. Add images. When you add images to Helpinator’s image library you can check option to add new topics with added images.

 

Add Images

 

3. Add topics as you capture new images. The same as above but using Screenshot tool.

4. Import existing “readme.txt”, “license.txt”, “gettingstarted.doc” and other documents that already exist in your project using Import Tools.

How to Add Annotations to Screenshots

Helpinator’s Image Library allows you to add various shapes with text and arrows to your screenshots, making it easy to describe program UI. To enable it, first select image in the tree view, then select “Tools->Activate Shape Editor”. Then you should select style for the shapes, default is “Red and Yellow”, meaning red lines and arrows with yellow background. You can read more on how to create styles.

image

 

To add new shape:

1. Select it on the toolbar

2. Click anywhere on the image where you want to place it.

How to Capture and REcapture screenshots in Helpinator

Helpinator allows you to capture screenshots of active windows with part of their background. Image Library serves as a storage for screenshots. There you can add annotation to screenshots and create clones. You can also assign category and automatically create topics for captured screenshots.

 

capture

 

Mode – select what you want to do – capture new image or recapture image that already exists in the library.

If you choose to capture new image you have to specify File name format and category for image. You can use several predefined placeholders:

Name Description
WINCAP Caption of the captured window
EXT Extension of the image format (see below)
HOUR Current hour
MIN Current minute
SEC Current second

 

If you choose to REcapture image you need to specify it in the drop-down list. Only background will be replaced, shapes will remain the same. You can use this trick to update cloned images easily. Here’s an article with detailed instructions:

http://www.helpinator.com/blog/2011/08/26/why-you-should-use-cloned-images/ 

 

- “Image Format” – specifies image format to store images to. You can select between PNG, BMP, JPEG and GIF.

- “Create topic” – if this option is checked then right after a window is stored to the library Helpinator creates topic with the same name containing captured image.

- “Append to topic” – if this option is checked and topic is selected from the drop-down list, Helpinator adds captured image to the end of the topic.

- “Background width” – specify what part of the active window background to capture along with the window itself. For example, if set to 30 pixels, then Helpinator will capture active window and surroundings with 30 pixels to the left, right, top and bottom. Set to 0 if you don’t want to capture background.

- “Background Effect” – select effect to apply to the background of the window. You can select from Blur, Darken, Pixelate and so on.

- “Drop shadow” – check this if you want active window to have a shadow on the background.

All this options combined allow you to take screenshots like this:

image

- “Hotkey” – select hotkey to trigger screen capture. Default is “Ctrl-Alt-S”

To start capturing images click on “Start” button.

How to Import Existing Documentation to Helpinator

Basically there are two ways to do it:

1. Using “Convert to H3 project” tool.

2. Using “File->Import files…” command.

Convert to H3 project

This tool is under "Helpinator” start menu group. When you run it dialog like this appears:

Convert to Helpinator 3 project

 

Source type – select type of the source files here. You can import:

1. Old Helpinator project

2. Compiled CHM file (if you don’t have the source for it).

3. HTML Help compiler project – if you were authoring CHM files using standard Microsoft tool – Help Workshop

4. RTF/HTML/TXT/DOC files – import variety of text file formats, from selected folder. To Import DOC files you need to have Microsoft Word installed.

 

Source – path to the source files or directory with source files (in case of source type #4).

Destination type – select type of Helpinator project to create. Single-file project stores all data inside one zip-compatible project file. “Multiple files” mode is better if you use come kind of VCS system in your project.

Destination – path to destination project. A filename or a directory path, in case of destination type #2.

Language – select default language for the project with imported data.

 

Click “Run” to start conversion. After it’s done you’ll be able to open destination project in Helpinator.

 

File->Import Files

 

This command acts identically to the “ RTF/HTML/TXT/DOC ” option from above, but is more useful to import files into existing projects. Select path to the directory with files to import and click “OK”.

Upgrading CHM\Web Help templates to support “Glossary”

You will have to add several lines of CSS code to your template for “Glossary” to work correctly.

1. Start new Helpinator project, select default templates

2. Select CHM\Web Help templates in the project tree view

3. Select “default.css”, browse to the end of it.

4. Copy the following code:

.glos_letter {
font-size: 12pt;
        font-weight: bold;       
        margin-top: 10px;
}

.glos_term {
        font-weight: bold;
        margin-top: 10px;                  
}

5. Open your project, select “.css” files of your templates and paste the code there.

Printed Manuals

From version 3.6 Helpinator allows you to create “Printed Manuals”. They are much like “PDF” mode but Helpinator sends them directly to printer, with “Preview” phase of course. To create printed manual click “Printed Manual” icon on the main app toolbar.

printbutton

 

Helpinator then will prompt you to select printer and will render “Preview”.

printedmanual

 

You can browse pages, check everything’s fine and when you are satisfied click "Send to Printer" to print it.

Why you should use “cloned” images

Helpinator’s “Image Library” allows you to create “cloned” images. What are they?

 

Let’s say you have a big complicated tool bar in your application. You need to explain your users how to work with it, what buttons trigger specific actions, all grouped by specific tasks… This probably will require a lot of copies of the toolbar image, each one with it’s own callouts, arrows and text boxes, but all with the same background – application toolbar.

 

Now suppose that during project evolution toolbar changes significantly – updated icons, some new buttons. Now you need to update a bunch of images to reflect changes in the UI. That could be a nightmare! But not if you use Helpinator’s image library and “cloned” images.

 

In the following example will’ take a look at one simple but very common situation. Suppose you have a set of images in your project, describing different parts of the toolbar, but all of them contain application name and version in the  window title like this:

 

langbar

 

One image has callouts for language bar:

 

langbar2

 

Another for compile buttons, and so on…

 

langbar3

 

We’ll make the first one “donor” image and two other images will be cloned.

 

addclonebutton

 

Now suppose application version changes to 3.5. You need to update all those images. Luckily you have only one basic image and two clones, so you only need to update one image.

 

Select Tools->Replace bitmap when basic image is open in the editor.

 

replacebmp

 

Now all cloned images are updated:

 

langbar2

langbar3