How to localize your documentation output | HelpNDoc

How to localize your documentation output

To follow this guide, make sure you have downloaded and installed the latest version of HelpNDoc which is completely free for personal use and evaluation purposes. HelpNDoc is an easy-to-use, single-source help authoring environment which can produce multiple help, document and manual formats, including CHM, HTML, DocX, PDF, ePub and Kindle eBooks...

Step-by-step guide: How to localize your documentation output

Some templates include hard-coded English terms (such as "Table of contents", "Index", "Search") which needs to be translated when you generate your documentation in another language. This can easily be done on a build by build basis in HelpNDoc's generate documentation window.

Access the generate documentation window

Step 1

Click the top half of Generate help in the Home ribbon tab.

Customize a build

Step 2

This displays your build list along the left-hand side of the 'Generate Documentation' window.
Some standard build kinds allow you the option of translating some of the hard-coded titles:

  • HTML
  • Word
  • PDF
  • ePub
  • Kindle

Click the build that you'd like to customize in the build list.
If the template settings tab is not displayed, click Customize.
Place your cursor in the field as shown below and then enter the translated caption.

Translate an HTML build

1. HTML: You can define the titles of the 'Index,' 'Search,' and 'Contents' tabs.

Translate a Word, PDF, ePub or Kindle build

2. Word, PDF, ePub and Kindle: You can define the title for the 'table of contents' heading.

Thanks to HelpNDoc's build and template systems, it is easy to customize the look and feel of your generated documentation as well as translate its content.