Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 277506

Summary: [doc] Add help contexts for new target platform work
Product: [Eclipse Project] PDE Reporter: Curtis Windatt <curtis.windatt.public>
Component: UIAssignee: Ankur Sharma <ankur_sharma>
Status: VERIFIED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: caniszczyk, darin.eclipse, gunnar
Version: 3.5Flags: curtis.windatt.public: review+
darin.eclipse: review+
caniszczyk: review+
Target Milestone: 3.5 RC3   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Bug Depends on:    
Bug Blocks: 260435, 278231    
Attachments:
Description Flags
Work in progress patch (do not commit)
none
Work in progress patch
none
Full Path
curtis.windatt.public: iplog+
Ankurs Fix + Editor Fix + Delete 3 Unused Contexts none

Description Curtis Windatt CLA 2009-05-22 13:06:11 EDT
The target UI was drastically changed in 3.5 and many of our help contexts are out of date.  We need to:

1) Hookup help contexts for the following places:

Target Pref Page
New Target Wizard
Edit Target Wizard - Add separate contexts for each tab (like the old pref page did)
Move Target Wizard

New Target Definition File Wizard
Target Editor - Separate contexts for each page, note that each page has a help button at the top right that needs hooking up.

Add/Edit new location wizard - Each type of location needs a help context
Import Variables Dialog (on the arguments tab)
Add implicit dependencies dialog


2) Delete any unused/out of date contexts.


3) Add appropriate links/description to the new contexts.
- Doc isn't finished yet, but a lot of it has been committed.
Comment 1 Gunnar Wagenknecht CLA 2009-05-22 13:29:58 EDT
Curtis, I think you added the wrong bug. Bug 260345 is a Planet Eclipse one. ;)
Comment 2 Curtis Windatt CLA 2009-05-22 14:47:37 EDT
Oops, should be bug 260435
Comment 3 Darin Wright CLA 2009-05-26 11:22:12 EDT
We should do context help code changes in RC3.
Comment 4 Ankur Sharma CLA 2009-05-26 17:32:18 EDT
Created attachment 137233 [details]
Work in progress patch (do not commit)

Contexts fixed for New target wizard, Edit target defn wizard and target editor. Some of the old target contexts cleaned.

However, some more cleaning and pending contexts remains. So don;t commit the patch yet.
Comment 5 Ankur Sharma CLA 2009-05-27 09:42:49 EDT
Created attachment 137327 [details]
Work in progress patch

Done:

1) Hookup help contexts for the following places:
Target Pref Page
New Target Wizard
Edit Target Wizard - Add separate contexts for each tab (like the old pref page
did)
Move Target Wizard
New Target Definition File Wizard
Target Editor - Separate contexts for each page, note that each page has a help
button at the top right that needs hooking up.

2) Delete any unused/out of date contexts.


Work In Progress:

Add/Edit new location wizard - Each type of location needs a help context
Import Variables Dialog (on the arguments tab)
Add implicit dependencies dialog

3) Add appropriate links/description to the new contexts.
- Doc isn't finished yet, but a lot of it has been committed.
Comment 6 Curtis Windatt CLA 2009-05-27 10:44:03 EDT
Work so far looks great Ankur.  We need to review and put this in tomorrow, so please concentrate on getting contexts into the code.  Here are a couple things I noticed.  Let me know if you need help with anything.

Preference page context needs work
Implicit dependency selection dialog has no context
Import arguments dialog has no context

Content tab on edit target wizard context does not work if the group is disabled.  We could work around this by putting the context on the higher level composite, but I don't know if it is worthwhile.
Comment 7 Curtis Windatt CLA 2009-05-27 10:44:59 EDT
Also once we've added the new contexts we'll need to go through and delete any unused contexts.
Comment 8 Ankur Sharma CLA 2009-05-27 11:45:45 EDT
(In reply to comment #6)
> Content tab on edit target wizard context does not work if the group is
> disabled.  We could work around this by putting the context on the higher level
> composite, but I don't know if it is worthwhile.
> 

I know. I didn't find any clean method and for a similar problem I have logged the bug 277996 against Platform UI.
Comment 9 Ankur Sharma CLA 2009-05-28 06:54:26 EDT
Created attachment 137455 [details]
Full Path

Alls done. The description for new contexts remains which will be updated as soon the relevant help pages gets updated. Ready for review.
Comment 10 Curtis Windatt CLA 2009-05-28 08:38:34 EDT
Awesome, we'll review it asap.
Comment 11 Darin Wright CLA 2009-05-28 10:18:07 EDT
Looks good. Just need to hook up the help button (?) in the target editor.
Comment 12 Curtis Windatt CLA 2009-05-28 11:02:44 EDT
Created attachment 137500 [details]
Ankurs Fix + Editor Fix + Delete 3 Unused Contexts

Adds a fix to get the help buttons on the editor to work correctly.  Also deleted three contexts for the target provisioners that no longer exist.
Comment 13 Curtis Windatt CLA 2009-05-28 11:10:05 EDT
+1 Ankur's fix is good.  I added a patch with the additional editor fix.

I will file a separate bug for updating the links in the contexts against pde doc.
Comment 14 Chris Aniszczyk CLA 2009-05-28 11:15:13 EDT
+1
Comment 15 Curtis Windatt CLA 2009-05-28 11:34:42 EDT
Fixed in HEAD.
Comment 16 Curtis Windatt CLA 2009-05-28 11:35:06 EDT
Verified by multiple committers.  Thanks Ankur.