添加标记帮助

现在,我们准备查看如何对自述文件工具的标记添加帮助。使用 org.eclipse.ui.ide.markerHelp 扩展点添加了标记帮助。此扩展点允许插件使帮助上下文标识与特定类型的标记相关联。可以只使用标记类型来限定标记,或可以用标记的一个或多个属性值进一步限定它。自述文件工具声明几个不同的帮助上下文:

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

这就为自述文件标记类型定义了每个标记帮助上下文。但是,每个帮助上下文都与属性值的不同组合相关联。第一个标记帮助上下文将用于其 id 属性设置为 "1234" 的标记。帮助上下文是在插件的 HelpContexts.xml 文件中定义的:

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

确定的是当选择 id="1234" 的自述文件标记并使用 F1 选择帮助时,将看到帮助描述。

具有标记帮助的任务列表