Eclipse Community Forums: Platform - User Assistance (UA) » rcp application with preference pages - tray help button does not open in-dialog context help

Home » Eclipse Projects » Platform - User Assistance (UA) » rcp application with preference pages - tray help button does not open in-dialog context help

Show: Today's Messages :: Show Polls :: Message Navigator

rcp application with preference pages - tray help button does not open in-dialog context help [message #470933]

Thu, 22 November 2007 18:13

Edoardo Comar

Messages: 102
Registered: July 2009

Senior Member

My RCP app contributes some preference pages.
I call
TrayDialog.setDialogHelpAvailable(true); on application
initialization, so the preference dialog comes up with the help button
in the lower left.

BUT pressing the help button does nothing in the preference dialog;
the context help (dynamic help view) works fine for my views in the
workbench.

However I noticed that the button does work if I run the rcp app against
*all* plugins in the eclipse sdk (ie, platform+jdt+pde... which
contribute a lot of pref pages) !!
Therefore I guess some other plugin is connecting the dots so that the
help button invokes the context help in-dialog.

What's the trick ?

Report message to a moderator

Re: rcp application with preference pages - tray help button does not open in-dialog context help [message #470937 is a reply to message #470933]

Mon, 26 November 2007 19:45

Chris Goldthorpe

Messages: 815
Registered: July 2009

Senior Member

Edoardo Comar wrote:
> My RCP app contributes some preference pages.
> I call
> TrayDialog.setDialogHelpAvailable(true); on
> application initialization, so the preference dialog comes up with the
> help button in the lower left.
>
> BUT pressing the help button does nothing in the preference dialog;
> the context help (dynamic help view) works fine for my views in the
> workbench.
>
> However I noticed that the button does work if I run the rcp app against
> *all* plugins in the eclipse sdk (ie, platform+jdt+pde... which
> contribute a lot of pref pages) !!
> Therefore I guess some other plugin is connecting the dots so that the
> help button invokes the context help in-dialog.
>
> What's the trick ?
>
>
Is your RCP app plugin based? If so make sure that org.eclipse.help.ui
and org.eclipse.help.webapp are included in the list of plugins in your
product configuration file, then open the product configuration file and
there is a link, I think it is on the plugins page to pull in all
required plugins, be sure to include optional dependencies. This will
cause any plugins required bu the help system to be pulled in. If that
doesn't work then it may be that the help system is not getting
initialized. Let me know if adding all dependencies fixes the problem.

Report message to a moderator

Re: rcp application with preference pages - tray help button does not open in-dialog context help [message #470938 is a reply to message #470937]

Mon, 26 November 2007 23:26

Edoardo Comar

Messages: 102
Registered: July 2009

Senior Member

Chris Goldthorpe wrote:
> Edoardo Comar wrote:
>> My RCP app contributes some preference pages.
>> I call
>> TrayDialog.setDialogHelpAvailable(true); on
>> application initialization, so the preference dialog comes up with the
>> help button in the lower left.
>>
>> BUT pressing the help button does nothing in the preference dialog;
>> the context help (dynamic help view) works fine for my views in the
>> workbench.
>>
>> However I noticed that the button does work if I run the rcp app
>> against *all* plugins in the eclipse sdk (ie, platform+jdt+pde...
>> which contribute a lot of pref pages) !!
>> Therefore I guess some other plugin is connecting the dots so that the
>> help button invokes the context help in-dialog.
>>
>> What's the trick ?
>>
>>
> Is your RCP app plugin based? If so make sure that org.eclipse.help.ui
> and org.eclipse.help.webapp are included in the list of plugins in your
> product configuration file, then open the product configuration file and
> there is a link, I think it is on the plugins page to pull in all
> required plugins, be sure to include optional dependencies. This will
> cause any plugins required bu the help system to be pulled in. If that
> doesn't work then it may be that the help system is not getting
> initialized. Let me know if adding all dependencies fixes the problem.

the problem turned out to be related to bug
https://bugs.eclipse.org/bugs/show_bug.cgi?id=210779

if the rcp app did not provide a context for the id
org.eclipse.ui.preference_dialog
(I am going by heart at this) the context help tray would not open.

Once I added it to my rcp (it would normally be contributed by the
platform help) the help would appear, even though when the dialog comes
up for the 1st time, only the generic help is shown

Report message to a moderator