Bug 244601 - [Help][Context] A description element in a help context declaration for a dialog hides topic href
Summary: [Help][Context] A description element in a help context declaration for a dia...
Status: CLOSED WONTFIX
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.5   Edit
Hardware: PC Linux
: P3 minor (vote)
Target Milestone: ---   Edit
Assignee: platform-ua-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: needinfo
Depends on:
Blocks:
 
Reported: 2008-08-19 15:07 EDT by Tom Ball CLA
Modified: 2011-04-28 16:55 EDT (History)
3 users (show)

See Also:

Attachments
Example contexts.xml file (365 bytes, application/xml)
2008-08-19 15:07 EDT, Tom Ball CLA 		no flags Details
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Tom Ball CLA 2008-08-19 15:07:04 EDT 
Created attachment 110383 [details]
Example contexts.xml file

Build ID: I20080617-2000

Steps To Reproduce:
1. create a new dialog, such as new wizard
2. define a help context for it, with a topic that has an href attribute
3. verify that the html file specified by the href displays when the dialog's [?] button is pressed
4. add a description element to the context declaration
5. bring the dialog's help up again


More information:
The problem is either in ReusableHelpPart.update(IContextProvider, IContext, IWorkbenchPart, Control, boolean), which ignores the context parameter (which has the href topic) when updating its ManagedForm.  This is called by DefaultHelpUI.displayContextAsHelpTray(Shell, IContext), which only displays the href topic if context.getRelatedTopics() returned length is 1.
Comment 1 Chris Goldthorpe CLA 2008-09-03 18:59:56 EDT 
If you have exactly one href and no description the help system will treat this as a special case and open that topic immediately. If there is a description or more than one topic the description and topic list is presented in the tray to the right of the dialog. Is this what you are seeing? If so this is working correctly.
Comment 2 Tom Ball CLA 2008-09-03 19:34:56 EDT 
(In reply to comment #1)
> If you have exactly one href and no description the help system will treat this
> as a special case and open that topic immediately. If there is a description or
> more than one topic the description and topic list is presented in the tray to
> the right of the dialog. Is this what you are seeing? If so this is working
> correctly.

It's almost what we're seeing:  the problem is that if there is both an href and description, the href is ignored.  The topics appear to be a query of the Eclipse documentation, without any reference to our page.  Since it's title and heading are the same string being queried, it should be at the top of the results list.
Comment 3 Mike Wilson CLA 2009-05-05 10:36:22 EDT 
Changing Version tag to something more believable.
Comment 4 Chris Goldthorpe CLA 2011-04-28 16:39:22 EDT 
This bug has been dormant for a while. Are you still interested in this bug report? If so can you attach one or more screen shots showing the problem.
Comment 5 Tom Ball CLA 2011-04-28 16:55:35 EDT 
I'm not working on Eclipse any more, and so am withdrawing this bug.