Markierungskommentare beisteuern

Im Folgenden wird erläutert, wie Hilfetexte zu den Markierungen des Tools für die Readme-Dateien hinzugefügt werden können.  Zum Hinzufügen von Hilfetexten für die Markierungen wird der Erweiterungspunkt org.eclipse.ui.markerHelp verwendet.  Dieser Erweiterungspunkt ermöglicht Plug-ins die Zuordnung einer Hilfekontext-ID zu einem bestimmten Markierungstyp.  Die Markierung kann nur über den Markierungstyp oder über den Wert eines oder mehrerer der zugehörigen Attribute qualifiziert werden.  Das Tool für die Readme-Dateien deklariert mehrere verschiedene Hilfekontexte:

<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"/> 
   </markerHelp> 
   <markerHelp 
      markerType="org.eclipse.ui.examples.readmetool.readmemarker" 
      helpContextId="org.eclipse.ui.examples.readmetool.marker_example2_context"> 
      <attribute name="org.eclipse.ui.examples.readmetool.level" value= "7"/> 
   </markerHelp> 
   <markerHelp 
      markerType="org.eclipse.ui.examples.readmetool.readmemarker" 
      helpContextId="org.eclipse.ui.examples.readmetool.marker_example3_context"> 
      <attribute name="org.eclipse.ui.examples.readmetool.level" value= "7"/> 
      <attribute name="org.eclipse.ui.examples.readmetool.department" value= "infra"/> 
   </markerHelp> 
   ...

Alle Hilfekontexte für Markierungen werden für den Readme-Markierungstyp definiert.  Die einzelnen Hilfekontexte werden hierbei jedoch einer jeweils unterschiedlichen Kombination von Attributwerten zugeordnet.  Der erste Markierungs-Hilfekontext wird für Markierungen verwendet, für deren Attribut id der Wert "1234" festgelegt wurde.  Die Hilfekontexte werden in der Datei HelpContexts.xml des Plug-ins definiert:

<context id="marker_example1_context" >
	<description>Readme marker example 1 <b>Help</b> id = 1234 </description>
</context>

Auf diese Weise kann durch Auswahl einer Readme-Markierung mit der Einstellung id="1234" und durch anschließende Auswahl der Hilfetexte über F1 die Hilfebeschreibung angezeigt werden.

Task-Liste mit Markierungs-Hilfetext

Copyright IBM Corporation und Andere 2000, 2003.