Skip to content
Nimbus Driver Studio

Adding Help Information

Most of the items in an IVI-C driver (functions, attributes, 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 function panel file (.fp) and attribute information file (.sub). 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

Section titled “To add help information to an item”

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

  2. The IVI-C Driver Designer tree view opens.

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

  4. Expand the root node and 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-C Driver Designer, click the Help tab along the lower section of the designer.

  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

Section titled “See also”