Определение справки в файле IMDF

Чтобы задать текст справки для свойств адаптера в файле IMDF, используйте элемент Help. Можно включать только один узел Help в файл IMDF, и это должен быть дочерний элемент корневого узла.

Как дочерние элементы узла Help, вы создаете узлы AdaptorHelp, которые содержат текст справки для конкретного свойства. Вы используете атрибут name элемента AdaptorHelp, чтобы задать, с каким свойством справка сопоставлена.

Можно опционально включать специфичное для устройства содержимое в текст справки. Этот текст появляется только, когда конкретное устройство выбрано. Используйте один или несколько узлов DeviceHelp, чтобы добавить специфичную для устройства справку к узлу AdaptorHelp. Вы используете атрибут device элемента DeviceHelp, чтобы задать, когда текст должен появиться. Можно также создать, см. также ссылки для справки свойства с помощью узлов SeeAlso.

Следующий пример обрисовывает в общих чертах, как использовать эти элементы, чтобы создать справку свойства. Слова курсивом представляют текст, который необходимо задать.

<ImageAcquisitionInfo>
	<Help>
		<AdaptorHelp property=propertyname>
			Help text
			<DeviceHelp device=devicename>
				Device-specific help text
			</DeviceHelp>
			<SeeAlso>
				References to other properties
			</SeeAlso
		</AdaptorHelp>
	.
	.
	.
	</Help>
</ImageAcquisitionInfo>

Следующая таблица обобщает теги, которые можно использовать, чтобы задать справку. Для получения дополнительной информации смотрите эти темы.

Элемент	Описание	Атрибуты
`<Help>`	Задает раздел справки в файле IMDF. Должен быть дочерний элемент узла `ImageAcquisitionInfo`.	'none'
`<AdaptorHelp>`	Задает онлайновую справку для свойства. Узел Справки может содержать один или несколько узлов AdaptorHelp.	Имя `property=`, где имя является вектором символов, задающим имя свойства
`<DeviceHelp>`	Задает специфичный для устройства текст в справке свойства. Этот элемент является дополнительным. Узел `AdaptorHelp` может содержать несколько узлов `DeviceHelp`.	Имя `device=`, где имя является вектором символов, который идентифицирует конкретное устройство
`<SeeAlso>`	Задает видение также строки в справке свойства. Этот элемент является дополнительным. Узел `AdaptorHelp` может содержать несколько узлов `SeeAlso`.	'none'

Пользовательский сценарий: просмотр справки свойства

Цель использовать элемент Help в файле IMDF состоит в том, чтобы создать текст справки для специфичных для устройства свойств. Пользователь вашего адаптера может отобразить текст справки в командной строке с помощью команды imaqhelp.

Следующий пример показывает, как пользователь отображает текст справки для специфичного для устройства свойства с помощью команды imaqhelp. Чтобы видеть, как создать эту справку в файле IMDF, смотрите Создание Узлы AdaptorHelp.

Элементы в этом списке соответствуют пронумерованным элементам выше.

Специфичные для устройства свойства являются свойствами объекта источника видеосигнала. Пример создает объект ввода видео и затем использует функцию getselectedsource, чтобы получить указатель на объект источника видеосигнала.
Пример использует функцию get, чтобы отобразить список специфичных для устройства свойств.
Используйте функцию imaqhelp, чтобы отобразить справку для одного из свойств объекта источника видеосигнала.
Первая строка справки перечисляет имя свойства с его ограничениями, такими как область значений и разрешение.
Текст справки появляется точно, когда вы вводите его в файл IMDF. Вы включаете текст после тега AdaptorHelp.
Смотрите также строка создается узлом SeeAlso.

Создание узлов AdaptorHelp

В этом разделе описывается создать текст справки для свойства с помощью набора тегов справки, заданных DTD IMDF. Следующий пример показывает запись IMDF для свойства Brightness, отображенного в Пользовательском Сценарии: Просмотр Справки Свойства. Пример устанавливает атрибут property тега AdaptorHelp к имени свойства.

Примечание

Текст справки должен запуститься с коротких сводных данных. Убедитесь, что каждая строка текста больше не, чем 80 символов.

<AdaptorHelp property="Brightness">
Specify the brightness, also called the black level.
    
Brightness describes the difference in intensity of light reflected from 
or transmitted through an image independent of its hue and saturation. 
For some devices, the value is expressed in IRE units * 100. For other 
devices, the units are arbitrary. Refer to the device's documentation for 
information.

Depending on the acquisition device, this property may have an associated 
mode property allowing this value to be controlled automatically by the 
device, or for it to be manually configured.

<SeeAlso>BrightnessMode.</SeeAlso>

</AdaptorHelp>

Включая специфичный для устройства текст справки

Чтобы включать текст справки, который только появляется для определенных устройств, используйте элементы DeviceHelp.

В этом примере текст справки содержит три специфичных для устройства раздела. Отметьте, как пример устанавливает атрибут device свойства DeviceHelp к имени устройства.

<AdaptorHelp property="StrobeEnable">
Enables the strobe output and its timer.  

Upon enabling the strobe output, it will start detection
of triggers and generate output as appropriate.  Consult your
hardware manual for a detailed description of the strobe output.

<DeviceHelp device="PC2Vision">See also StrobeMode,
StrobeDuration, StrobeDelay, StrobePolarity,
StrobeAlignOnHs.
</DeviceHelp>

<DeviceHelp device="PCVisionPlus">See also StrobeMode,
StrobeDelay, StrobePolarity.
</DeviceHelp>

<DeviceHelp device="PCRGB">For the PC-RGB, StrobeEnable only 
enables the timing circuitry.  The strobe output must still be 
enabled with the StrobeOutputEnable property.

See also StrobeMode, StrobePolarity, StrobeDelay, 
StrobeOutputEnable.
</DeviceHelp>

</AdaptorHelp>

Документация