253070 - Help Doc on "Web Features" needs to be updated

Status: RESOLVED FIXED

(Firefox Graveyard :: Help Documentation, defect)

Description

[Steffen Wilberg]

The "Web Features" window has been completely reworked. "Block Popup Windows"
now has an "Exceptions" button which opens a dialog where you can enter sites
and whitelist them using the "Allow" button.

There's also a new option to "Allow web sites to install software" (moved from
Options->Advanced).

Note that I suggested to rename some of the buttons to "Allowed Sites...", see
bug 250543.

Comment 1

[R.J. Keller]

djst: Your prefs documentation is out of date. Do you have a recent version, or
would you like me to write the fix?

Comment 2

[Sean Umphlet (nosebleed)]

OK, I'm taking this bug. It also appears that the "Load Images" has an
exceptions dialog that lets you block or allow images from sites. I'll change
the relative documentation for that as well.

Comment 3

[Sean Umphlet (nosebleed)]

Attachment: Updates I made to prefs.xhtml

These are the updates I made. I think the only problem is the screenshots need
to be updated, however R.J. says they're the same on an aviary build he got
just today... yet on linux, on an aviary build from today, I get a web options
dialog similar to the one steffen mentioned above.

Comment 4

[R.J. Keller]

nosebleed: Can you make these in a diff (cvs diff -u -w > patchFile)?

Comment 5

[Sean Umphlet (nosebleed)]

Attachment: Diff file for prefs.xhtml

OK, I'm kinda new to making patches... I hope this one was done correctly... :)

Comment 6

[R.J. Keller]

Comment on attachment 154416 [details] [diff] [review]
Diff file for prefs.xhtml

> -    to open popups anyway. To add a site to the whitelist, click <em>Add
> -    Site...</em>.</p>
> +    to open popups anyway. To add a site to the whitelist, click <em>Exceptions</em>,
> +    then enter the site you want to allow popups from and click <em>Allow</em>.</p>

According to the Help Coding Style Guide
(http://www.mozilla.org/projects/help-viewer/documentation_coding-style.php),
you are only permitted to have 80 characters a line. You are over this limit.
Not a big deal, just something to remember.

I know that the help docs aren't in 100% compliance with this guide, but I'd
like them to be. I'll fix this when I checkin the patch.

> +    <p>Depending on if you enable images, you can change which sites are blocked 
> +    or which sites can load images by clicking <em>Exceptions</em>. Enter the
> +    site you want to allow/deny images from and click <em>Allow</em> to allow images,
> +    or click <em>Block</em> to block the images. Click <em>OK</em> to confirm your changes,

Same nit here.

Thanks a lot for this patch Sean!

Comment 7

[R.J. Keller]

Fix checked in.

Comment 8

[Sean Umphlet (nosebleed)]

Ah, I totally forgot about that limit... I'll be sure to remember it next time
or set up my editor to be restricted to 80 characters. Thanks for accepting the
patch :)

Comment 9

[Steffen Wilberg]

Attachment: screenshot of the Web Features options panel

This is what the dialog looks like, with the patch in bug 250543 (which is
neither reviewed nor checked in yet) applied.

The Help Doc on "Allow web sites to install software" doesn't mention the
"Exceptions"/"Allowed Sites" button yet. Clicking the button opens a dialog
just like the popup blocker, where you can whitelist sites.

The part on "Load Images" needs to be moved above "Enable Java".

Comment 10

[Steffen Wilberg]

Reopening.

Comment 11

[Steffen Wilberg]

I just checked in a fix to move the part on Load Images upwards.

We still need a desciption for the Exceptions button on "Allow web sites to
install software".

Comment 12

[Sean Umphlet (nosebleed)]

I'll go ahead and add a description... what I don't understand is how I got that
dialog for Web Features if it hadn't even been checked in yet.

Comment 13

[Steffen Wilberg]

The dialog is in, bug 250543 only renames some buttons from "Exceptions" to
"Allowed Sites...". You can ignore that for now, I'll make the necessary
adjustment as soon as bug 250543 is checked in.

Comment 14

[Sean Umphlet (nosebleed)]

Attachment: Patch, adds exceptions help info to software install section

This patchfile should add the information for the exceptions dialog for "Allow
websites to install software"

Comment 15

[Sean Umphlet (nosebleed)]

Comment on attachment 154458 [details] [diff] [review]
Patch, adds exceptions help info to software install section

>? patchFile
>Index: prefs.xhtml
>===================================================================
>RCS file: /cvsroot/mozilla/browser/components/help/locale/en-US/prefs.xhtml,v
>retrieving revision 1.1.4.1.2.7
>diff -u -w -r1.1.4.1.2.7 prefs.xhtml
>--- prefs.xhtml	27 Jul 2004 10:24:19 -0000	1.1.4.1.2.7
>+++ prefs.xhtml	27 Jul 2004 15:01:01 -0000
>@@ -274,6 +274,12 @@
>     and plug-ins. You will be prompted to confirm each installation. Uncheck
>     this option to completely disable software installation.</p>
> 
>+  <p>Some sites have useful software to install into firefox. Like the 
>+    popup blocker, firefox has a simple whitelist mechanism to allow 
>+    certain sites to install software anyway. To add a site to the
>+    whitelist, click <em>Exceptions</em>, then enter the site you want to allow
>+    software installs from and click <em>Allow</em>.</p>
>+
>   <p><em>Load Images</em><br/>By default images are loaded on Web pages.
>     Uncheck this option to disable images completely.</p>
>

Comment 16

[Steffen Wilberg]

What do you mean by "anyway"?
You should point out that software installs are not possible at all from sites
which are not whitelisted (which is why I want to rename the button to "Allowed
Sites" by the way), and that even for those which are whitelisted, the user will
be prompted to confirm each installation.

Write Firefox with a capital F, please.

Comment 17

[Sean Umphlet (nosebleed)]

Attachment: Patch, adds exceptions help info to software install section (updated)

OK, these changes have been made. Anything else that needs to be changed or
added?

Comment 18

[Steffen Wilberg]

Almost done! My final nits are:
- There's still one "firefox" in there :)
- I'd prefer to have the part in the () brackets as a separate sentence. Also
add an "and" before "you".

Comment 19

[Sean Umphlet (nosebleed)]

Attachment: Patch, adds exceptions help info to software install section (updated)

Comment 20

[R.J. Keller]

Comment on attachment 154467 [details] [diff] [review]
Patch, adds exceptions help info to software install section (updated)

Looks good to me. r=[e-mail]. I don't have access to a machine with CVS
at the moment, but once I do, I'll check this in.

Comment 21

[R.J. Keller]

Fix checked in.

Comment 22

[Jeff Walden (gone starting June 8)]

(In reply to comment #15)
> >+  <p>Some sites have useful software to install into firefox. Like the 
> >+    popup blocker, firefox has a simple whitelist mechanism to allow 

A nitpick to fix if so desired: use &brandShortName; instead of Firefox.

Comment 23

[R.J. Keller]

(In reply to comment #22)
> (In reply to comment #15)
> > >+  <p>Some sites have useful software to install into firefox. Like the 
> > >+    popup blocker, firefox has a simple whitelist mechanism to allow 
> 
> A nitpick to fix if so desired: use &brandShortName; instead of Firefox.

Jeff, I think you're looking at an older patch, because it uses &brandShortName;
in the newer version.