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.
A standard help authoring tool such as HelpNDoc is a software where you generally write and organize content in order to produce documentation files for the end-user. As revisions are needed, the content needs to stay organized, and it usually involves a lot of laborious and error-prone tasks such as copying / pasting content all over the project, deleting content, moving and merging topics… Fortunately, HelpNDoc includes a powerful scripting processor which can help automate documentation creation, maintenance, reorganization… Let’s see how we can leverage HelpNDoc’s scripting capabilities to merge multiple children topics into a parent topic.
HelpNDoc is a leading user-friendly help authoring software that was designed to make technical writing easier. Over the years, the software has undergone several different development phases to make it more user-friendly, and with improved features, not only for technical writers but for authors as well.
Presently, HelpNDoc is well known for its several different user-friendly features. Notably for its ability to generate several different file formats from just one source file including cross platform Qt Help files, Web-based HTML 5 documentations, standard Windows CHM help files, printable PDF and Word documents, ePub and Kindle eBooks as well as iPhone specific websites.
Add a custom logo to the project’s library The library includes every reusable media elements (pictures, movies, documents…) available in the project.
In order to add the desired logo picture to the project’s library, a few simple steps are required:
Writing an online help file, a user manual, an eBook or any other format handled by HelpNDoc is usually lengthy ongoing and non-linear process. Oftentimes, as the content evolves, the overall topic hierarchy can become sub-optimal and a re-organization is required in order to make the documentation easier to read and navigate. Even though HelpNDoc provides tools to easily re-organize the table of contents, in some cases the process can be lengthy and error-prone, such as when an alphabetical sorting of topics is required.
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.
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.
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.
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.
Step-by-step guides The simplest and quickest way to learn a specific task by following clear step-by-step visual and textual instructions.
Warning! Some information and techniques detailed on this page may be out of date. For more up-to-date information on this topic, we recommend that you check the following page: Automatic generation of YouTube and Vimeo embed codes and improved High-DPI screen support in HelpNDoc 6.7. We previously covered how to embed a YouTube video in your CHM or HTML help files. While YouTube is a great platform to share videos, some might prefer one of its main competitor, Vimeo.
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…