Closed Bug 662322 Opened 13 years ago Closed 13 years ago

Add a note about themes in panel API documentation

Categories

(Add-on SDK Graveyard :: Documentation, defect, P2)

defect

Tracking

(Not tracked)

RESOLVED FIXED
Future

People

(Reporter: ochameau, Assigned: wbamberg)

Details

Attachments

(3 files, 2 obsolete files)

Bug 661652 highlights a problem that can be commonly face by all developers using Panel API. Currently, with MacOS skins the panel background is gray so when you display a text with default color(black) it ends up being unreadable. We tried to fix that in bug 652548, but there may be various corner cases. So it may be better to add some note in documentation to highlight these color problems.
Attached patch Note proposal (obsolete) (deleted) — Splinter Review
Here is such note. Feel free to move it or rephrase it completely. I'm aware of my low level in writing clear english documentation!
Attachment #537599 - Flags: review?(wbamberg)
Priority: -- → P2
Target Milestone: --- → Future
Attachment #537599 - Flags: review?(wbamberg)
Attached patch Added some screenshots (obsolete) (deleted) — Splinter Review
Alex, I thought some screenshots might help here, so I added some for Ubuntu and OS X. I don't have a Windows here, but if you had a chance to add one for Windows, I think that would be great. In case you do, I attached the background I've used for the other 2.
Assignee: nobody → wbamberg
Attachment #537599 - Attachment is obsolete: true
Attachment #537699 - Flags: feedback?
Attachment #537699 - Flags: feedback? → feedback?(poirot.alex)
Attached image Background for screenshots (deleted) —
Attached image Here is a Windows screenshot. (deleted) —
Attachment #537699 - Attachment is patch: true
Attachment #537699 - Attachment mime type: text/x-patch → text/plain
Comment on attachment 537699 [details] [diff] [review] Added some screenshots Review of attachment 537699 [details] [diff] [review]: ----------------------------------------------------------------- This improvement is really better than my "developer documentation" :) Except a minor word repetition I found it very clear. ::: packages/addon-kit/docs/panel.md @@ +27,4 @@ > [Working with Content Scripts](dev-guide/addon-development/web-content.html) > for more information. > > +The panel's default style is different for different operating systems. you may avoid "different" repetition by using, for example, "different for each operating systems."
Attachment #537699 - Flags: feedback?(poirot.alex) → feedback+
Attachment #537699 - Attachment is obsolete: true
Attachment #537805 - Flags: review?(warner-bugzilla)
Comment on attachment 537805 [details] [diff] [review] Added screenshots for Windows, OS X and Ubuntu Looks good to me!
Attachment #537805 - Flags: review?(warner-bugzilla) → review+
Low-risk, useful change to have in 1.0, a=myk for commission during freeze.
Status: NEW → RESOLVED
Closed: 13 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: