Bug 285034 - Warning if you start using a deprecated extension point
Summary: Warning if you start using a deprecated extension point
Status: RESOLVED FIXED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.6   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: 3.6 M2   Edit
Assignee: Curtis Windatt CLA
QA Contact:
URL:
Whiteboard:
Keywords: bugday, helpwanted
Depends on:
Blocks:
 
Reported: 2009-07-29 12:44 EDT by Lars Vogel CLA
Modified: 2009-09-02 17:40 EDT (History)
5 users (show)

See Also:


Attachments
Screenshot (25.39 KB, image/gif)
2009-07-29 12:44 EDT, Lars Vogel CLA
no flags Details
Screenshot (19.28 KB, image/gif)
2009-07-29 18:51 EDT, Lars Vogel CLA
no flags Details
Warnings & Icons (19.52 KB, image/gif)
2009-07-30 17:53 EDT, Lars Vogel CLA
no flags Details
with Warning (21.44 KB, image/gif)
2009-07-30 17:56 EDT, Lars Vogel CLA
no flags Details
Message alligned with existing (21.32 KB, image/gif)
2009-07-30 18:16 EDT, Lars Vogel CLA
no flags Details
Patch (5.92 KB, text/plain)
2009-07-30 18:28 EDT, Lars Vogel CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Lars Vogel CLA 2009-07-29 12:44:40 EDT
Created attachment 142909 [details]
Screenshot

Hi, 

If you add an extension point in PDE which is deprecated then the dialog should display a warning so that the developer gets the immediate feedback that this extension point should not be used anymore.

Screenshot which should give a little help in understanding this request is attached. For this screensho I assume that actionSet is deprecated.

Best regards, Lars

P.S. I open this bug in relation to blog entry http://www.vogella.de/blog/2009/07/29/deprecate-extension-points/ where I asked the question if that would be useful. I got the feedback over twitter that I should open a bug for this request.
Comment 1 Curtis Windatt CLA 2009-07-29 12:51:20 EDT
This definitely makes sense.  A contribution from the community would make this a reality.
Comment 2 Aurelien Pupier CLA 2009-07-29 13:24:12 EDT
set a filter on deprecated extension point when we choose one (as a checkbox as the existing “Show only extension points from the required plugin”) will be a "good warning" too
Comment 3 Lars Vogel CLA 2009-07-29 18:51:07 EDT
Created attachment 142959 [details]
Screenshot

@Curtis I like the filter idea. What do you think? I did the UI changes, please see the screenshot for the example
Comment 4 Curtis Windatt CLA 2009-07-30 10:26:29 EDT
When the filter is turned off are we just going to show the deprecated points the same as the others?  I would prefer just informing the user the extension point they are adding is deprecated (as a wizard warning and maybe a different icon).  

Adding more options to the dialog makes it harder to use and I expect most users are looking for a specific extension and might be confused when they can't find it.
Comment 5 Lars Vogel CLA 2009-07-30 17:53:31 EDT
Created attachment 143092 [details]
Warnings & Icons

Attached a screenshots with warnings and different icons. Sorry, for the confusion I was definitely planning to do this but wanted to hear the opinion about the additional check box.

I personally like the idea to hide "old" stuff as this would display only the relevant content. But I remove the option in the hope that the patch get quickly accepted; I can add it later if someone thinks it makes sence. 

Is the screenshot ok? If yes I upload the patch.
Comment 6 Lars Vogel CLA 2009-07-30 17:56:58 EDT
Created attachment 143093 [details]
with Warning

Now screenshot shows also the warning ;-)
Comment 7 Benjamin Cabé CLA 2009-07-30 18:10:07 EDT
How can you indicate the right extension point to use is o.e.ui.commands, since we don't have any metadata telling what is the suggested successor of a deprecated ext point?

WRT the icon, could you use an 8x8 overlay instead of a totally different icon? By the way l, did you implement tthis at PDELabelProvider level, in order that we can benefit from this everywhere in the UI?
Comment 8 Lars Vogel CLA 2009-07-30 18:16:42 EDT
Created attachment 143094 [details]
Message alligned with existing

Message aligned with standard message.
Comment 9 Lars Vogel CLA 2009-07-30 18:28:02 EDT
Created attachment 143095 [details]
Patch

@Benjamin: I guess it is easier to attach the patch so that you can see for yourself. ;-)

My optinion is that the description of the deprecated extension point (ep) should contain a reference to its successor. The icon and warning will alert the user to read the description. 

Please feel free to use any icon you like; I used ISharedImages.IMG_OBJS_WARN_TSK but I have absolutely no preference in the warning icon. 

WRT the lableprovider: PointSelectionPage defines its own label provider which I adjusted.
Comment 10 Chris Aniszczyk CLA 2009-08-06 17:09:40 EDT
Want to review Benjamin?
Comment 11 Curtis Windatt CLA 2009-09-02 17:22:38 EDT
The provided patch had some issues (not using constants, icons instead of overlays, messages that wouldn't go away, etc.) so I wrote a new fix.

Fixed in HEAD, see PointSelectionPage.java

Let us know if the fix isn't enough.
Comment 12 Lars Vogel CLA 2009-09-02 17:40:39 EDT
Looks perfect. Thank you.