How to Use Code Snippets

Version 3.7 introduces new feature – “Code Snippets”. Essentially, “code snippet” is a formatted portion of code you use in your help file to show how to use your library, document API or something like that. Helpinator now has “Code snippets” manager, code editor with syntax highlighting and a new pseudo-tag to insert code snippets into editor.

Here’s how it looks like.

Code snippets manager. You can hide it from the tree and show again using the visibility control button on the left.

codesnippets

 

You can add, rename and delete snippets and also import them from the file.

 

Code editor looks like this:

codesnippet

 

It has cut/copy/paste/import from file toolbar buttons and syntax selector.

 

To insert code snippet into topic editor use “CODE” pseudo-tag like this:

editorcodesnippet

 

On compile time Helpinator will turn a snippet into corresponding format. Here how it looks like in CHM:

codesnippet-chm

 

And in PDF:

 

codesnippet-pdf

Image Tools

Version 3.6.3 adds new feature: “Image Tools”. It is under the “Tools” node in the project tree view.

imagetools-tree

For now it contains only one tool: “Move Images To The Library”. This tool allows you to move all embedded topic images to the image library, optionally converting them to the desired format (PNG recommended).

image-tools

 

Later we will add more tools like “Resize images”, “Unclone” and more.

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.