This extension point is experimental and is likely to change in the future releases as the activity support evolves.
<!ELEMENT extension (support+)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT support (localScopeCheckbox , documentMessage , showAllMessage)>
<!ATTLIST support
productId CDATA #REQUIRED>
support
elements are found, the one whose productId
value matches the active product id will be chosen.<!ELEMENT showAllMessage (#PCDATA)>
a plain text message that will be shown in the dialog when activity filtering is turned off. The intent of the message is to warn that without the filter some documents may be referring to user interface elements that are not visible.
<!ELEMENT localScopeCheckbox (#PCDATA)>
a label of the checkbox in the local search scope preference page. When the checkbox is selected, search hits in documents that belong to disabled activites will be included in the search results.
<!ELEMENT documentMessage EMPTY>
<!ATTLIST documentMessage
class CDATA #IMPLIED
pluginId CDATA #REQUIRED>
an HTML snippet that will be injected at the top of the help topic that belongs to the disabled activity. The intent of the message is to notify the user that the topic may contain references to the UI elements that are not visible. Since the message text is inside an XML file, HTML tags must be escaped using standard XML entities for special characters.
The message may contain a hyperlink that takes the user to the activity editor that provides for changing activity enablement state. Attribute class
must be used in this case.
org.eclipse.help.ILiveHelpAction
. This class will be used when the document message contains a hyperlink or a button whose href
value contains the substitution string ACTIVITY_EDITOR. The class should be implemented in such a way as to programmatically invoke and show a UI component (e.g. a preference page) that the product offers for changing the activity enablement state.
<extension point=
"org.eclipse.help.base.activitySupport"
>
<support productId=
"com.example.xyzProduct"
>
<showAllMessage>
This actions will reveal all topics in the table of contents.</showAllMessage>
<documentMessage class=
"com.example.xyz.OpenRolePreference"
>
This topic belongs to the role that is currently disabled. <p> To enable the role, open <a href="ACTIVITY_EDITOR">Role Preference Page.</a></documentMessage>
</support>
</extension>
class
of the element documentMessage
must implement org.eclipse.help.ILiveHelpAction
interface.
Copyright (c) 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html