# Help Key Properties

###### Identifier:

org.eclipse.datatools.help.helpKeyProperties

###### Since:

DTP 1.5

###### Description:

This extension point supports the abstraction of help context IDs (and context-specific help search expressions for dynamic context-sensitive help) from the code in UI plug-ins.

Context-sensitive help plug-ins, which declare contributions via the org.eclipse.help.contexts extension point, can also use this extension point to declare helpKey .properties files contributions. UI plug-ins that call the org.eclipse.datatools.help.ContextProviderDelegate method can use those helpKey .properties files to dynamically set help context IDs on widgets that adapt to IContextProvider.

###### Configuration Markup:

<!ELEMENT extension (contextIds , searchExpressions?)*>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT contextIds EMPTY>

<!ATTLIST contextIds

plugin CDATA #REQUIRED

file CDATA #REQUIRED>

The <contextIds> element identifies a .properties file that defines help context IDs for a UI plug-in.

- plugin - the UI plug-in for which a help context ID .properties file is contributed by a context-sensitive help plug-in.
- file - a help context ID .properties file contributed by a context-sensitive help plug-in.

<!ELEMENT searchExpressions EMPTY>

<!ATTLIST searchExpressions

plugin CDATA #REQUIRED

file CDATA #REQUIRED>

The <searchExpressions> element identifies a .properties file that defines context-specific help search expressions for a UI plug-in.

- plugin - the UI plug-in for which a help search expression .properties file is contributed by a context-sensitive help plug-in.
- file - a help search expression .properties file contributed by a context-sensitive help plug-in.

  For each UI plug-in that a particular context-sensitive help plug-in contributes .properties files, the <contextIds> and <searchExpressions> elements must be declared in the org.eclipse.datatools.help.helpKeyProperties extension.

###### Examples:

The following is an example of using the Help Key Properties extension point in the plug-in manifest (plugin.xml file) of a context-sensitive help plug-in:

         <extension point="org.eclipse.datatools.help.helpKeyProperties">
             <contextIds plugin="org.eclipse.datatools.connectivity.ui"
                 file="org.eclipse.datatools.connectivity.ui_contextIds.properties"/>
             <searchExpressions plugin="org.eclipse.datatools.connectivity.ui"
                 file="org.eclipse.datatools.connectivity.ui_searchExpressions.properties"/>
         </extension>

###### API Information:

To take advantage of the help context ID abstraction, workbench parts must implement IContextProvider and call the org.eclipse.datatools.help.ContextProviderDelegate method.

###### Supplied Implementation:

The default implementation of org.eclipse.datatools.help supports this extension point.

Copyright (c) 2007 Sybase, Inc.
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