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

Bug 232329

Summary: [ui] TVT34:TCT270: SV: Missing dialog/wizard help IDs
Product: [Eclipse Project] Equinox Reporter: CDE Administration <cdeadmin>
Component: p2Assignee: P2 Inbox <equinox.p2-inbox>
Status: CLOSED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: camle, cgold, john.arthorne, Kevin_McGuire, kitlo, pwebster, susan
Version: 3.4Flags: susan: review+
john.arthorne: review+
Target Milestone: 3.4 RC3   
Hardware: PC   
OS: All   
URL: 270
Whiteboard:
Bug Depends on:    
Bug Blocks: 234756    
Attachments:
Description Flags
Patch for dialog/wizard context IDs and placeholder content none

Description CDE Administration CLA 2008-05-15 11:18:42 EDT
<response_by> Lena Hederberg at 2008.05.14.14.30.25 </response_by>
Hi
No help at all is displayed when clicking the ? in the Revert Config panel

Start Eclipse.
Click on Help
Click on Software Updates
Click on the Chck for updates..  button

Click on the Revert Configuration button
Click on the ? icon

OS: Linux
Build: 0511
Function: BASE
Blocking: No

Thanx
Lena

<response_by> Lena Hederberg at 2008.05.14.14.32.32 </response_by>
Sorry - these are the correct steps:

Start Eclipse.
Click on Help
Click on Software Updates
Click on the Revert Configuration button
Click on the ? icon

Thanx /Lena

<response_by> John Ryding at 2008.05.15.10.06.38 </response_by>
This bug is confirmed to occur in a base english build, the "?" button should be removed if there is no help event attached to it.

<response_by> John Ryding at 2008.05.15.10.07.44 </response_by>
This article was reassigned from Category:''TVT/Testing,Inbox''.
Comment 1 CDE Administration CLA 2008-05-15 11:18:48 EDT
<cde:tctdetail>
Testcase: 09.000120 BASE MANAGE CONFIGURATION
Project: WSW34
Component: Xfer - Platform/UI
Priority: 4
Subject: SV: No help for Revert Config dialog
Article ID: 270
Originator: hederber@se.ibm.com
</cde:tctdetail>
Comment 2 Susan McCourt CLA 2008-05-15 15:59:52 EDT
marking RC2, not sure what we're doing for help yet.
Comment 3 Susan McCourt CLA 2008-05-20 13:41:40 EDT
doc changes moving to RC3
Comment 4 Susan McCourt CLA 2008-05-28 21:56:30 EDT
Kevin, do you have time to help on this?  Apparently the help hooks need to be in for RC3 even if the help isn't written.  Could you look over the p2 dialogs and make a determination as to whether we need help and add a hook for now?

If you don't have time can you see if someone in platform UI does?
Comment 5 Kevin McGuire CLA 2008-05-29 14:59:13 EDT
Help->Update dialog only has generic help data
Comment 6 Susan McCourt CLA 2008-05-29 16:50:50 EDT
Wasn't sure what Kevin meant in previous remark, so I just checked 3.3 and UM.

The "Revert to Previous" dialog (UM equivalent to Revert Configuration) has a help button but no help at all.  Same thing reported here, click on the help button and nothing happens.

So I think we can get away with the same for now and revisit help in depth later.
Comment 7 Kevin McGuire CLA 2008-05-29 17:14:41 EDT
It was in response to 

>>Could you look over the p2 dialogs
>>and make a determination as to whether we need help and add a hook for now?

That the UpdateAndInstall dialog needed help content
Comment 8 Kevin McGuire CLA 2008-05-29 18:05:57 EDT
Also need Help pages for all three pref pages.
Comment 9 Kevin McGuire CLA 2008-05-29 21:23:39 EDT
Created attachment 102788 [details]
Patch for dialog/wizard context IDs and placeholder content

Was titled "[ui]  No help for Revert Config dialog".

The following dialogs/wizards needed help ids put in:

- Revert
- Uninstall
- Update 
- Add Site 
- Install 
- Manage Sites
- The main Update dialog

The patch contains:
1) Code for setting their context IDs.
2) Dummy content in platform.doc.user.

Someone will need to write real content.
Comment 10 Kevin McGuire CLA 2008-05-29 21:35:01 EDT
I logged bug #234755 for the pref pages
Comment 11 Susan McCourt CLA 2008-05-29 21:50:31 EDT
resetting milestone and I'll mark the other help bug as a duplicate of this one.  I'll set the content bug milestone RC4.
Comment 12 Susan McCourt CLA 2008-05-29 21:54:15 EDT
*** Bug 230278 has been marked as a duplicate of this bug. ***
Comment 13 Kevin McGuire CLA 2008-05-29 22:16:32 EDT
Note you will to load project org.eclipse.platform.doc.user to apply this patch
Comment 14 Susan McCourt CLA 2008-05-29 22:20:02 EDT
+1.
The content will be worked on during RC4, I think the placeholders are great.
I brought up every dialog and verified that the help button brings up the topic expected.  I also brought up some dialogs from multiple contexts to ensure that the help still worked.  For example, the update wizard as launched from the automatic updates affordance shows the same help as the update wizard launched from the software updates dialog.  The add site is showing the correct content from either the main page or the manage sites page.

Eventually we may want to have the contextual help in the dialog be dependent on the page that is selected but that is a minor point.

Adding John as a second reviewer.

Thanks, Kevin...no way we could have gotten these hooks in without your help.  Now it's a matter of iterating good content during RC4 and you have laid out a good structure for us.
Comment 15 Susan McCourt CLA 2008-05-29 22:21:17 EDT
John, I know you have platform.doc commit rights, can you please release and tag the doc when you tag the p2 content?  
Comment 16 CDE Administration CLA 2008-05-29 23:24:49 EDT
Susan, we have a bridge program that synchronizes between our TVT bug reporting system and Bugzilla. We'd like to keep the "TVT34:TCT270:" tag in the summary if that's not causing too much trouble.

Thanks,
Kit Lo
IBM Eclipse SDK Globalization Technical Lead
Comment 17 John Arthorne CLA 2008-05-29 23:36:53 EDT
Reviewed and released. Thanks Kevin!!
Comment 18 CDE Administration CLA 2008-06-11 08:26:30 EDT
<response_by> Lena Hederberg at 2008.06.10.07.07.53 </response_by>
Problem solved
thanx and closing