Marker Help

Identifier: org.eclipse.ui.markerHelp

Description: This extension point is used to associate a help context id with a specific "kind" of marker (a marker of a certain type or having certain attribute values).

Since: Release 2.0

Configuration Markup:

   <!ELEMENT markerHelp (attribute)*>
   <!ATTLIST markerHelp
      markerType       CDATA #OPTIONAL
      helpContextId    CDATA #REQUIRED
   >

   <!ELEMENT attribute EMPTY>
   <!ATTLIST attribute
      name         CDATA #REQUIRED
      value        CDATA #REQUIRED
   > Examples:

The following is an example of a marker help extension (note the subelement and the way attributes are used):

<extension point="org.eclipse.ui.markerHelp">
   <markerHelp
      markerType="org.eclipse.ui.examples.readmetool.readmemarker"
      helpContextId="org.eclipse.ui.examples.readmetool.marker_example1_context">
      <attribute
         name="org.eclipse.ui.examples.readmetool.id"
         value= "1234">
      </attribute>
   </markerHelp>
</extension>

In the example above, a help context id is associated with markers of type org.eclipse.ui.examples.readmetool.readmemarker whose org.eclipse.ui.examples.readmetool.id attribute has a value of 1234.

API Information: It is up to the developer to ensure that only a single help context id is supplied for a given marker. If two or more help context ids are supplied for a given kind of marker, the workbench does not define which will be returned. However the workbench does define that the "most specific" context id will always be returned for a given marker. That is, a context id associated with three matching attribute values will be returned before a context id associated with only two.

Copyright IBM Corporation and others 2000, 2002.