Skip to content

Help Page, All Drivers Per-User Preferences

These options on this page control some of the default settings used when creating help projects for IVI-COM, IVI.NET, and IVI-C drivers.

Help template

The help template used for new driver help projects. The list offers every template installed with Nimbus as well as any custom templates you have added.

Nimbus ships two templates. Default uses the Markdown help pipeline and can produce all six output formats. Legacy uses the earlier HTML-based template system and can produce only Help 1.x and Microsoft Help Viewer output.

This setting supplies the initial value of the Help template setting on the Projects page of the IVI-C, IVI-COM, and IVI.NET driver wizards, where it can be changed for the driver being created. It is also the template used when adding a help project to an existing driver solution.

The template of an existing help project can be changed later from the Template page of the help project’s properties.

The formats produced from a driver help project. See Output Formats for a description of each.

Help 1.x (.chm)

This setting controls whether or not a self-contained .chm file will be generated. When enabled, the associated driver installer (if any) will deploy this file to the end-user machine.

Microsoft Help Viewer

This setting controls whether or not driver help content will be generated for the Microsoft Help Viewer , which is used by Visual Studio. When enabled, the associated driver installer (if any) will integrate the driver help content into the Microsoft Help Viewer on the end-user’s machine.

Register content with Help Viewer on build

This setting controls whether or not the driver help content will be automatically registered with the Microsoft Help Viewer on your machine whenever the driver help project is built. This setting has no effect on the end-user’s machine.

To preview the generated help content from within Visual Studio, right click on the help project node in the Solution Explorer and selecting View in Help Viewer.

Sign content with a code-signing certificate

Enables signing of the help content to be integrated with the Microsoft Help Viewer. Signed help content can be silently installed without the Microsoft Help Viewer without displaying a security warning to the end-user. Refer here for more information on signing Microsoft Help Viewer content.

Certificate thumbprint

The certificate thumbprint of the code-signing certificate to use for signing the help content.

Use the Browse button to bring up a dialog that can be used to conveniently select the thumbprint from certificates installed on the local machine.

Markdown (.md)

This setting controls whether or not GitHub-Flavored Markdown files will be generated, suitable for hosting on a Markdown-native documentation platform or for further post-processing.

Semantic HTML

This setting controls whether or not chrome-free HTML will be generated, with stable class names and no help-system metadata, for folding the content into your own website or toolchain.

MadCap Flare (.htm)

This setting controls whether or not content will be generated for import into a MadCap Flare project, where your documentation team applies its own chrome, styling, and table of contents.

Starlight Web Site

This setting controls whether or not a complete, ready-to-deploy Astro Starlight documentation site will be generated. See The Starlight Web Site for the full workflow.