如何在 Eclipse 插件首选项页面上配置自定义帮助的显示

Question

我正在用 neon.2 制作一个 eclipse 插件。这个插件有一个首选项页面，它还有一些 eclipse 帮助。我希望能够单击首选项对话框上的问号按钮，然后让我的帮助出现在首选项对话框中，就像在内置首选项中一样。

在搜索了几个关于首选项系统和帮助系统的教程后，我找不到如何执行此操作的示例。此外，搜索许多 eclipse 文档、wiki 页面和源项目（例如 Java 开发工具和其他著名插件的源代码）也没有找到任何有用的东西。

我只是在寻找指向插件首选项面板在首选项“？”时显示其自身帮助的示例的指针。按钮被点击。

Answer 1

在首选项页面中 createContents 方法告诉帮助系统该页面的帮助 ID 使用：

@Override
protected Control createContents(final Composite parent)
{
  PlatformUI.getWorkbench().getHelpSystem().setHelp(parent, "help context id");

  ... other code
}

其中 help context id 是您使用 org.eclipse.help.contexts 扩展点定义的帮助上下文 ID。

如何在 Eclipse 插件首选项页面上配置自定义帮助的显示

How does one configure display of custom help on eclipse plugin preferences page

eclipse

eclipse-plugin

eclipse-rcp