HelpNDoc includes a very powerful template processor where you can customize any part of the generated documentation. It provides technical writers with a wide range of customization options, including the ability to modify the look and feel of headings, text, tables, images, and other elements of their documentation. Designers can also add custom logos, change the background color, and adjust the font size and style to create a unique and personalized documentation style.

Create a new HTML template to customize your online documentation projects

Create a new HTML template to customize your online documentation projects
Categories: articles

The recent release of HelpNDoc 6.4 includes an enhanced single page HTML template with the ability to optionally add a table of contents to the produced single page HTML documentation. We obviously used HelpNDoc’s powerful template editor to modify the single page template and we thought it might be a good idea to document this process for learning purposes. Follow the steps described in this article to learn how you can create and alter HTML-based documentation templates using HelpNDoc’s build-in tools.

Read More →

How technical writers can include PHP code in their online documentation

How technical writers can include PHP code in their online documentation
Categories: articles

PHP is a powerful server-side scripting language that has been an essential tool for web development for decades. With its ability to dynamically generate content, enhance user experience, handle security restrictions, increase interactivity or collect user data, it is a great addition to online user documentation. Thanks to the HelpNDoc help authoring tool's powerful and versatile template system, these benefits are now easily achievable: let's explore how incorporating PHP into online user documentation can help to improve the user experience and provide better engagement and feedback. Whether you're a web developer, a technical writer, or someone looking to enhance their online documentation, this post will provide valuable insights and tips on how to use HelpNDoc to make the most of PHP in your online documentation.

Read More →

How to create a new report template

How to create a new report template

To begin, click Template Editor in the Tools ribbon tab. This displays the “Edit report template” window. Click the green plus button to select the type of template that you’d like to create. This displays the “New template name” window. Enter a unique name for the new template and click OK. This returns you to the “Edit report template” window where the name of the new template is selected in the Template menu.

Read More →

How to define robots.txt and Robots meta tags in your HTML documentation ?

How to define robots.txt and Robots meta tags in your HTML documentation ?
Categories: articles

Technical writers can use a special robots.txt file or define robots meta tags in their HTML documentation to specify how popular search engines, such as Google or Bing, should index and serve individual pages in search results. In this article, we will see how we can update the default HTML template provided by the HelpNDoc help authoring tool to generate a robots.txt file, specify a project-wide default value for the robots meta tag, and override its content on specific documentation pages.

Read More →

How to delete a template

How to delete a template

To begin, click the Template Editor button in the Tools ribbon tab. This displays the “Edit report template” window. Click the downward arrow for the Template menu to select the template that you’d like to delete. Then, click the Delete button to the right. This displays a warning message. Click Yes. This displays a confirmation message that the template was deleted. Click OK to return to the “Edit report template” window.

Read More →

How to duplicate an existing report template

How to duplicate an existing report template

To begin, click the Template Editor button in the Tools ribbon tab. This displays the “Edit report template” window. Click the downward arrow to select the template that you’d like to copy. Then, click the duplicate template button to duplicate that template. This displays the “Duplicate template” window. Select the type of template that you’d like to create (i.e. PDF or Word). Enter the name of the new template and click Duplicate.

Read More →

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

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

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

Read More →

How to rename a template

How to rename a template

To begin, click the Template Editor button in the Tools ribbon tab. This displays the “Edit report template” window. Click the downward arrow for the Template menu to select the template that you’d like to rename. Then, click the rename button to the right. This displays the “New template name” window. Enter the new name for the template and click OK. This returns you to the “Edit report template” window.

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 →