| Context-sensitive help from multiple plug-ins [message #473683] |
Mon, 05 May 2008 21:54  |
Eclipse User |
|
|
|
Hello,
I am building an RCP application where I want to provide my own help
contents for standard screens such as the Import Wizard, Export Wizard
and New Project wizard. After reading the following Eclipse help page,
it seems easy... but its not working.
http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse. platform.doc.isv/guide/ua_help_context_xml.htm
Here's what I've done:
I've added the required help plugins, org.eclipse.help,
org.eclipse.help.ui, org.eclipse.help.webapp and all their required
dependencies. This works fine, the help window will open and serve help
pages in my app.
I added this line to the initialize method of my WorkbenchAdvisor.
This gives me the ? question mark button on my Eclipse wizard pages.
TrayDialog.setDialogHelpAvailable(true);
I created a help plugin and added the following extension point:
<extension point="org.eclipse.help.contexts">
<contexts file="contexts_Workbench.xml" plugin="org.eclipse.ui.ide"/>
</extension>
Inside contexts_Workbench.xml I have the following (plus more but left out)
<context id="missing">
<description>The context help for this user interface CUSTOM element
could not be found.</description>
</context>
<context id="new_project_wizard_context">
<description>Wizard to assist in creating a new project.</description>
<topic label="Im working" href="html/concepts/maintopic.html"/>
</context>
When I click the ? question mark buttton on the New project wizard, the
tray opens up on the right and the help info is visible. Unfortunately,
I do not see the contents defined by id="new_project_wizard_context".
Instead I see the message defined as id="missing" with my 'custom'
message. At least I know that my help plugin is visible to my RCP app,
but it appears my context ID is not correct. I've tried a number of
variations on this context ID however nothing has worked. Please let me
know the right way to get this working.
Thanks in advance!
Brian
|
|
|
|
| Re: Context-sensitive help from multiple plug-ins [message #473688 is a reply to message #473687] |
Wed, 07 May 2008 00:01  |
| Eclipse User |
|
|
|
Chris,
I did not have that line of code in my project but after adding that,
it did not solve my original problem. My project contains a new project
wizard extension and the help system is working fine in this area. This
is where I added
PlatformUI.getWorkbench().getHelpSystem().setHelp(composite,
"org.eclipse.ui.ide.new_project_wizard_context");
and after adding this code, my wizard pages launch and display my help
pages. But the issue I'd like to resolve is the ability to add custom
help to the initial Eclipse new project wizard. For example, in Eclipse
if you click File > New > Project... This is the page where I need to
add my own help. I could include the Eclipse Workbench guide
documentation, but its not compatible with the context of my RCP
application.
So what I'm trying to do is supply my own context based help to
pre-existing Eclipse dialog boxes throughout the workspace.
Thanks for your help
Brian
Chris Goldthorpe wrote:
> You didn't say how you associated the context help with the control in
> your Java Source. You should have a line something line this
>
> PlatformUI.getWorkbench().getHelpSystem().setHelp(composite,
> "org.eclipse.ui.ide.new_project_wizard_context");
>
> where composite is the outer composite for the wizard page you want to
> add help for. If you are using Eclipse 3.4 you can turn on context help
> debugging in the Tracing tab of the Run Configurations dialog buy
> turning on tracing for org.eclipse.help/debug/conext.
|
|
|
| Re: Context-sensitive help from multiple plug-ins [message #613223 is a reply to message #473683] |
Tue, 06 May 2008 12:27 |
| Eclipse User |
|
|
|
You didn't say how you associated the context help with the control in
your Java Source. You should have a line something line this
PlatformUI.getWorkbench().getHelpSystem().setHelp(composite,
"org.eclipse.ui.ide.new_project_wizard_context");
where composite is the outer composite for the wizard page you want to
add help for. If you are using Eclipse 3.4 you can turn on context help
debugging in the Tracing tab of the Run Configurations dialog buy
turning on tracing for org.eclipse.help/debug/conext.
|
|
|
| Re: Context-sensitive help from multiple plug-ins [message #613224 is a reply to message #473687] |
Wed, 07 May 2008 00:01 |
| Eclipse User |
|
|
|
Chris,
I did not have that line of code in my project but after adding that,
it did not solve my original problem. My project contains a new project
wizard extension and the help system is working fine in this area. This
is where I added
PlatformUI.getWorkbench().getHelpSystem().setHelp(composite,
"org.eclipse.ui.ide.new_project_wizard_context");
and after adding this code, my wizard pages launch and display my help
pages. But the issue I'd like to resolve is the ability to add custom
help to the initial Eclipse new project wizard. For example, in Eclipse
if you click File > New > Project... This is the page where I need to
add my own help. I could include the Eclipse Workbench guide
documentation, but its not compatible with the context of my RCP
application.
So what I'm trying to do is supply my own context based help to
pre-existing Eclipse dialog boxes throughout the workspace.
Thanks for your help
Brian
Chris Goldthorpe wrote:
> You didn't say how you associated the context help with the control in
> your Java Source. You should have a line something line this
>
> PlatformUI.getWorkbench().getHelpSystem().setHelp(composite,
> "org.eclipse.ui.ide.new_project_wizard_context");
>
> where composite is the outer composite for the wizard page you want to
> add help for. If you are using Eclipse 3.4 you can turn on context help
> debugging in the Tracing tab of the Run Configurations dialog buy
> turning on tracing for org.eclipse.help/debug/conext.
|
|
|
Powered by
FUDForum. Page generated in 0.03621 seconds
Home