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.
We’re always excited to share valuable resources from our social media posts with authors and technical writers. If you’ve missed any of our posts, this recap is a hub of our recent posts about tips and tricks for authors and technical writers to help them stay at the top of their games. To get notified on future posts, follow us on on social media: FaceBook, Twitter, LinkedIn, YouTube or Google+.
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.
Here’s a selection of some recent valuable resources we’ve shared on various social networks to make sure authors and technical writers stay ahead of the pack. To see more of our recent and future posts, you should consider following us to get notified: FaceBook, Twitter, LinkedIn, YouTube or Google+.
Regardless of the stage of your career as a technical writer, you can take advantage of a help authoring software that is easy enough for new writers and powerful enough for the pros.
We frequently post various resources to notify authors and technical writers about relevant news, articles, tips and tricks… to be as effective as possible at their daily jobs. Here is a selection of some recent resources we posted to various social networks. You should consider following us to get notified about future posts at: FaceBook, Twitter, LinkedIn, YouTube or Google+.
Picking the right format to publish your help files can be tricky.
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…
We were asked on FaceBook if it was possible to define a favicon to a HTML help build generated by HelpNDoc. This is a great question and the short answer is yes, absolutely, thanks to HelpNDoc’s powerful template system. Let’s see how this can be done by first creating our favicon, then our own custom template which will use that favicon.
Create a cross-browser compatible favicon Most web-browsers will be able to use PNG image files for the favicon.