Bug 277598 - Need to apply consistent branding for features in about box
Summary: Need to apply consistent branding for features in about box
Status: RESOLVED FIXED
Alias: None
Product: WTP Releng
Classification: WebTools
Component: releng (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: David Williams CLA
QA Contact: David Williams CLA
URL:
Whiteboard: PMC
Keywords:
Depends on:
Blocks:
 
Reported: 2009-05-24 03:06 EDT by David Williams CLA
Modified: 2009-09-08 20:57 EDT (History)
3 users (show)

See Also:
david_williams: pmc_approved? (raghunathan.srinivasan)
david_williams: pmc_approved? (naci.dai)
david_williams: pmc_approved? (deboer)
neil.hauge: pmc_approved+
david_williams: pmc_approved? (kaloyan)

Attachments
chagnes made for javaScript (4.95 KB, patch)
2009-05-24 03:10 EDT, David Williams CLA 		no flags Details | Diff
changes made for xml (4.67 KB, patch)
2009-05-24 03:38 EDT, David Williams CLA 		no flags Details | Diff
In general, outline of steps to follow to brand a feature for WTP (1.04 KB, text/plain)
2009-05-24 03:41 EDT, David Williams CLA 		no flags Details
improved instructions (1.57 KB, text/plain)
2009-05-24 16:56 EDT, David Williams CLA 		no flags Details
Show Obsolete (1) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description David Williams CLA 2009-05-24 03:06:23 EDT 
One of the Galileo requirements is to  apply some feature branding for major projects. Such as provide an icon for about box, and a meaningful provider name, such as "Eclipse Web Tools Platform". 

I couldn't believe we still had the old 'wst' and 'jst' features in there. I thought we'd long ago moved past that. [faulty memory, I guess, results when you think about doing something long enough eventually you actually think you did it!]

So, out with the old, in with the new. 

I think too disruptive to brand all features (and worth discussing even if we should ... 'source features' for example would seem a waste?) but I think we should 
1) rebrand all those that already do, so they are consistent (use common icon, use common provider name). 
2) brand at least the features that appear on the Galileo update site. 

Next release we can do a more complete, organized job. 

For '1' above, I think this effects the faceted projects features (already converted), the xsl feature, axis2 feature. 

For '2' above, this would be apache myfaces, axis2 (again), 2 for Dali, xml, java ee developer, java script dev. tools, web. dev. tools, and web page editor. 

I wouldn't strongly object if people wanted to do others, but think those should have their separate bugs and a separate review ... just so I understand the rationale and patterns. 

I'll do a few of these, so there's plenty of examples (and I convince myself it works ... but eventually others will need to finish up).
Comment 1 David Williams CLA 2009-05-24 03:10:29 EDT 
Created attachment 136905 [details]
chagnes made for javaScript

Note: the icon image isn't included in patch, but comes from bug 273772. 
Also, there might be a few extra changes in JavaScript ... I noticed it didn't have an udpate site for some reason, so added that.
Comment 2 David Williams CLA 2009-05-24 03:38:13 EDT 
Created attachment 136906 [details]
changes made for xml
Comment 3 David Williams CLA 2009-05-24 03:41:23 EDT 
Created attachment 136907 [details]
In general, outline of steps to follow to brand a feature for WTP
Comment 4 David Williams CLA 2009-05-24 04:06:08 EDT 
Marking for "PMC Approval", though not exactly the normal process. 

It unfortunately changes UI, and will be a late breaking change to some assembly featuers (org.eclipse.jst and org.eclipse.wst) but I think we really need the change ... have for a long time, so the cost will be worth it. 

When I saw our out of date our display was, it's no wonder, perhaps, people are biased to think we are "too big" since 'wst' and 'jst' are still be primary features displayed there! 

I'll be glad to revert, if someone comes up with a reason we should. 

Thanks,
Comment 5 David Williams CLA 2009-05-24 16:56:39 EDT 
Created attachment 136934 [details]
improved instructions

Most significant change was that I previously forget to include the "about.mappings" file.
Comment 6 David Williams CLA 2009-05-24 20:44:30 EDT 
I've basically fixed all the remaining ones that had the "old" style feature branding. 

I also fixed those for which I'm a committer. 

Those components may want to check if they want to improve description, or anything else ... but I think there's nothing remaining that _has_ to be fixed this release. 

That leaves 4 features listed on update site, that I do not think currently have any "feature branding". It is not "stop ship" to fix those, imho, ... but, if anyone wants to you can follow the pattern set forth here. See xml ui feature and plugin for example. 

Those four that appear on update site, but not in "about box" are apache myfaces, webpage editor, and the two dali features. 

Feel free to ask questions if anything is not clear.
Comment 7 David Williams CLA 2009-05-25 13:16:03 EDT 
Note for those wanting to do additional work to "brand features" I've put in a template plugin that contains the instructions and standard files and formats for WTP in a plugin in cvs. It is not to be used directly, but might make "getting the files" easier. I've also included there the instructions in a file called "stepByStepInstructions.txt"

Check out

org.eclipse.wtp.feature.branding.template

from 

webtools.releng/plugins/
Comment 8 Tran Le CLA 2009-05-28 17:06:51 EDT 
David, 
We had a branding plugin before but we dropped it because of the bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=245803
I think the issue was that it was referred from an assembly features therefore it was ignored once Dali was zipped.
Do you suggest that we reintroduce it? in that case I guess we should refer it from the org.eclipse.jpt.feature.
Thanks.
Comment 9 David Williams CLA 2009-05-28 17:12:24 EDT 
Yes, I've learned that, basically, branding plugins for features should always be 'included' in the feature that they are branding. You can re-introduce it, or just modify one of your existing ones if easier, and appropriate. 

The important thing will be to use the common icon, and common provider name. (That is, even if you use the old one, you'll need to change it).
Comment 10 Max Rydahl Andersen CLA 2009-05-29 06:16:55 EDT 
Won't this create a gigantic about box for a default galileo ?

At JBoss Tools we were branding our features too, but recently we stopped doing it or at least reduced it to one since the about box gets overcrowded *very* quickly if every feature-group gets a dominant icon on the about page.
Comment 11 David Williams CLA 2009-09-08 20:57:55 EDT 
I think the Galileo requirements were met, so closing as 'fixed'.