Bug 507881 - [KeyBindings] Keys preference page should display and export command id
Summary: [KeyBindings] Keys preference page should display and export command id
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 4.6   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 4.8 M3   Edit
Assignee: Joachim Kaesser CLA
QA Contact:
URL:
Whiteboard:
Keywords: noteworthy
Depends on:
Blocks:
 
Reported: 2016-11-21 09:28 EST by Patrik Suzzi CLA
Modified: 2017-10-02 05:26 EDT (History)
5 users (show)

See Also:


Attachments
image: Keys page, we could (183.42 KB, image/jpeg)
2016-11-21 09:28 EST, Patrik Suzzi CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Patrik Suzzi CLA 2016-11-21 09:28:38 EST
Created attachment 265479 [details]
image: Keys page, we could

As a plugin developer, I will need to know the id of commands available in my Eclipse IDE and displayed in the Keys preference page. 

Not having the command ids, can make the code hard to maintain; i.e. Bug 507660.

To fix this simply, without affecting the UI, we could modify the Keys preference page, and let the "Export CSV.." adds also the command ids to the exported list. 

A better solution would be displaying the command ids in the Keys page, but this might be controversial, as it would make more complex the Keys preference page.
Comment 1 Andreas Sewe CLA 2016-11-21 09:42:41 EST
(In reply to Patrik Suzzi from comment #0)
> A better solution would be displaying the command ids in the Keys page, but
> this might be controversial, as it would make more complex the Keys
> preference page.

I agree with the sentiment that showing IDs (even in a tooltip) just adds stuff to the UI which the average user won't need or understand.

I can imagine, however, showing the contributing plugin (rather than the commandId) in a tooltip; it's (human-readable) name might be something end-users may understand and occasionally even find useful to disambiguate between commands with the same (human-readable) name.
Comment 2 Karsten Thoms CLA 2017-07-17 10:51:00 EDT
See
org.eclipse.ui.internal.keys.NewKeysPreferencePage
org.eclipse.ui.internal.keys.model.KeyController#exportCSV
Comment 3 Eclipse Genie CLA 2017-07-17 13:38:38 EDT
New Gerrit change created: https://git.eclipse.org/r/101374
Comment 4 Mickael Istria CLA 2017-09-12 03:51:43 EDT
The proposal and the patch are interesting and having commandId in CSV is indeed helpful.
Just to make sure, at the moment, a user can export this file, but cannot import it? If so then I think the proposed change is good to get in 4.8.M3.
If there is any supported workflow that allows importing this file, we need to make sure that this change still allows
1. importing new file (with commandId) to an older supported version
2. importing old file (wihtout commandId) to newer version still works
Comment 5 Karsten Thoms CLA 2017-09-12 03:54:00 EDT
The export file is intended just for information purpose. There is no way to import it.
Comment 6 Mickael Istria CLA 2017-09-12 03:57:39 EDT
(In reply to Karsten Thoms from comment #5)
> The export file is intended just for information purpose. There is no way to
> import it.

That's good news for us as it makes this patch safe for a future merge, although it sounds like a missing feature ;)
Comment 8 Mickael Istria CLA 2017-09-15 07:30:37 EDT
Thanks for the patch! Can you please add a note to the new and noteworthy about it?
Comment 9 Karsten Thoms CLA 2017-09-15 07:35:35 EDT
Which document has to be edited?
Comment 10 Mickael Istria CLA 2017-09-15 08:12:50 EDT
(In reply to Karsten Thoms from comment #9)
> Which document has to be edited?

http://git.eclipse.org/c/gerrit/www.eclipse.org/eclipse/news.git/tree/4.8/M3/index.html
Gerrit is enabled for the news.git repo.
Comment 11 Eclipse Genie CLA 2017-09-26 21:39:15 EDT
New Gerrit change created: https://git.eclipse.org/r/105813
Comment 13 Mickael Istria CLA 2017-10-02 05:26:21 EDT
Thanks a lot Joachim and Karsten!