Поддержка групп действий

org.eclipse.help.base.activitySupport

3.1

Эта точка расширения используется модулями продукта для настройки поведения справочной системы при использовании групп действий. Она предоставляет следующие возможности по настройке:

Эта точка расширения находится в экспериментальном состоянии и будет изменена в следующих версиях по мере развития поддержки групп действий.

<!ELEMENT extension (support+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT support (localScopeCheckbox , documentMessage , showAllMessage)>

<!ATTLIST support

productId CDATA #REQUIRED>


<!ELEMENT showAllMessage (#PCDATA)>

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



<!ELEMENT localScopeCheckbox (#PCDATA)>

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



<!ELEMENT documentMessage EMPTY>

<!ATTLIST documentMessage

class    CDATA #IMPLIED

pluginId CDATA #REQUIRED>

Код HTML, вставляемый в начало справочного документа, относящегося с отключенной группе действий. Он должен содержать текст, сообщающий пользователю, что в данном документе могут встречаться ссылки на отсутствующие элементы интерфейса. Т.к. код находится в файле XML, все специальные символы HTML должны быть заменены соответствующими сущностями XML.

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



В примере показано использование точки расширения для поддержки групп действий:

 

<extension point=

"org.eclipse.help.base.activitySupport"

>

<support productId=

"com.example.xyzProduct"

>

<showAllMessage>

Это действие развернет все разделы в оглавлении.

</showAllMessage>

<documentMessage class=

"com.example.xyz.OpenRolePreference"

>

Эта тема относится к компоненту, отключенному на данный момент. &lt;p&gt; Его можно включить на странице &lt;a href="ACTIVITY_EDITOR"&gt;Компоненты&lt;/a&gt; окна параметров.

</documentMessage>

</support>

</extension>

Атрибут class элемента documentMessage должен реализовывать интерфейс org.eclipse.help.ILiveHelpAction.

В состав Eclipse SDK входит стандартная поддержка групп действий, оперирующая термином "функции" и позволяющая открывать страницу параметров Группы функций из тем, относящихся к выключенным функциям. При переопределении стандартных сообщений, убедитесь в согласованности терминологии, использующейся в них и в интерфейсе платформы.