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.
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.
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.
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.
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.
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 update. Then, use the menu along the left-hand side to define properties: Page settings Select paper size, orientation of the page, margins, and the location of headers and footers. Cover page Click Edit cover page to access the “Content Editor” window.
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.
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.
Creating the most complete, comprehensive and up-to-date documentation is the number one priority of technical writers. But readers expect a clean and modern design and companies oftentimes need to integrate documentation web-sites with their existing material, thus mimicking a predefined look-and-feel. Thankfully, the HelpNDoc help authoring tool lets you rapidly add a logo or custom CSS code for quick customization, or even create a completely new template to fully customize your deliverables.
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.
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.