Marker Help

Identifier:

org.eclipse.ui.ide.markerHelp

Since:

3.0 (originally added in release 2.0 as 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).

Configuration Markup:

<!ELEMENT extension (markerHelp*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT markerHelp (attribute*)>

<!ATTLIST markerHelp

markerType IDREF #IMPLIED

helpContextId CDATA #IMPLIED

helpContextProvider CDATA #IMPLIED

matchChildren (true | false) >

markerType - the unique type of the marker for which the help context applies.
helpContextId - the unique id of the help context. This is only used, if helpContextProvider is not set.
helpContextProvider - the name of the class implementing IMarkerHelpContextProvider. If this is specified helpContextId is ignored.
matchChildren - whether the help context also applies to children of the given markerType.
If omitted false is assumed.

Since: 3.14

<!ELEMENT attribute EMPTY>

<!ATTLIST attribute

name CDATA #REQUIRED

value CDATA #REQUIRED>

name - the name of the attribute whose value is being specified.
value - the specified value of the attribute.

Examples:

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


 <extension point="org.eclipse.ui.ide.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"/>
  </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 (c) 2002, 2005 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0