schema.markerHelp.exsd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.ide Show documentation
Eclipse IDE UI
There is a newer version: 3.22.400




      
         
      
      
         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).
      
   

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

   
      
         
            
         
         
            
               
                  the unique type of the marker for which the help context applies.
               
               
                  
               
            
         
         
            
               
                  the unique id of the help context.
This is only used, if helpContextProvider is not set.
               
            
         
         
            
               
                  the name of the class implementing <code>IMarkerHelpContextProvider</code>.
If this is specified helpContextId is ignored.
               
               
                  
               
            
         
         
            
               
                  whether the help context also applies to children of the given markerType.
<p> If omitted false is assumed. </p>
<p><em>Since: 3.14</em></p>
               
            
         
      
   

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

   
      
         
      
      
         3.0 (originally added in release 2.0 as org.eclipse.ui.markerHelp)
      
   

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

<p>
<pre>
 <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>
</pre>
</p>

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.
      
   

   
      
         
      
      
         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.<br>

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 <a 
href="https://www.eclipse.org/legal/epl-2.0">https://www.eclipse.org/legal/epl-v20.html</a>/

SPDX-License-Identifier: EPL-2.0