Template Page, Driver Help Project Properties

This page allows you to select the help template that will control the look and feel of the generated driver help content.

Nimbus provides a Help Previewer for selecting a help template to use for the current project and for previewing the results of applying that template. The Help Previewer is accessed by right clicking on the driver help project node in the Solution Explorer, selecting Properties and then going to the General tab.

Each tab shows a sample page for each of the different kinds of pages. Use the Available templates combo box to view the different templates available.

Help template selection

Available templates

The list of available driver help templates is listed here.

This list includes the template defined within the driver help project, help templates installed by Nimbus, and any custom driver help templates you may have created. The choices shown will correspond to the templates present in the HelpTemplates subfolder of the Nimbus installation folder.

A preview of the selected template is displayed below. Changing the selected help template has no effect on the help project until you press the Switch to this template button.

Note

If an error is detected in the selected help template, the help previewer will display an error page until the error is corrected.

Switch to this template

Pressing this button causes the driver help project to be updated to use the selected template.

Caution

When you switch help templates for a project, the template files from the appropriate NimbusInstallDir\HelpTemplates folder are copied over the files in the driver’s help project Template folder. This means that all customizations that might have been performed on the project’s help template are lost. Before switching help templates, be sure that the current project template has no customizations that need to be saved elsewhere.

Note

IVI-COM help templates that include an IVI-C wrapper use template files from the IVI-C template for portions of the driver help file. The following folders within the IVI-C template are used by the IVI-COM help template:

• IviCAttribute
• IviCBranch
• IviCCallbackFunction
• IviCErrorsWarnings
• IviCFunction
• IviCLibrary

See also

• Working with Help Templates
• Help Template Previewer Errors