Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 131009 - Provide context-sensitive help links for BIRT UI
Summary: Provide context-sensitive help links for BIRT UI
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: BIRT (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P1 major (vote)
Target Milestone: 2.1.0 RC5   Edit
Assignee: Frank Zhang CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 144341
Blocks:
  Show dependency tree
 
Reported: 2006-03-08 19:57 EST by Jane Tatchell CLA
Modified: 2008-06-18 14:44 EDT (History)
3 users (show)

See Also:


Attachments
File containing 2 BIRT csh plugins and 2 csh feature plugins, source included (71.15 KB, application/zip)
2006-05-16 16:21 EDT, David R Cole CLA
bjorn.freeman-benson: iplog+
Details
Revised xml file containing requested new IDs and corrected links (23.34 KB, text/xml)
2006-05-31 18:09 EDT, David R Cole CLA
no flags Details
Revised xml file containing requested new IDs and corrected links (18.69 KB, text/xml)
2006-05-31 18:10 EDT, David R Cole CLA
no flags Details
More Help Ids Needed (33.50 KB, application/msword)
2006-06-08 05:10 EDT, Frank Zhang CLA
no flags Details
Revised xml file with 16 new contexts, per request. (32.15 KB, text/xml)
2006-06-08 17:17 EDT, David R Cole CLA
no flags Details
Contexts.xml with Preference_BIRT_ResourceSelectDB_ID removed (31.82 KB, text/xml)
2006-06-09 11:13 EDT, David R Cole CLA
bjorn.freeman-benson: iplog+
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Jane Tatchell CLA 2006-03-08 19:57:16 EST
All UI elements in BIRT Report Designer need hooks for context-sensitive help.
Comment 1 Cheng-Yee Lin CLA 2006-03-23 13:42:54 EST
This work requires quite a bit of coordination on both the code development and documentation.  The changes involves adding the hook for the context-sensitive help id in the UI initialization code, providing the actual help content entry in an contexts XML file, and an extension inside the plugin.xml file that makes the connection between the code and the contexts XML file.

I would suggest to go through this exercise on a few of them before the massive changes and ensure the mechanism does work.  It would be good if this exercise can be done early.
Comment 2 David R Cole CLA 2006-05-16 16:21:20 EDT
Created attachment 41644 [details]
File containing 2 BIRT csh plugins and 2 csh feature plugins, source included

Draft of cshelp for BIRT for all identified UI elements.
Comment 3 Jane Tatchell CLA 2006-05-17 18:16:21 EDT
I have added these features and plugins to CVS. They need to be included in the build. If the build team advise me on any requirements to the setup of these features and plugins, I can make them, or they can make the changes themselves if that would be quicker.
Comment 4 Wang Qiangsheng CLA 2006-05-26 01:46:10 EDT
Please talk with Dazhen and Yulin for implmentation details.
Comment 5 David R Cole CLA 2006-05-31 18:09:18 EDT
Created attachment 43183 [details]
Revised xml file containing requested new IDs and corrected links

Replaces only the xml files for org.eclipse.birt.cshelp
Includes the new IDs that Xiong Zhang requested.
Adds birt\ to all links to help topics.
Comment 6 David R Cole CLA 2006-05-31 18:10:48 EDT
Created attachment 43184 [details]
Revised xml file containing requested new IDs and corrected links

Replaces only the xml file for org.eclipse.birt.chart.cshelp
Includes the new IDs that Xiong Zhang requested.
Adds birt\ to all links to help topics.

Thanks, Xiong!
Comment 7 Frank Zhang CLA 2006-06-04 23:36:07 EDT
I've added the the context-sensitive help.
Comment 8 Frank Zhang CLA 2006-06-06 23:07:55 EDT
Reopen it, for we have a lot of dialogs have no context-sensitive help yet.
A list will be given later.
Comment 9 Frank Zhang CLA 2006-06-08 05:10:25 EDT
Created attachment 43843 [details]
More Help Ids Needed

Hi, Jane, for we found that there're some dialogs without context-sensitive help, I listed the dialogs and Ids in the attachment.
Can you add them to file contexts.xml?

Now I assign this bug to you, could you please reassign it to me after you add it ? Thank you very much.
Comment 10 Frank Zhang CLA 2006-06-08 05:13:33 EDT
Assign this bug to Jane to add the ids in attachment, please reassign it to me after done.
Comment 11 David R Cole CLA 2006-06-08 17:17:55 EDT
Created attachment 43922 [details]
Revised xml file with 16 new contexts, per request.

The new context IDs include 
- the 13 requested for Bug 131009, 
- two additional IDs that Max requested, 
- and one that Jane brought to my attention, to which I have assigned the ID Preference_BIRT_ResourceSelectDB_ID.

IMPORTANT NOTE to developers: I fixed typos in the following two IDs: ResourceSelectDialog_ID and PublishLibraryDialog_ID. Please make these same changes in your code.

Xiexie dajia!
Comment 12 Jane Tatchell CLA 2006-06-08 20:07:58 EDT
New contexts.xml file has been applied to the cshelp plugin, as per David's comment.
Comment 13 Frank Zhang CLA 2006-06-09 00:01:59 EDT
Hi,David,
Sorry for typo errors, and I've corrected them now.
I've added all the Ids except Preference_BIRT_ResourceSelectDB_ID, and they work well.

I don't think we should add Preference_BIRT_ResourceSelectDB_ID, it's a DirectoryDialog, and need not context help, this is different from 
  Publish Library to Resource Folder…->Browse	RresourceSelectDialog_ID

You can do the following steps to confirm my opinion.
1. File Menu -> New -> Project...;
2. Select "Java Project", and click Next;
3. Select "Create Java Project from Exsiting source", and then the "browse" button will be enabled;
4. Click "Browse button", and it also invokes a DirectoryDialog without context help.

Fix it, and thank both you and Jane. 
Xiexie!
Comment 14 David R Cole CLA 2006-06-09 11:13:41 EDT
Created attachment 43994 [details]
Contexts.xml with Preference_BIRT_ResourceSelectDB_ID removed

Removed Preference_BIRT_ResourceSelectDB_ID at Frank's request.
Comment 15 Bjorn Freeman-Benson CLA 2008-06-18 14:43:07 EDT
Comment on attachment 43994 [details]
Contexts.xml with Preference_BIRT_ResourceSelectDB_ID removed

per Ganymede IP log
Comment 16 Bjorn Freeman-Benson CLA 2008-06-18 14:44:33 EDT
Comment on attachment 41644 [details]
File containing 2 BIRT csh plugins and 2 csh feature plugins, source included

per Ganymede IP log