Click or drag to resize

Adding Help Information

Most of the items in an IVI.NET driver (methods, properties, parameters, etc.) have help information associated with them. The help content is used to generate HTML help files as well as other help-based artifacts, such as the XML IntelliSense file. The topics under Creating a Driver Help File provide detailed information on how driver help content is used.

Irrespective of where Nimbus uses the help information for an item, the content for each item is managed from a single location -- the Help Editor.

To add help information to an item

  1. From Solution Explorer, double-click the Driver Designer node under the Nimbus node.

  2. The IVI.NET Driver Designer tree view opens.

  3. Expand the root node, which will be named after the driver assembly (e.g.: Acme.Acme4321).

  4. Locate the desired item beneath the main Hierarchy node, the Enums node, or any of the other nodes corresponding to entities defined within the driver.

  5. Select the desired item in the tree view.

  6. On the right-side of the IVI.NET Driver Designer, click the Help tab along the lower section of the designer.

    Note Note

    The Help tab will only be enabled if there is a help project in the active solution that is associated with the driver being modified. If the Help tab is disabled, simply add a new help project to the solution and then return to the IVI.NET Driver Designer in order to enter the desired help information.

  7. The Help Editor appears. Select the desired tab (Summary, Remarks, etc.) and enter the desired help information. See the Help Editor topic for details.

See Also

Download a complete CHM version of this documentation here.