HelpNDoc’s build system is a robust and versatile component that empowers technical writers to generate documentation projects in a wide array of output formats. With support for formats such as CHM, HTML, Word, PDF, ePub, Kindle, Qt Help, and Markdown, HelpNDoc provides comprehensive options to suit diverse distribution channels and target platforms. Notably, the build system allows users to create multiple builds within each output format, enabling an unlimited number of customized variations.
There are two ways to generate your documentation. You can use ‘Quick generate’ to publish one output at a time. Or, you can use your build list to publish documentation in one or many formats simultaneously. Option 1: Quick generate Click the lower half of Generate help in the Home ribbon tab to display a menu of the default publishing options offered by HelpNDoc. Click the one that you’d like to use to generate your documentation in that format.
There are two simple steps for creating a new publishing output. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. Each output and its format is listed along the left-hand side in your build list. The outputs with check marks will be published the next time you generate the documentation from your build list. Step 2 In this next step you’ll select the format for your new output.
There are three easy steps for renaming outputs. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. The names of your outputs are listed along the left-hand side in your build list. These names are displayed when you generate your documentation. Step 2 Next, you’ll select the output that you’d like to rename. There are three ways to do this: Option 1 Click the name of the output that you’d like to update.
There are two simple steps for deleting an obsolete output. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. All of your outputs are listed along the left-hand side in your build list. Step 2 Next, you’ll select the output that you’d like to delete. There are two ways to do this: Option 1 Click the build that you’d like to remove.
There are two steps for reordering your outputs. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. Your outputs are listed along the left-hand side in your build list. Step 2 The order in which your outputs are listed in the build list is the order in which they will be created when you generate your documentation using your build list.
There are two steps to managing the status of your builds. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. Your builds are listed along the left-hand side in your build list. Step 2 The check marks next to your builds indicates which builds would be published the next time you generate documentation using your build list. If a build does not have a check mark, it would not be generated.
To access the settings HelpNDoc uses to publish documentation, click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. Your builds are listed along the left-hand side in your build list. To view the settings for a build, click its name. This highlights that build and displays its current output file and template. The steps for maintaining the output file and template as well as the settings for the output are outlined below.
Step 1 Click the top half of Generate help in the Home ribbon tab. Step 2 This displays your build list along the left-hand side of the ‘Generate Documentation’ window. Some standard build kinds allow you the option of translating some of the hard-coded titles: HTML Word PDF ePub Kindle Click the build that you’d like to customize in the build list. If the template settings tab is not displayed, click Customize.
Step 1: Define HTML setting Click the top half of Generate help in the Home ribbon tab. This displays the ‘Generate Documentation’ window. Select the HTML build to modify in the build list on the left-hand side. If the Template settings tab is not displayed, click Customize to view it. Click the ‘Expand table of contents tree’ box to remove the check mark. This will generate your documentation in HTML format with a collapsed table of contents.
Step 1 Place the cover picture you’d like to use in your library. It’s recommended that you use a .jpg or .png that is either 600x800 or 300x400 pixels. See: How to add an item to the library Step 2 Click the top half of the Generate help button in the Home ribbon tab. This displays the ‘Generate documentation’ window. Step 3 Select the ePub or Mobi/Kindle build you’d like to modify in the build list.