Community
Participate
Working Groups
IWorkbenchHelpSystem - method search - please explain what a search expression looks like /** * Starts the search using the help search system. * <p> * Ignored if no help UI is available. * </p> * @param expression the search expression */ void search(String expression); - method displayContext(IContext context, int x, int y); - is there any guarantee that x,y are honored? - method displayHelpResource talked about String/href/URL is a bit confusing WorkbenchHelp - all methods should just refer to javadoc in interface?
I have no idea what the search method is. Dejan?
Search method activates help UI with the search expression. In 3.1, it opens the new Help view with the 'Search' page shown and immediately starts the search. The action is equivalent to showing the Help view manually, switching to Search page, typing the expression in the expression entry and hitting 'Go'. The actual expression syntax is really dependent on the Help UI implementation. I don't think we can assume any particular expression syntax beyond claiming that it is a string.
I still think we should then explain how the expression depends on the help support and to look there for more information.
Punting to Dejan for final comment.
Added the following to the Javadoc: /** * Starts the search using the help search system. * <p> * Ignored if no help UI is available. * </p> * * @param expression * the search expression. The actual syntax rules of the * expression are dependent on the active * help system. Refer to the help system * documentation for more details. */ void search(String expression);
Closing.
