Источник справочной информации
Идентификатор:
org.eclipse.help.contentProducer
Начиная с:
Версия 3.0
Описание:
Предоставляет
динамическую справочную информацию, создаваемую во время выполнения. Источники информации регистрируются для модуля и работают
только в пределах области действия модуля. Для повторного использования источника информации в другом модуле следует использовать
элемент binding
. Эта стратегия позволяет предотвратить захват модулем информации, созданной для
всех модулей. Путем связывания с источником информации модуль дает разрешение на управление информацией, созданной
для всех документов в предоставляющем модуле.
Описание конфигурации:
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - класс реализации для источника справочной информации. Этот класс должен реализовывать интерфейс
org.eclipse.help.IHelpContentProducer. Этот атрибут можно
опустить, предоставив вместо него вложенный элемент producer.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - класс реализации для источника справочной информации. Этот класс должен реализовывать интерфейс
org.eclipse.help.IHelpContentProducer.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - имя параметра, передаваемого классу реализации
- value - значение параметра, передаваемого классу реализации
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId - уникальное имя источника информации, определенного с помощью элемента contentProducer.
Связывание позволяет модулю повторно использовать источник информации, зарегистрированный в
другом модуле, а не определять собственный источник.
Примеры:
Ниже приведен пример использования точки расширения источника информации:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"Динамическая справочная информация"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
Информация API:
Предоставляемый
класс источника справочной информации должен реализовывать интерфейс
org.eclipse.help.IHelpContentProducer. Источник отвечает за
предоставление информации для ресурсов динамической справки из модуля. Справка вызывает метод источника информации для каждого ресурса справки,
получаемого из модуля.
Поставляемая реализация:
Нет. Если модуль документации не предоставляет источник справочной информации
или его вызов оказывается безрезультатным, то справочная система ищет
статический документ в doc.zip и файловой системе в установочном
расположении модуля и показывает содержимое этого документа.
Copyright (c) 2000, 2006 IBM Corporation and others.
Все права защищены.
Эта программа и сопутствующие материалы распространяются на условиях Eclipse Public License v1.0, поставляемой вместе с продуктом и доступной на Web-сайте
http://www.eclipse.org/legal/epl-v10.html