49858 - "No proxy" field needs a syntax example under it

Status: VERIFIED FIXED

(SeaMonkey :: Preferences, defect, P3)

Description

[Jason Eager]

This is a spin-off of bug 47818. Basically, we need to give users an example of
what syntax we expect for that field, because it isn't apparent to the user, and
it is DIFFERENT from other browers (*cough* *cough* IE). This is *Critical*,
because otherwise, the users won't think that this feature even works. (Hell, I
didn't, and I'm a mozilla developer(/contributor)!)

So under the text field by "No proxys for:", we need to put something like
"Example: .yourcompany.com, .yourintranet.othercompany.com" so the user has an
idea of what to put in that field.

Comment 1

[Jason Eager]

Actually, this is a spin-off of bug 48718 (whoops).

Comment 2

[Jason Eager]

This is a user-interface issue which is trivial to fix, but NEEDS to be there,
otherwise, people won't use the syntax it is expecting, it won't work, and
people will assume the feature doesn't work, and stop using mozilla for work
inside of the proxy. I can probably submit a patch over lunch or something.

Adding keywords nsbeta3 and UE1

Comment 3

[sairuh (rarely reading bugmail)]

adding verah for her skill at phrasing tech stuff into english. :)

Comment 4

[johng]

nav triage team:
reassigning to jce2, you can go ahead and make that patch to add some text to
the current pref, is a good idea.  If you like, you may want to propose text and
ask [e-mail] what she thinks.

Comment 5

[Jason Eager]

Attachment: Screen shot of improved proxy-pane

Comment 6

[Jason Eager]

I changed the xul and the locale files to produce the screen shot above. The 
only problems I'm having are:

1) The XUL file seems to INSIST that I have a Shortcut key for EVERY visual 
element. That's why there is an underline under the E in Example.
2) I can't seem to create a blank element without giving it a shortcut. I need 
a blank element because I want the example to appear right under the text-
field. That's why there is a small line aligned with the other field labels.

If I can get rid of those two small problems, I'd submit my patch as-is.

Comment 7

[verah (gone)]

I checked the attachment and the way you've done this ("yourcompany.com") looks 
good to me. I hope you can get that problem with the "shortcuts" fixed.

Comment 8

[sairuh (rarely reading bugmail)]

thx, jce2!

am gonna bump this down since critical is usually used for crashers and the
like.

could you attach the patches for the xul and locale files? i've cc'd jrgm and
ben to see if they could help you there...

Comment 9

[Jason Eager]

Whoops, didn't realize this one was assigned to me.

Accepting it, and trying to come up with a patch that doesn't have those
weird keyboard shortcut things in it.

Comment 10

[Jason Eager]

Attachment: patch for pref-proxies.xul

Comment 11

[Jason Eager]

Attachment: patch for pref-proxies.dtd

Comment 12

[Jason Eager]

Attachment: Screenshot of proxy pane with patches applied

Comment 13

[Jason Eager]

Ok, I figured out a way to get rid of the accesskey underlines - just make the
accesskey null. :-)

I've made a few other tweaks in the pref-proxies.dtd file to fix these two problems:

1) you don't REALLY want that (G) there at the end of the socks port label, do
you? There's no good reason
for the access key to be "G" anyways.
2) The access keys for the other port entries seem to be set randomly.

So I reassigned the access keys for the port fields to something consistant:
Ftp Proxy Port uses "P", http proxy port uses "o", SSL Proxy port uses "t", and
Socks proxy port uses ":"
(I would have used P-O-R-T instead of P-O-T-:, but the "r" key is reserved for
the "reload" button.)
If nothing else, this looks better to the user.

If there are specific reasons why the access keys are the way they were before I
changed them, then
just don't apply those specific changes to pref-proxies.dtd (It should be
obvious which lines do what.)

Adding keywords patch, approval, review and polish. I'm ready for a review, an
approval, and to have
them checked in.

Comment 14

[Jason Eager]

Attachment: updated patch of pref-proxies.dtd

Comment 15

[Jason Eager]

I changed the shortcut key for the reload button from "r" to "l", so I could use
"P" "o" "r" "t" as the shortcut keys fopr the port field.

PLEASE get this in before the ui freeze. Otherwise, people will
enter the wrong syntax andd assume the feature isn't working.

Comment 16

[Peter "jag" Annema]

Attachment: [patch] Cleaned up version of the above .xul and .dtd

Comment 17

[Peter "jag" Annema]

changed the first <text/> to a <spring/> and removed the unnecessary accesskeys.
According to [e-mail], without them he gets xul errors, I can't confirm
that on my linux build, nor does it seem logical since they're optional. If
there indeed are errors, another bug should be filed if it doesn't exist yet and
this one should be made to depend on it.

Comment 18

[Brendan Eich [:brendan]]

a=brendan

/be

Comment 19

[Peter "jag" Annema]

Checked this in.

Comment 20

[John Morrison]

verified checkedin/fixed.