Access template settings for Qt Help builds

To open the template settings for a build:

  1. In the Home ribbon tab, locate the Project group.
  2. Click the top part of the Generate Help button (not the arrow) to open the Generate Documentation window.
  3. In the Build list on the left, select the build you want to customize.
  4. If the customization tabs are not displayed, click Customize on the right.
  5. Open the Template settings tab.

Available Qt Help template settings

Some of the templates settings available for Qt help builds are:

Field

Description

About icon

The picture library item to use as the icon in the "About" dialog

About menu text

The text to use as the "About" menu item

About text

The text to display in the "About" dialog

Address bar enabled

Control if address bar visibility can be changed in Qt Assistant

Address bar visible

Is the address bar shown by default

Application icon

The picture library item to use as the application icon

Base color

The base color of the theme

Clean output directory

Optionally clean the output directory before generation starts. Warning: this will delete any file and folder in the output directory.

Documentation manager enabled

If disabled, the documentation manager is not shown in Qt Assistant preference dialog

Export normal style

Define the normal style as the default style. Use web browser's default otherwise

Filter enabled

Control if the filter can be changed in Qt Assistant

Filter visible

Is the filter bar shown by default

Font size as percent

Use percent values for font sizes

Full text search fallback

Use full text search if a keyword can't be found in the index

Keep temporary files

Keep the temporary files needed by the compiler to build the final documentation

Namespace

The unique documentation namespace

Numbering as text

Use text instead of OL/LI elements when generating lists

Show BreadCrumbs

Show or hide the breadcrumbs at the top of each topic

Show navigation arrow

Show or hide the navigation arrows at the top of each topic

Virtual folder

Virtual directory name in the specified namespace

See the How to define build settings in HelpNDoc step-by-step guide.