插入帮助

平台帮助系统允许您使用 org.eclipse.help.contributions 扩展点来添加插件的联机帮助。可以作为代码插件的一部分来添加联机帮助,也可以在它自己的文档插件中单独提供联机帮助。

在代码和文档小组属于不同的组,或者您想要减少文档与代码之间的耦合的情况下, 将文档分成单独的插件是很有利的。

平台的帮助设施为您提供了原始的构建块来构造和添加帮助。它不会限制文档的结构或粒度。但平台确实提供并控制了集成的帮助查看器,从而确保文档的无缝集成。

org.eclipse.help.contributions 扩展点提供了四个元素,通过这些元素可以添加帮助,这些元素是:

主题、信息集和操作添加项都指定了相关联的 .xml 文件,该文件中包含该添加项的详细信息。说明这些元素的最佳方法就是创建使用它们的文档插件。