Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 338184 - Rename "open declaration" hyperlink action
Summary: Rename "open declaration" hyperlink action
Status: RESOLVED WONTFIX
Alias: None
Product: CDT
Classification: Tools
Component: cdt-editor (show other bugs)
Version: 8.0   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact: Anton Leherbauer CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-02-25 04:04 EST by Marko Tomljenovic CLA
Modified: 2011-05-03 04:34 EDT (History)
2 users (show)

See Also:


Attachments
Properties files with the changed action name (4.26 KB, text/plain)
2011-02-25 04:05 EST, Marko Tomljenovic CLA
no flags Details
The patched properties file that contains the action labels (1.41 KB, patch)
2011-05-02 05:11 EDT, Marko Tomljenovic CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Marko Tomljenovic CLA 2011-02-25 04:04:22 EST
Build Identifier: 7.0.1

The Hyperlink action on a C element is called "Open Declaration". Since we are adding other kinds of "Open Declaration" hyperlinks it would be good if the original action would be called "Open C/C++ Declaration" so that it is unambiguous.

Reproducible: Always

Steps to Reproduce:
See details
Comment 1 Marko Tomljenovic CLA 2011-02-25 04:05:07 EST
Created attachment 189777 [details]
Properties files with the changed action name
Comment 2 Anton Leherbauer CLA 2011-02-28 02:54:16 EST
Please attach a patch.
What other hyperlinks are added?  Could you refer to the bugs?
Comment 3 Marko Tomljenovic CLA 2011-03-09 02:21:53 EST
(In reply to comment #2)
> Please attach a patch.
> What other hyperlinks are added?  Could you refer to the bugs?

In our use case, code generation is done. And then the real declaration of a variable is not contained in src code but in an xml file. Therefore the hyperlink "Open Declaration" is confusing the user. "Open C/C++ Declaration" is unambiguous.
I will provide a patch soon.
Comment 4 Marko Tomljenovic CLA 2011-05-02 05:11:07 EDT
Created attachment 194465 [details]
The patched properties file that contains the action labels
Comment 5 Marc-André Laperle CLA 2011-05-03 02:29:01 EDT
I'm not sure this is the right thing to do. We'll add more hyperlinks in the future (I have 2 in progress). Should we add 'C/C++' to them too? So they would be "Open C/C++ Return Type", "Open C/C++ Implementation", "Open C/C++ Declared Type", etc. It seems redundant and inconsistent with JDT's hyperlinks. Would you consider naming your hyperlink "Open XML Declaration", "Open Generating Declaration" or something different? It seems wrong to me to change the 'default' names of the hyperlinks (from JDT) to accommodate your specific use case.
Comment 6 Marko Tomljenovic CLA 2011-05-03 02:40:22 EDT
I can understand your point that it is not the JDTs way. But unfortunately Java development is not C development, so applying the same concepts(ideas may not be appropriate in all use cases.
The main point is: Renaming the hyperlinks does not cost much time and it will also not confuse existing users (my guess) but doing so will help our users and will spare my time since otherwise I would have to patch the plugins all the time we switch to a new version ;)

What do you think?

Greets Marko
Comment 7 Anton Leherbauer CLA 2011-05-03 03:32:20 EDT
Your patch not only changes the hyperlink, but also the context menu item and we would end up pretty inconsistent: E.g. Open Declaration in the Navigate menu, but Open C/C++ Declaration in the editor context menu.  BTW, no other navigate command has "C/C++" in it is name.  So, that's certainly not acceptable.

I agree with Marc-Andre that you should rather consider to choose unambiguous names for your custom hyperlinks.
Comment 8 Marko Tomljenovic CLA 2011-05-03 03:39:51 EDT
If the only problem is to spend effort to change all relevant places consistently then I can provide a proper patch for that. Would that be ok for you?
Comment 9 Anton Leherbauer CLA 2011-05-03 03:43:56 EDT
(In reply to comment #8)
> If the only problem is to spend effort to change all relevant places
> consistently then I can provide a proper patch for that. Would that be ok for
> you?

No, that's not the problem.  We cannot change the UI all over the place just to make some custom contribution unambiguous.
Comment 10 Marko Tomljenovic CLA 2011-05-03 04:18:30 EDT
Ok, I can understand your point.

Then I guess we can close/reject this issue and I will find another way to satisfy our users ;)
Comment 11 Anton Leherbauer CLA 2011-05-03 04:33:22 EDT
Thanks for your understanding.
Comment 12 Marko Tomljenovic CLA 2011-05-03 04:34:43 EDT
(In reply to comment #11)
> Thanks for your understanding.

No prob