User`s guide

Specifying Help in an IMDF File

7-5

Specifying Help in an IMDF File

To define help text for adaptor properties in an IMDF file, use the Help element. You can

include only one Help node in an IMDF file and it must be a child of the root node.

As children of the Help node, you create AdaptorHelp nodes that contain the help text

for a particular property. You use the name attribute of the AdaptorHelp element to

specify which property the help is associated with.

You can optionally include device-specific content in the help text. This text appears only

when a particular device is selected. Use one or more DeviceHelp nodes to add device-

specific help to an AdaptorHelp node. You use the device attribute of the DeviceHelp

element to specify when the text should appear. You can also create see also references

for your property help using SeeAlso nodes.

The following example outlines how to use these elements to create property help. The

words in italics represent text that you must define.

<Help>

Help text

Device-specific help text

</DeviceHelp>

References to other properties

</SeeAlso

</AdaptorHelp>

</Help>

</ImageAcquisitionInfo>

The following table summarizes the tags you can use to define help. For more

information, see these topics.

• “User Scenario: Viewing Property Help” on page 7-6

• “Creating AdaptorHelp Nodes” on page 7-8