Discover a treasure trove of invaluable insights and shortcuts to maximize your proficiency with the HelpNDoc help authoring tool. Unearth hidden gems, streamline your workflow, and unlock the tool’s full potential as you delve into a collection of expert tips and tricks. From mastering advanced formatting techniques to harnessing time-saving features, this tag is your guide to becoming a HelpNDoc virtuoso. Elevate your documentation creation process, boost efficiency, and craft polished, professional help content with ease. Explore the Tips and Tricks section and embark on a journey to become a HelpNDoc maestro.

Tips and Tricks

Use variable placeholders to produce documentation for various cultures

Use variable placeholders to produce documentation for various cultures
Categories: Articles

When producing a help file, a user manual or an eBook, it is not only important to provide translations based on the targeted audience, but also to use the proper terms based on the readers' languages. Let's take the "colour" term as an example: "color" is the preferred spelling in American English while "colour" is preferred in all other main varieties of English. As a technical writer, supporting multiple language variants can lead to complications and extra work to make sure that the whole documentation is error-free. Thankfully, the HelpNDoc help authoring tool makes this task trivial and fast thanks to variable placeholders and its powerful build system

Read More →

Using HelpNDoc scripting capabilities to automatically reset all help context numbers

Using HelpNDoc scripting capabilities to automatically reset all help context numbers
Categories: Articles

HelpNDoc includes a very powerful script editor with access to multiple API methods which provides a way to automate almost all parts of your documentation creation and maintenance process. We've already seen how to use HelpNDoc's scripting capabilities to automate help and documentation creation, update the path of your external media elements when they are moved and export Help IDs and Help Context numbers for your developers. Let's now see how we can create a handy script to automatically reset help context numbers for all topics in the documentation project

Read More →

How to share and backup HelpNDoc templates

How to share and backup HelpNDoc templates
Categories: Articles

HelpNDoc is a powerful help authoring tool which can generate multiple documentation formats (including CHM, HTML, Word, PDF, ePub, Kindle, Qt Help) from a single source. It includes a very powerful template system, which provides a way to customize almost any part of the generated documentation's look and feel. Once a custom template has been created, it can be shared between multiple co-workers or backed up easily. Let's see how this can be done

Read More →

Learning how to use HelpNDoc: where should you start ?

Learning how to use HelpNDoc: where should you start ?
Categories: Articles

Even though the HelpNDoc help authoring tool has been engineered to be extremely easy to use, some help might be required to get started using it or understand advanced functionalities. Fortunately, there are many resources available in various formats to easily and quickly grasp concepts and features available in HelpNDoc. Let's review them

Read More →

Easily update the path of your external media elements when they are moved

Easily update the path of your external media elements when they are moved
Categories: Articles

You can choose how your library items (pictures, movies, documents...) are handled by HelpNDoc: they can be included within your project, or they can be dynamically included at generation time, when you choose to build your final documentation files. Using the second option, you provide a path for your media items so that HelpNDoc can find and include them when needed. This is very useful to be able to handle those items from outside of HelpNDoc, share them with a third party software... However, a problem might occur if those items need to be moved on your hard drive or networked path: to make sure HelpNDoc can still find your media elements, you'll need to manually update all of them one by one. As this can be a very long, tedious and error-prone task, this is great use case for HelpNDoc's powerful script editor. Let's see how we can leverage it to quickly update the whole library in a few seconds

Read More →

How to export Help IDs and Help Context numbers for your developers

How to export Help IDs and Help Context numbers for your developers
Categories: Articles

Once you've written your help file or documentation web-site, you'd usually like to be able to integrate it with your existing products: when users are having difficulties performing an action, they should be able to launch the help file and be presented with the correct associated topic explaining that specific action. For that purpose, Help Authoring Tools such as HelpNDoc provide two unique identifiers for each topic: an alpha-numeric Help ID and a numeric Help Context number. This makes it possible to reach a specific topic from your software application or web-site. But as a technical writer, you probably won't be in charge of "wiring" that application or web-site with the help file and you'd rather send a list of topic identifiers to the developers in charge. Thanks to HelpNDoc's very powerful script editor, you can easily do that!

Read More →

Produce multiple variations of a master documentation with ease

Produce multiple variations of a master documentation with ease
Categories: Articles

Thanks to HelpNDoc's powerful conditional generation feature and its amazing build system, it is easier and faster than ever to produce multiple variations of a master documentation. Just imagine writing a complete help file, manual, book or documentation and then choosing which parts to include in each final product: you'll begin to understand how powerful this feature can be to provide different variations of your master documentation to multiple clients, customers, partners... Read on to learn how to effectively use HelpNDoc's conditional generation system.

Read More →