How to migrate a custom template when a new version of HelpNDoc is released | HelpNDoc

How to migrate a custom template when a new version of HelpNDoc is released

HelpNDoc includes a very powerful template processor where you can customize any part of the generated documentation. Most of the time, you'll use the default template of the documentation format you'd like to customize as a starting point. But when a new version of HelpNDoc is released, the default template might have evolved with new features and fixes, and you might want to include those changes in your custom templates. The solution is to compare and merge the updated default template with your own one. Let's see one way to painlessly and reliably achieve this task.

Locating templates on the hard drive

Before comparing them, we first need to locate both the default and custom templates on the hard drive.

The default templates are located in HelpNDoc's installation directory, in the "templates" sub-directory. Based on your system, this usually is either:

  • C:\Program Files\IBE Software\HelpNDoc 5\Templates\
  • C:\Program Files (x86)\IBE Software\HelpNDoc 5\Templates\

The custom templates' default path is in "My Documents\HelpNDoc\Templates\". It can be customized in HelpNDoc's options dialog by clicking "File", then "Options", then "Custom paths" and reviewing the "Templates path" option.

Locate templates

Starting with HelpNDoc 5.8, the template editor can be used to quickly open a template's folder:

  1. From HelpNDoc's "Tools" ribbon bar item, click "Template Editor"
  2. Select the template that you'd like to locate in the list
  3. Click the "Open template location" button to open its location in Windows Explorer

Comparing both templates

Manually comparing files and folders can be a lengthy and error-prone process. Fortunately, some software are available to perform that task easily and reliably.

Compare folders

One possible solution is to use a software such as the free WinMerge to find the differences between your own template and the default one. Once both templates have been located:

  1. Open WinMerge
  2. Drag and drop the default template folder on the WinMerge window. This will be the "Left" project
  3. Drag and drop the custom template folder on the "Right" field of the WinMerge window
  4. Click "OK"

Use WinMerge to compare files and folders

WinMerge can then be used to rapidly and reliably compare files and folders, and include the required modifications by copying the left part to the right when needed.

To learn more about WinMerge, you can check the project's documentation and to start creating amazing documentation and help files, download the free HelpNDoc help authoring tool now.