Bug 159650 - Pathmaps Preference Page is not easy to use
Summary: Pathmaps Preference Page is not easy to use
Status: RESOLVED FIXED
Alias: None
Product: GMF-Runtime
Classification: Modeling
Component: General (show other bugs)
Version: 1.0.1   Edit
Hardware: PC Linux
: P2 enhancement
Target Milestone: 2.0   Edit
Assignee: Christian Damus CLA
QA Contact:
URL:
Whiteboard:
Keywords: contributed, usability
Depends on:
Blocks:
 
Reported: 2006-10-03 17:18 EDT by Christian Damus CLA
Modified: 2010-07-19 21:56 EDT (History)
3 users (show)

See Also:


Attachments
Uses cases for enhanced pref page (105.39 KB, application/octet-stream)
2007-02-15 16:21 EST, Christian Damus CLA
no flags Details
Patch implementing the proposed design (77.21 KB, patch)
2007-02-19 18:24 EST, Christian Damus CLA
no flags Details | Diff
Updated patch (79.63 KB, patch)
2007-02-20 08:18 EST, Christian Damus CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Christian Damus CLA 2006-10-03 17:18:43 EDT
When creating a pathmap using an instance of the org.eclipse.gmf.runtime.emf.ui.PathmapsPreferencePage (installed by my client application in the preferences dialog), the user has to click on the hyperlink to jump to the Linked Resources page in order to add a pathmap entry.

The text that indicates this is a little oblique.  It should be more direct, stating something like "To add a pathmap, use the Linked Resources page to define a path variable, then this page to associate it with modeling."  As currently formulated, it is assuming that the user already has defined useful path variables for some independent reason, which in a modeling application is not generally the case.

Alternatively (and to work around bug 81202, which is the reason why the Linked Resources page has no "Apply" button), it would be even nicer to be able to define the path variable on this page instead of having to do so on the Linked Resources page.
Comment 1 Anthony Hunter CLA 2006-10-03 19:51:57 EDT
I assume that this is a 2.0 request given we are not supposed to add new strings.
Comment 2 Christian Damus CLA 2007-02-09 16:02:07 EST
Technically, an enhancement (though it is a priority).
Comment 3 Christian Damus CLA 2007-02-15 16:21:37 EST
Created attachment 59099 [details]
Uses cases for enhanced pref page

Attached an HTML document describing a proposal for the enhanced Path Maps preference page by way of use cases and screen captures.
Comment 4 Christian Damus CLA 2007-02-15 16:24:29 EST
Anthony, Cherie, Alan,

Can you please review the attached ZIPped HTML document and comment on the proposed UI in this bug?
Comment 5 Anthony Hunter CLA 2007-02-15 16:52:20 EST
Looks good to me.

Only comment:

I think the caption needs to be:
Choose or create path variable for use in modeling artifacts.
(i.e. "in" not "for") 
Comment 6 Alan Yeung CLA 2007-02-15 17:39:14 EST
Looks good.
Comment 7 Cherie Revells CLA 2007-02-16 08:29:44 EST
Looks good.  One comment:  In the "Edit a Pathmap" usecase step 2a should the dialog also indicate that the workspace Path Variable will be editted similar to when the user attempted to remove a pathmap?
Comment 8 Christian Damus CLA 2007-02-16 08:49:28 EST
Thanks, all, for your reviews (so prompt, too!).

In reply to comment #5:  thanks, that was an incomplete edit of an existing string.

In reply to comment #7:  that's a good idea.  I'll be sure to mention in the directions at the top of both the "New Path Map Variable" and "Edit Path Map Variable" dialogs that these manipulate the workspace path variables.  It wouldn't be a prompt dialog (as in the removal use case) in addition to the edit dialog.
Comment 9 Christian Damus CLA 2007-02-19 18:24:19 EST
Created attachment 59334 [details]
Patch implementing the proposed design

Attached a patch implementing the design proposed in the use case document (previous attachment).  Includes resolution of Cherie's code-review comments:

  - add warning icon for non-existent path
  - verify keyboard navigation using tab and accelerators
  - confirm work-around for bug 76509 re: disabling table checkboxes
  - confirm no changes to public/protected API
  - delete unused messages
  - apply workspace path variable changes only on Apply/OK
Comment 10 Christian Damus CLA 2007-02-20 08:18:06 EST
Created attachment 59365 [details]
Updated patch

Attached an updated patch that fixes Javadoc problems in the previous patch (missing/incorrect documentation).
Comment 11 Cherie Revells CLA 2007-02-21 11:03:18 EST
Committed Christian's patch.  Tested accessibility with use of keyboard and screenreader.
Comment 12 Anthony Hunter CLA 2007-02-21 11:29:37 EST
Hi Christian, 

As part of this delivery, we need to review http://wiki.eclipse.org/index.php/GMF_New_and_Noteworthy#2.0_M5 (check that GMF tooling is generating the new preference page).

We also need to update M5 new and noteworthy with this enhancement.
Comment 14 Richard Gronback CLA 2008-08-13 13:10:59 EDT
[target cleanup] 2.0 M5 was the original target milestone for this bug
Comment 15 Eclipse Webmaster CLA 2010-07-19 21:56:36 EDT
[GMF Restructure] Bug 319140 : product GMF and component
Runtime was the original product and component for this bug