如何在eclipse plugin preferences页面上配置自定义帮助的显示

Question

我正在用Neon.2制作一个eclipse插件。这个插件有一个首选项页面，它也有一些eclipse帮助。我希望能够单击“首选项”对话框上的问号按钮，并使我的帮助出现在“首选项”对话框中，就像它为内置的首选项所做的那样。

在搜索了几个关于preferences系统和帮助系统的教程之后，我找不到一个如何实现这一点的示例。此外，搜索许多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 contextid是您使用org.eclipse.help.contexts扩展点定义的帮助上下文id。