279054 - Document new proxy pref pane in Help

Status: RESOLVED FIXED

(Documentation Graveyard :: Help Viewer, defect)

Description

[Stefan Borggraefe]

Bug 257758 changed the proxy pref pane of Seamonkey to add some new options.
Help needs to be updated accordingly.

Comment 1

[Giacomo Magnini]

Attachment: First cut, only a sample template. Someone should really fill in the blanks! :-)

Comment 2

[Giacomo Magnini]

Attachment: First real attempt. Added some cleanup and an option missing from the Advanced panel (noWin?)

Comment 3

[[e-mail]]

As far as I can tell, system preferences only apply to GTK2 builds.
Note that Mozilla does not officially release GTK2 builds...

Comment 4

[Giacomo Magnini]

Ok, I'll remove it from the next patch: Any comment on the new proxy pane
explanation?

Comment 5

[Stefan Borggraefe]

Comment on attachment 173071 [details] [diff] [review]
First real attempt. Added some cleanup and an option missing from the Advanced panel (noWin?)

You completely forgot to document the new option "Automatically discover the
proxy configuration". When this option is selected, Mozilla tries to determine
the proxy configuration via the WPAD protocol.

>+  <li><strong>Manual proxy configuration</strong>: Choose this if you
>+    don&apos;t have a proxy location (URL).

I think you also need to change this sentence, because of the new WPAD option.

>+      <li><strong>Port</strong>: Enter the port number in the Port field. Click
>+        on <q>Advanced</q> to configure the proxy service for any protocol:

Better IMHO: "Click on Advanced if you want to use different proxies for
different protocols or need to use a SOCKS proxy:" Or something like that.

>+            <p><strong>Note</strong>: If you&apos;re using the same settings
>+              for all types of proxies, click on <q>Use HTTP Proxy settings
>+              for all protocols</q> when you&apos;ve filled in the fields
>+              for HTTP Proxy.</p>

I think you can strike "when you&apos;ve filled in the fields for HTTP Proxy".
With the old UI this button was only useful if you *first* entered the HTTP
proxy settings. This is no longer the case.

>+            <ul>
>+              <li><strong>SOCKS v4, SOCKS v5</strong>: When entering a SOCK

SOCK -> SOCKS

>+              <li><strong>Use for resolving hostnames</strong>: Select this to
>+                use the Socks host for resolving hostanames. This is

hostanames -> hostnames, Socks -> SOCKS

>+      <li><strong>No Proxy for</strong>: Type the domains and/or IP address

I think "IP addresses" would be better (plural).

When I filed this bug I planned to split the Help contents into two sections
the same way the Proxies Preferences were split into two dialogs now. This way
a user not using the Advanced dialog doesn't need to read about the options in
that dialog. Of course the description of the Advanced button should include a
hyperlink to the description of the Advanced dialog.

What do you think about this idea? Do you like it, too?

Thanks for your help! :-)

Comment 6

[Ian Neal]

Comment on attachment 173071 [details] [diff] [review]
First real attempt. Added some cleanup and an option missing from the Advanced panel (noWin?)

I think you need to separate out what you do once you have pressed the
"Advanced" button on the proxies prefs page from the rest. So probably a
sentence about why you want to click on the advanced button linked to a more
detailed explanation of what to fill in where for the dialog box it brings up.

Comment 7

[Stefan Borggraefe]

(In reply to comment #3)
> Note that Mozilla does not officially release GTK2 builds...

I think this is not true anymore since Mozilla 1.8a5 (See
http://www.mozilla.org/releases).

Comment 8

[Stefan [:stefanh]]

(In reply to comment #7)
> (In reply to comment #3)
> > Note that Mozilla does not officially release GTK2 builds...
> 
> I think this is not true anymore since Mozilla 1.8a5 (See
> http://www.mozilla.org/releases).

You'll have to hide it for the mac, though

Comment 9

[Giacomo Magnini]

Attachment: Complete xhtml file, for easier review

Ok, this is a modified version with minor nits fixed, and the Advanced part
moved to a subparagraph.
I'll ask you all to be very precise on word changing, as I'm unsure about my
English... ;)
Three things:
1) is the h3 subparagraph ok?
2) should it be added to toc or index somewhere?
3) should we add an entry in glossary about WPAD protocol?

Comment 10

[Ian Neal]

(In reply to comment #9)
> Created an attachment (id=173378) [edit]
> Complete xhtml file, for easier review
> 
> Ok, this is a modified version with minor nits fixed, and the Advanced part
> moved to a subparagraph.
> I'll ask you all to be very precise on word changing, as I'm unsure about my
> English... ;)
> Three things:
> 1) is the h3 subparagraph ok?
> 2) should it be added to toc or index somewhere?
> 3) should we add an entry in glossary about WPAD protocol?
> 

1) Looks okay but it depends what we do elsewhere in help.
2) I'd say no to toc but yes to index.
3) It would be good if you could and link it in.

Other nits:
missing " from:
on <q>Advanced</q> to set <a href="#advanced_proxy_settings>advanced proxy
settings</a>

Change advanced proxy settings and Advanced proxy setting to Advanced Proxy
Preferences - the title of the dialog box that comes up (note Capital letters)

Comment 11

[Giacomo Magnini]

Attachment: Updated patch

Fixes all of the reported nits, cleans up more tabs, updates/fixes
help-glossary.rdf, and adds two entry to glossary.

Comment 12

[Giacomo Magnini]

Attachment: Umf, fogot to link WPAD to glossary... thanks to stefan_h for catching it

Comment 13

[Ian Neal]

Comment on attachment 173469 [details] [diff] [review]
Umf, fogot to link WPAD to glossary... thanks to stefan_h for catching it

Have you forgotten the actual wpad glossary entry now? I see no patch to
glossary.xhtml

Comment 14

[Giacomo Magnini]

Attachment: You don't want to hear me... appearance is there to fix the (c) line I forgot to update in another patch: I hope glossary is in this time (Checked in)

Comment 15

[Ian Neal]

Comment on attachment 173514 [details] [diff] [review]
You don't want to hear me... appearance is there to fix the (c) line I forgot to update in another patch: I hope glossary is in this time (Checked in)

Checking in cs_nav_prefs_advanced.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_advanced.x
html,v	<--  cs_nav_prefs_advanced.xhtml
new revision: 1.36; previous revision: 1.35
done
Checking in cs_nav_prefs_appearance.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_appearance
.xhtml,v  <--  cs_nav_prefs_appearance.xhtml
new revision: 1.25; previous revision: 1.24
done
Checking in help-glossary.rdf;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/help-glossary.rdf,v 
<--  help-glossary.rdf
new revision: 1.20; previous revision: 1.19
done
Checking in help-index1.rdf;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/help-index1.rdf,v  <-- 
help-index1.rdf
new revision: 1.42; previous revision: 1.41
done
Checking in glossary.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/glossary.xhtml,v  <-- 
glossary.xhtml
new revision: 1.38; previous revision: 1.37
done

Comment 16

[Stefan [:stefanh]]

--> Fixed

Comment 17

[Stefan Borggraefe]

Reopening. :-( The section "Setting Proxy Values"

http://lxr.mozilla.org/mozilla/source/extensions/help/resources/locale/en-US/nav_help.xhtml#1749

needs to be updated, too.

Also I think it would be nice if pressing on the Help button in the Advanced
dialog jumps directly to the subsection describing it
(http://lxr.mozilla.org/mozilla/source/extensions/help/resources/locale/en-US/cs_nav_prefs_advanced.xhtml#286).

Comment 18

[Giacomo Magnini]

*** Bug 281342 has been marked as a duplicate of this bug. ***

Comment 19

[Giacomo Magnini]

Attachment: As suggested here and in the other bug (which I closed as duplicate, since nobody agrees with me) (Checked in)

Comment 20

[Ian Neal]

Comment on attachment 174374 [details] [diff] [review]
As suggested here and in the other bug (which I closed as duplicate, since nobody agrees with me) (Checked in)

Reload button is mentioned but I think this is acceptable as it is mentioned in
the linked page.
r=me

Comment 21

[Giacomo Magnini]

If we want this for 1.8b1, please add a sr= and a= requests.
I'm not sure who to ping about this...
And if it get thumbs up, someone will need to check it in.

Comment 22

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

Comment on attachment 174374 [details] [diff] [review]
As suggested here and in the other bug (which I closed as duplicate, since nobody agrees with me) (Checked in)

too late for 1.8b1; please land on trunk (which is now open)

Comment 23

[Ian Neal]

Comment on attachment 174374 [details] [diff] [review]
As suggested here and in the other bug (which I closed as duplicate, since nobody agrees with me) (Checked in)

Checking in nav_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/nav_help.xhtml,v  <-- 
nav_help.xhtml
new revision: 1.50; previous revision: 1.49
done

Comment 24

[Stefan [:stefanh]]

 > Also I think it would be nice if pressing on the Help button in the Advanced
> dialog jumps directly to the subsection describing it
>
(http://lxr.mozilla.org/mozilla/source/extensions/help/resources/locale/en-US/cs_nav_prefs_advanced.xhtml#286).

Hmm, what about this?

Comment 25

[Giacomo Magnini]

(In reply to comment #24)
>  > Also I think it would be nice if pressing on the Help button in the Advanced
> > dialog jumps directly to the subsection describing it
> >
>
(http://lxr.mozilla.org/mozilla/source/extensions/help/resources/locale/en-US/cs_nav_prefs_advanced.xhtml#286).
> 
> Hmm, what about this?

AFAIK, you can't, because the advanced proxy settings is not in help-toc.rdf, so
you can't add an entry for it into help-prefs.js.
If anybody knows more, please enlight me! :)
Mark fixed?

Comment 26

[[e-mail]]

I think you can add an entry into help-toc.ds but not as descendant of the root
so that it will never appear, although you can still link to it. It's a bit like
having a web page that you only link to from another website. I'm guessing it
would probably say <rdf:Description ID="nav-prefs-proxy-advanced"
nc:link="cs_nav_prefs_advanced.html#advanced_proxy_preferences"/>

Comment 27

[Giacomo Magnini]

(In reply to comment #26)
> I think you can add an entry into help-toc.ds but not as descendant of the root
> so that it will never appear, although you can still link to it. It's a bit like
> having a web page that you only link to from another website. I'm guessing it
> would probably say <rdf:Description ID="nav-prefs-proxy-advanced"
> nc:link="cs_nav_prefs_advanced.html#advanced_proxy_preferences"/>

I knew I didn't esxpress myself correctly: the problem is that in pref-help.js
there is always a couple formed by a xul file and a link to the help. In this
case, I can't locate the advanced proxy preferences xul file... Sorry for the
bad explanation.

Comment 28

[u60234]

Since this bug is still open...

The Advanced Proxy Preferences dialog have a "SOCKS Proxy" field, but in
cs_nav_prefs_advanced.xhtml it is called "SOCKS Host".

Comment 29

[Stefan [:stefanh]]

Attachment: "SOCKS Host" --> "SOCKS Proxy" (Checked in)

> Since this bug is still open...
> 
> The Advanced Proxy Preferences dialog have a "SOCKS Proxy" field, but in
> cs_nav_prefs_advanced.xhtml it is called "SOCKS Host".

OK, this should fix the problem. Thanks Hasse!

Comment 30

[Ian Neal]

Comment on attachment 175744 [details] [diff] [review]
"SOCKS Host" --> "SOCKS Proxy" (Checked in)

Checking in cs_nav_prefs_advanced.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/cs_nav_prefs_advanced.x
html,v	<--  cs_nav_prefs_advanced.xhtml
new revision: 1.38; previous revision: 1.37
done

Comment 31

[Stefan [:stefanh]]

Attachment: Load advanced subsection when pressing help button

This will make the advanced proxy sub-section load when you hit the help button
(without adding any subheading in help-toc).

Comment 32

[Giacomo Magnini]

Does this work without modifying pref-help.js? Crazy, there are many different
ways to archive the same function: this doesn't help in clarifying things for
beginners (as I am)...

Comment 33

[Giacomo Magnini]

Attachment: Unbitrotted (Checked in)

Stefan patch unbitrotted, change of reviewer... ;)

Comment 34

[Stefan [:stefanh]]

Comment on attachment 183826 [details] [diff] [review]
Unbitrotted (Checked in)

Assuming second-review is the old "rs?"...

Comment 35

[Stefan [:stefanh]]

Comment on attachment 183826 [details] [diff] [review]
Unbitrotted (Checked in)

ah, wait. This is probably a better way.

Comment 36

[[e-mail]]

Comment on attachment 183826 [details] [diff] [review]
Unbitrotted (Checked in)

Whoops, I'd applied this on March 1st but forgotton since :-[

Comment 37

[Stefan [:stefanh]]

Comment on attachment 183826 [details] [diff] [review]
Unbitrotted (Checked in)

Low-risk patch for Seamonkey Help

Comment 38

[Asa Dotzler [:asa]]

Comment on attachment 183826 [details] [diff] [review]
Unbitrotted (Checked in)

a=asa for seamonkey only change.

Comment 39

[Ian Neal]

Comment on attachment 183826 [details] [diff] [review]
Unbitrotted (Checked in)

Checking in extensions/help/resources/locale/en-US/help-toc.rdf;
new revision: 1.78; previous revision: 1.77
Checking in
xpfe/components/prefwindow/resources/content/pref-proxies-advanced.xul;
pref-proxies-advanced.xul
new revision: 1.2; previous revision: 1.1
done