What is the HelpId and how to use it?


I do see in several tool windows a value that binding the DataKey

public static final DataKey<String> HELP_ID = DataKey.create("helpId");

defined in com.intellij.openapi.actionSystem.PlatformDataKeys. What is that for, what should I do with the unique string that I can assign to that DataKey?

Official comment

This exposes the associated Help ID topic to show when "Show Help" action is invoked while focus is in the corresponding tool window.

The topic ID must map to the product's help topics. Plugins can "redirect" help topics to their web help by providing com.intellij.openapi.help.WebHelpProvider

Please sign in to leave a comment.