872000 - Document the new Private Browsing feature in Help

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[rsx11m]

This can probably go into the "Privacy on the Internet" section. There is a respective Firefox SUMO article that can be used for information:
> http://support.mozilla.org/en-US/kb/private-browsing-browse-web-without-saving-info

There don't seem to be any user-visible preferences for this feature. Also, in contrast to Firefox, it doesn't appear that browser windows are specifically marked (different icon, color, etc.), which may be a separate bug if desired.

Comment 1

[rsx11m]

I see, there is a "SeaMonkey Private Browsing" label in the title bar to indicate that the window is in this special status.

Comment 2

[rsx11m]

On a second thought, this may fit better into using_priv_help.xhtml within the context of "Private Information" given that it's directly related to that (also may simplify linking to the related sections).

I've opened bug 872521 for adding further visual cues to Private Browsing windows.

Comment 3

[rsx11m]

Note to myself for other relevant sources of documentation:
https://wiki.mozilla.org/User:Mconnor/PrivateBrowsing (concept page)
http://kb.mozillazine.org/Issues_related_to_Private_Browsing

Comment 4

[rsx11m]

Attachment: Proposed patch

This patch contains the new section "Browsing in a Private Window" along with a Glossary entry "private browsing" and should be mature enough for a review. I hope that the selected level of detail is fine and all statements made are factually correct.

Since the only way to recognize a private window right now is the title bar (bug 872521), I've added a screenshot of it so that it's clear. I had it in the Windows 7 Default desktop theme first, but it looked a bit odd among the other images which are Windows Classic and mostly show SeaMonkey's Modern theme. Thus, the current image shows the Windows Classic title bar (which is my default and personal preference anyway). If you want to modernize the screenshots, this should probably done for all images at the same time.

I went with <h3> headings to give it more structure. First I had <p>Topic:</p> before each bullet list, which would work as well, but then there is a fairly large monolithic block of black fonts in the window.

Documenting a feature you haven't used before is a good way to find bugs... ;-) I've run into bug 826865, bug 863913, bug 873024, bug 873032 (which was deemed invalid by Firefox, but lead to the "not entirely isolated" paragraph), and bug 873355 while testing this.

Comment 5

[rsx11m]

(correction, bug 873024 was the one closed by Firefox, not bug 873032.)

Comment 6

[rsx11m]

Comment on attachment 751240 [details] [diff] [review]
Proposed patch

>+++ b/suite/locales/en-US/chrome/common/help/using_priv_help.xhtml
>@@ -788,18 +792,184 @@
>+<h3>Cookies</h3>

>+  <li>A private window or a tab within that window doesn't share its cookies
>+    with any other window or tab. Thus, you&apos;ll have to stay within the
>+    same tab for any context-sensitive work (like web applications).</li>

I'm not sure if this statement is entirely accurate. Testing with the MozillaZine site and Gmail webmail, I can open links in a new tab without loosing the context. However, opening a new private window from a link requires a new login, and apparently also purges the cookies in the other private window (i.e., I have to login there again as well).

Stefan/Ratty, do you have any more information on that, or any suggestion how to phrase this more carefully?

Comment 7

[rsx11m]

FWIW, in Firefox 21.0 I see a different behavior: Using a web application which routinely opens new windows works fine in Firefox, but is loosing my credentials whenever a new window is opened by that web application in SeaMonkey.

Thinking that Firefox is doing it right (and running web applications like online banking would appear to be an attractive use case for private browsing, thus it shouldn't be restricted like that), this may be yet another bug in SeaMonkey.

This makes me also wonder if my understanding of a "private session" as being confined within each private window or even tab is correct; or if there is just a single private session starting with the first private window and ending when the last private window is closed, separating one private vs. one non-private space.

Comment 8

[Philip Chee]

>+  <li>A private window or a tab within that window doesn't share its cookies
>+    with any other window or tab. Thus, you&apos;ll have to stay within the
>+    same tab for any context-sensitive work (like web applications).</li>

"A private window does not share cookies with non private windows..."

The backend supports private tabs in a non private window. Indeed there is a extension called "Private Tab" that works in both Firefox and SeaMonkey. However out of the box SeaMonkey doesn't have any private tab functionality.

> This makes me also wonder if my understanding of a "private session" as being 
> confined within each private window or even tab is correct; or if there is just 
> a single private session starting with the first private window and ending when 
> the last private window is closed, separating one private vs. one non-private 
> space.
Good point. I don't know. Perhaps you can ask Neil.

Comment 9

[rsx11m]

(In reply to rsx11m from comment #6)
> I can open links in a new tab without loosing the context. However, opening
> a new private window from a link requires a new login, and apparently also
> purges the cookies in the other private window
(In reply to rsx11m from comment #7)
> FWIW, in Firefox 21.0 I see a different behavior: Using a web application
> which routinely opens new windows works fine in Firefox, but is loosing my
> credentials whenever a new window is opened by that web application in
> SeaMonkey.

I have opened bug 874042 on this issue, clearly something isn't working right here.

> (and running web applications like online banking would appear to be an
> attractive use case for private browsing,

Which reminds me that it may be a good idea to provide some information in the introductory paragraph why one would use private browsing in the first place.
 
(In reply to Philip Chee from comment #8)
> "A private window does not share cookies with non private windows..."

Maybe I'll move this as a general statement into the introductory paragraph, given that it applies to all private data.

> > This makes me also wonder if my understanding of a "private session" as being 
> > confined within each private window or even tab is correct; or if there is just 
> > a single private session starting with the first private window and ending when 
> > the last private window is closed, separating one private vs. one non-private 
> > space.
> Good point. I don't know. Perhaps you can ask Neil.

Looking at Firefox bug 864640, that's apparently how they've implemented it. Neil?

Comment 10

[[e-mail]]

I don't really know how private browsing works, apart from how to open a window as private or non-private. I did however notice that Persona doesn't work in a private window (it opens a popup window for its login dialog), so I guess that must be relevant.

Comment 11

[rsx11m]

Ok, guess I'll just go then with whatever Firefox seems to define in this regard (i.e., maintaining a single private context for cookies and authenticated session across all private windows, separate from that for non-private windows).

Comment 12

[rsx11m]

Attachment: Proposed patch (v2)

Changes relative to the initial version (all in the main text):

 - Added introductory paragraph with two common(?) use cases;
 - rephrased "private session" items in several instances;
 - clarified sharing of data private vs. non-private windows;
 - merged first two bullet points in the "Cookies" section.

I'm only requesting review from Stefan, but of course if anybody else sees any issues with a statement somewhere, please comment without being formally asked for feedback.

Comment 13

[Stefan [:stefanh]]

I'll try to get to this during the weekend (slow as usual).

Comment 14

[rsx11m]

Yeah, Sat/Sun is what I figured. I'll be around.

Comment 15

[Stefan [:stefanh]]

Comment on attachment 751734 [details] [diff] [review]
Proposed patch (v2)

Just skimmed the patch and had a look at the image. It will not be correct for Mac users. On mac, the window title looks like this:

Non-PB Mode: "My Web Site"
PB Mode: My Web site - Private Browsing

Do you think we need an image? I mean, we could add a mac image, but I'm not sure we need more than just the text.

Comment 16

[rsx11m]

As said, the difference is subtle, thus I tried to make it more obvious what to look for. I only have Windows and Linux to test, and it both shows the string as depicted in the image. I don't know why Mac differs from the others.

So yes, we can either not show the image for Mac, create a separate one for Mac (which someone would have to contribute), or drop the image completely.

In the end, your call. As said, I think that it might help.

Comment 17

[Stefan [:stefanh]]

(In reply to rsx11m from comment #16)
> I don't know why Mac differs from the
> others.

Because I removed the application name :-)
In general, Mac apps doesn't show the application name in the title bar. Presumably because there's no reason for it - Mac windows doesn't have any menubar attached, instead the window's menubar is attached to the top of the OS desktop and there's an application menu in that menubar (with the application name as a label).

Comment 18

[rsx11m]

Clearly, Mac is a different world... ;-)

Ok, so I can show the image only for class="noMac" which wouldn't be a problem. There are other instances as well where we show screenshots for some platforms only (e.g., the balloon new-mail notification, which is Windows-specific).

Comment 19

[Stefan [:stefanh]]

If we go for an image, we should show a mac-specific image as well. I'll think about it :-)

Comment 20

[rsx11m]

I could probably fake it, but coming from my machine it would be rather obvious. :-D

Comment 21

[Stefan [:stefanh]]

Comment on attachment 751734 [details] [diff] [review]
Proposed patch (v2)

This looks good. Comments are mostly related to how the different terms are used. Unfortunately, I have some build trouble atm so I haven't tested the patch yet :-(


>+<dt id="private_browsing">private browsing</dt><dd>A special mode of a
>+  browser window in which no private data (like browsing history,
>+  <a href="#cookie">cookies</a>, and <a href="#cache">cached</a> content)
>+  are retained beyond the duration of the private session. Private browsing
>+  should not be confused with anonymous browsing and does not prevent
>+  <a href="#user_tracking">user tracking</a> or monitoring of web activity
>+  by an internet provider or employer.</dd>

I read this more as an explanation of "private browsing mode". Wouldn't "private browsing" rather be something that refers to browsing in a private window? Also, you have almost the same text in using_priv_help.xhtml - wouldn't it be better to link to the glossary term in using_priv_help.xhtml?

.
.
.
 
>+<p>When <a href="#browsing_in_a_private_window">browsing in a private
>+  window</a>, no private data will be retained beyond the duration of the
>+  private session.</p>
>+

Possible risk that a user thinks that one private window equals to one private session?

.
.
.

>+<p>Private browsing is a special mode of a browser window in which no
>+  <a href="#types_of_private_data">private data</a> on the sites and pages you
>+  visited are made available beyond the scope and duration of that session.
>+  Private browsing should not be confused with anonymous browsing and does not
>+  prevent <a href="privacy_help.xhtml#why_and_how_are_websites_tracking_me">user
>+  tracking</a> or monitoring of web activity by a provider or employer.</p>

See earlier comment.
.
.
.

>+<h2 id="opening_a_private_browsing_window">Opening a Private Browsing
>+  Window</h2>
>+
>+<p>A specific browser window is either in regular or in Private Browsing mode.
>+  It is not possible to switch a regular (non-private) browser window into
>+  private mode, but you can open a new private window in two ways:</p>

Perhaps skip the "specific" and say "A browser window can be either in regular (non-private) or Private Browsing mode"


>+<ul>
>+  <li>From the menu bar: Select File, then New, then Private Window. The new

We never mentioned the menu bar before in help, so just go with something in line with "Open the File menu, choose New... etc" (possibly starting with  "From a browser window...)

>+    window opens with a page explaining that you are now in private mode.</li>
>+  <li>From a link in a web page: Right-click on the link, then select <q>Open
>+    Link in Private Window</q> from the menu. The new private window will
>+    open, showing the page referred to by the selected link.</li>
>+</ul>
>+
>+<p>Any number of private and non-private windows can be open at the same
>+  time, but be aware in this case for which windows history information is
>+  kept. A private session is opened with the first private window and ends
>+  when the last private window is closed. It is shared among all private
>+  windows that are active during that time.</p>

Here it's clear that no matter how many private windows we open, we only have one session. I'm a little bit concerned that this comes a bit late (see earlier comment)

 
>+<p>[<a href="#browsing_in_a_private_window">Return to beginning of
>+  section</a>]</p>
>+
>+<h2 id="differences_in_window_behavior">Differences in Window Behavior</h2>
>+
>+<p>A private window behaves differently than a non-private window in the way
>+  it handles private data (see <a href="#types_of_private_data">Types of
>+  Private Data</a> for detailed information of the individual categories).
>+  Specifically, after closing a private session, no information related to
>+  that session will be retained in &brandShortName;.</p>

Might be worth emphasizing somehow that the private session ends when you've closed the last private window?

.
.
.

>+
>+<h3>Recognizing a Private Window</h3>
>+
>+<p>To determine whether or not a window is in Private Browsing mode, have a
>+  look at its title bar. If this is a private window, it will say so at the
>+  end of the window&apos;s title:</p>
>+<table>
>+  <tr>
>+    <td rowspan="2" style="width: 20px;"></td>
>+    <td><img src="images/private_browsing_titlebar.png" alt=""/></td>
>+  </tr>
>+  <tr>
>+    <td><strong>Regular vs. Private Browsing Window</strong></td>
>+  </tr>
>+</table>

I think it's much better to just refer to that we append "Private Browsing" to the window title. If you really want to add images here you should at least wait until we settled the ui. I would, for instance, rather see us adding an icon in the title bar. If we do that, we wouldn't need screenshots of the title bar, we could just use the icon.

.
.
.

>+<h3>Histories</h3>

Hmm, a better title?

>+
>+<ul>
>+  <li>Navigating within a private window is identical to a non-private
>+    window. You can use the Back and Forward buttons as well as the Go

Comment 22

[rsx11m]

Attachment: Proposed patch (v3)

(In reply to Stefan [:stefanh] from comment #21)
> I read this more as an explanation of "private browsing mode". Wouldn't
> "private browsing" rather be something that refers to browsing in a private
> window?

Changed the wording to reflect the "browsing in a private window" context.

> Also, you have almost the same text in using_priv_help.xhtml - wouldn't it be
> better to link to the glossary term in using_priv_help.xhtml?

Done so, but I've lost the link to the user-tracking section (which probably wasn't needed here anyway in that detail, but I figured at the time that it was a related topic).

> Possible risk that a user thinks that one private window equals to one
> private session?

This is essentially just a forward reference to the detailed section, in which the terms are explained in more detail. Thus, I've shortened the wording here.

> Perhaps skip the "specific" and say "A browser window can be either in
> regular (non-private) or Private Browsing mode"

Done.

> We never mentioned the menu bar before in help, so just go with something in
> line with "Open the File menu, choose New... etc" (possibly starting with 
> "From a browser window...)

Changed that and also rephrased the following open-from-link section a little to match the style.

> Here it's clear that no matter how many private windows we open, we only
> have one session. I'm a little bit concerned that this comes a bit late (see
> earlier comment)

I've moved the explanation of private session and private window now upfront to the introductory paragraph.

> Might be worth emphasizing somehow that the private session ends when you've
> closed the last private window?

So done, and also added a sentence that private data gathered in a private session won't be available for another private session either.

> I think it's much better to just refer to that we append "Private Browsing"
> to the window title. If you really want to add images here you should at
> least wait until we settled the ui. I would, for instance, rather see us
> adding an icon in the title bar. If we do that, we wouldn't need screenshots
> of the title bar, we could just use the icon.

Ok, removed the picture and related jar.mn changes. You'll see a different wording on a Mac, only explaining "- Private Browsing" whereas noMac wording is more detailed saying "- SeaMonkey Private Browsing" rather than "- SeaMonkey" thus it's hopefully still sufficiently clear what to look for.

> >+<h3>Histories</h3>
> Hmm, a better title?

Made it "Navigation and Browsing Histories" instead.

Comment 23

[Stefan [:stefanh]]

Comment on attachment 754246 [details] [diff] [review]
Proposed patch (v3)

># HG changeset patch
># Parent 04529679ec104e17704a68fdf6fb560c3bebf44e
># User rsx11m <[e-mail]>
># Date 1368824436 18000
>Bug 872000 - Document the new Private Browsing feature in Help
>
>
>diff --git a/suite/common/aboutPrivateBrowsing.xul b/suite/common/aboutPrivateBrowsing.xul
>--- a/suite/common/aboutPrivateBrowsing.xul
>+++ b/suite/common/aboutPrivateBrowsing.xul
>@@ -37,17 +37,16 @@
>     <label id="warningTitle">&privatebrowsingpage.experimental;</label>
>     <vbox id="warningInnerBox" align="start">
>       <vbox id="warningText">
>         <description>&privatebrowsingpage.description;</description>
>         <description>&privatebrowsingpage.moreinfo;</description>
>       </vbox>
>       <button label="&privatebrowsingpage.learnmore.label;"
>               accesskey="&privatebrowsingpage.learnmore.accesskey;"
>-              disabled="true"
>               oncommand="openHelp('private-browsing', 'chrome://communicator/locale/help/suitehelp.rdf');"/>
>       <vbox id="private" align="start">
>         <description>&privatebrowsingpage.private;</description>
>         <button label="&privatebrowsingpage.switch.label;"
>                 accesskey="&privatebrowsingpage.switch.accesskey;"
>                 oncommand="toNavigator();"/>
>       </vbox>
>       <vbox id="normal" align="start">
>diff --git a/suite/locales/en-US/chrome/common/help/glossary.xhtml b/suite/locales/en-US/chrome/common/help/glossary.xhtml
>--- a/suite/locales/en-US/chrome/common/help/glossary.xhtml
>+++ b/suite/locales/en-US/chrome/common/help/glossary.xhtml
>@@ -536,16 +536,23 @@
>   that requires you to download new messages to your local
>   computer&mdash;although you can choose to leave copies on the server. With
>   POP, you can store all your messages, including sent mail, drafts, and custom
>   folders, on one computer only. By contrast,
>   <a href="#imap">IMAP</a> allows you to permanently store all your messages
>   and any changes to them on the server, where you can access them from any
>   computer. Most <a href="#isp">ISPs</a> currently support POP.</dd>
> 
>+<dt id="private_browsing">private browsing</dt><dd>When browsing in a private
>+  window, no private data (like browsing history, <a href="#cookie">cookies</a>,
>+  and <a href="#cache">cached</a> content) are retained beyond the duration of
>+  the private session. Private browsing should not be confused with anonymous
>+  browsing and does not prevent <a href="#user_tracking">user tracking</a> or
>+  monitoring of web activity by an internet provider or employer.</dd>
>+

The first sentence is (at least for me) a bit confusing since you don't directly refer to "private browsing". See further down for what I think you should start with. Perhaps we shouldn't mention the private window here and only describe private browsing? Then you could mention that opening a private window starts a private browsing session in the text further down (see there)?

> <dt id="private_key">private key</dt><dd>One of a pair of
>   <a href="#key">keys</a> used in public-key cryptography. The private key is
>   kept secret and is used to decrypt data that has been encrypted with the
>   corresponding public key.</dd>
> 
> <dt id="proxy">proxy</dt><dd>An intermediary or <q>go-between</q> program that
>   acts as both a <a href="#server">server</a> and a
>   <a href="#client">client</a> for the purpose of making requests on behalf of
>diff --git a/suite/locales/en-US/chrome/common/help/help-glossary.rdf b/suite/locales/en-US/chrome/common/help/help-glossary.rdf
>--- a/suite/locales/en-US/chrome/common/help/help-glossary.rdf
>+++ b/suite/locales/en-US/chrome/common/help/help-glossary.rdf
>@@ -87,16 +87,17 @@
>         <rdf:li> <rdf:Description nc:name="Password Manager" nc:link="glossary.xhtml#password_manager"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="Personal Toolbar" nc:link="glossary.xhtml#personal_toolbar"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="phishing" nc:link="glossary.xhtml#phishing"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="PKCS #11" nc:link="glossary.xhtml#pkcs_11"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="PKCS #11 module" nc:link="glossary.xhtml#pkcs_11_module"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="PKI" nc:link="glossary.xhtml#pki"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="plugin" nc:link="glossary.xhtml#plugin"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="POP" nc:link="glossary.xhtml#pop"/> </rdf:li>
>+        <rdf:li> <rdf:Description nc:name="private browsing" nc:link="glossary.xhtml#private_browsing"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="private key" nc:link="glossary.xhtml#private_key"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="proxy" nc:link="glossary.xhtml#proxy"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="public key" nc:link="glossary.xhtml#public_key"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="public-key cryptography" nc:link="glossary.xhtml#public-key_cryptography"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="root CA" nc:link="glossary.xhtml#root_ca"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="RSS" nc:link="glossary.xhtml#rss"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="safe browsing" nc:link="glossary.xhtml#safe_browsing"/> </rdf:li>
>         <rdf:li> <rdf:Description nc:name="search engine" nc:link="glossary.xhtml#search_engine"/> </rdf:li>
>diff --git a/suite/locales/en-US/chrome/common/help/shortcuts_navigator.xhtml b/suite/locales/en-US/chrome/common/help/shortcuts_navigator.xhtml
>--- a/suite/locales/en-US/chrome/common/help/shortcuts_navigator.xhtml
>+++ b/suite/locales/en-US/chrome/common/help/shortcuts_navigator.xhtml
>@@ -209,16 +209,22 @@
>   </tr>
>   <tr>
>     <td>New Browser Window</td>
>     <td>Ctrl+N</td>
>     <td>Cmd+N</td>
>     <td>Ctrl+N</td>
>   </tr>
>   <tr>
>+    <td>New Private Window</td>
>+    <td>Ctrl+Shift+P</td>
>+    <td>Cmd+Shift+P</td>
>+    <td>Ctrl+Shift+P</td>
>+  </tr>
>+  <tr>
>     <td>Move to Next/Previous Link or Form Element in a Web Page</td>
>     <td>Tab/Shift+Tab</td>
>     <td>Tab/Shift+Tab</td>
>     <td>Tab/Shift+Tab</td>
>   </tr>
>   <tr>
>     <td>Open File</td>
>     <td>Ctrl+O</td>
>diff --git a/suite/locales/en-US/chrome/common/help/suite-toc.rdf b/suite/locales/en-US/chrome/common/help/suite-toc.rdf
>--- a/suite/locales/en-US/chrome/common/help/suite-toc.rdf
>+++ b/suite/locales/en-US/chrome/common/help/suite-toc.rdf
>@@ -827,16 +827,17 @@
> <!-- USING PRIVACY FEATURES CONTENT -->
> <rdf:Description about="#using-priv-help">
>     <nc:subheadings>
>       <rdf:Seq>
>         <rdf:li><rdf:Description ID="privacy-doc" nc:name="Privacy on the Internet" nc:link="privacy_help.xhtml#privacy_on_the_internet"/> </rdf:li>
>         <rdf:li><rdf:Description ID="using-priv-help-cookies" nc:name="Using the Cookie Manager" nc:link="using_priv_help.xhtml#using_the_cookie_manager"/> </rdf:li>
>         <rdf:li><rdf:Description ID="using-priv-help-password" nc:name="Using the Password Manager" nc:link="using_priv_help.xhtml#using_the_password_manager"/> </rdf:li>
>         <rdf:li><rdf:Description ID="using-priv-help-private-data" nc:name="Clearing Private Data" nc:link="using_priv_help.xhtml#clearing_private_data"/> </rdf:li>
>+        <rdf:li><rdf:Description ID="private-browsing" nc:name="Browsing in a Private Window" nc:link="using_priv_help.xhtml#browsing_in_a_private_window"/> </rdf:li>
>         <rdf:li><rdf:Description ID="using-priv-help-encrypt" nc:name="Encrypting Stored Sensitive Information" nc:link="using_priv_help.xhtml#encrypting_stored_sensitive_information"/> </rdf:li>
>         <rdf:li><rdf:Description ID="images-help-managing" nc:name="Managing Images" nc:link="using_priv_help.xhtml#managing_images"/> </rdf:li>
>         <rdf:li><rdf:Description ID="pop_up_blocking" nc:name="Controlling Popups" nc:link="cs_priv_prefs_popup.xhtml"/> </rdf:li>
>         <rdf:li><rdf:Description ID="sec_gen" nc:name="Privacy &amp; Security Preferences" nc:link="privsec_help.xhtml"/> </rdf:li>
>       </rdf:Seq>
>     </nc:subheadings>
>   </rdf:Description>
> 
>@@ -905,16 +906,26 @@
>       <rdf:Seq>
>         <rdf:li><rdf:Description ID="types_of_private_data" nc:name="Types of Private Data" nc:link="using_priv_help.xhtml#types_of_private_data"/> </rdf:li>
>         <rdf:li><rdf:Description ID="privatedata_prefs" nc:name="Private Data Preferences" nc:link="using_priv_help.xhtml#private_data_prefs"/> </rdf:li>
>         <rdf:li><rdf:Description ID="clear_private_data_now" nc:name="Clear Private Data Now" nc:link="using_priv_help.xhtml#clear_private_data_now"/> </rdf:li>
>       </rdf:Seq>
>     </nc:subheadings>
>   </rdf:Description>
> 
>+<rdf:Description about="#private-browsing">
>+    <nc:subheadings>
>+      <rdf:Seq>
>+        <rdf:li><rdf:Description ID="opening_a_private_browsing_window" nc:name="Opening a Private Browsing Window" nc:link="using_priv_help.xhtml#opening_a_private_browsing_window"/> </rdf:li>
>+        <rdf:li><rdf:Description ID="differences_in_window_behavior" nc:name="Differences in Window Behavior" nc:link="using_priv_help.xhtml#differences_in_window_behavior"/> </rdf:li>
>+        <rdf:li><rdf:Description ID="leaving_the_private_browsing_mode" nc:name="Leaving the Private Browsing Mode" nc:link="using_priv_help.xhtml#leaving_the_private_browsing_mode"/> </rdf:li>
>+      </rdf:Seq>
>+    </nc:subheadings>
>+  </rdf:Description>
>+
> <rdf:Description about="#using-priv-help-encrypt">
>     <nc:subheadings>
>       <rdf:Seq>
>         <rdf:li><rdf:Description ID="using-priv-help-encrypt-master" nc:name="Setting a Master Password" nc:link="using_priv_help.xhtml#setting_a_master_password"/> </rdf:li>
>         <rdf:li><rdf:Description ID="using-priv-help-encrypt-change" nc:name="Changing Your Master Password" nc:link="using_priv_help.xhtml#changing_your_master_password"/> </rdf:li>
>         <rdf:li><rdf:Description ID="using-priv-help-encrypt-logout" nc:name="Logging Out of Your Master Password" nc:link="using_priv_help.xhtml#logging_out_of_your_master_password"/> </rdf:li>
>         <rdf:li><rdf:Description ID="using-priv-help-encrypt-forget" nc:name="What to Do If You Forget Your Master Password" nc:link="using_priv_help.xhtml#what_to_do_if_you_forget_your_master_password"/> </rdf:li>
>       </rdf:Seq>
>diff --git a/suite/locales/en-US/chrome/common/help/using_priv_help.xhtml b/suite/locales/en-US/chrome/common/help/using_priv_help.xhtml
>--- a/suite/locales/en-US/chrome/common/help/using_priv_help.xhtml
>+++ b/suite/locales/en-US/chrome/common/help/using_priv_help.xhtml
>@@ -613,16 +613,19 @@
>   function properly or more efficiently, others are for your convenience.</p>
> 
> <p>Privacy implications vary from type to type. For example, browsing history
>   and cache contents provide a snapshot of your recent browsing activity which
>   is local to your computer; cookies or offline web content may be used by a
>   website to track a user directly across visits (e.g., for statistical
>   purposes or for targeted advertisements).</p>
> 
>+<p>In <a href="#browsing_in_a_private_window">private browsing</a>, no private

Should we say "private browsing mode" here?

>+  data will be retained beyond the duration of the private session.</p>
>+
> <p>The following private information may be stored locally by
>   &brandShortName;:</p>
> 
> <table class="defaultTable">
>   <thead>
>     <tr>
>       <th>Type</th>
>       <th>Explanation</th>
>@@ -788,18 +791,180 @@
>     </ul>
>   </li>
>   <li>When <q>Ask me before clearing private data</q> is <em>not</em> checked,
>     all types selected in the <a href="#private_data_prefs">Private Data
>     preferences</a> to be cleared by default will be deleted immediately
>     without the dialog box being shown.</li>
> </ul>
> 
>+<p>[<a href="#clearing_private_data">Return to beginning of section</a>]</p>
> 
>-<p>[<a href="#clearing_private_data">Return to beginning of section</a>]</p>
>+<h1 id="browsing_in_a_private_window">Browsing in a Private Window</h1>
>+
>+<p>There may be occasions where you don&apos;t want &brandShortName; to keep
>+  track of your browsing activities. For example, when someone else quickly
>+  wants to use your computer and you don&apos;t want your current browsing
>+  context disturbed; or, for confidential tasks such as online banking.</p>

Suggestion: It might be good to mention the private window here. Maybe something like "Opening a private window will...", "In a private window, ...".

>+<p><a href="glossary.xhtml#private_browsing">Private browsing</a> refers to
>+  browsing in a session in which no <a href="#types_of_private_data">private
>+  data</a> on the sites and pages you visited are made available beyond the
>+  scope and duration of that session. A private session begins when opening the
>+  first private window and ends when the last private window is closed. It is
>+  shared among all private windows that are active during that time.</p>

I think the beginning is perfect to have in the glossary :-) If you like my suggestion above we could go on saying "starts a "private browsing session in which..."


Looking at the headings in general, I think we should either change some of the names or move content around a bit:

Browsing in a Private Window (I like this, but is it a bit too specific?)
  Opening a Private Browsing Window (could be renamed to Opening a Private Window)
  Differences in Window Behavior (While the intro tell us about the differences, the sub-headings and their content doesn't)
    Recognizing a Private Window
    Navigation and Browsing Histories (contains more than what you expect, like Bookmarks etc)
    Cookies
    Cached and Offline Content
    Passwords and Authenticated Sessions
    Preferences and Permissions
  Leaving the Private Browsing Mode

Comment 24

[Stefan [:stefanh]]

Btw, I seem to have some (general) issues with the links. When I hit the "Learn more" button I only get the top of the help page. I see this also with, for example, clicking a glossary link. This is not related to your patch and I assume it works for you?

Comment 25

[rsx11m]

Attachment: Proposed patch (v4)

(In reply to Stefan [:stefanh] from comment #23)
> The first sentence is (at least for me) a bit confusing since you don't
> directly refer to "private browsing". See further down for what I think you
> should start with. Perhaps we shouldn't mention the private window here and
> only describe private browsing?

Initial sentence changed, it is now referring to the "session" rather than a "window" which is the term used a bit further down as well.

> Should we say "private browsing mode" here?

Done - sounds better, and we have a "Leaving the Private Browsing Mode" later.

> Suggestion: It might be good to mention the private window here. Maybe
> something like "Opening a private window will...", "In a private window, ...".
> I think the beginning is perfect to have in the glossary :-) If you like my
> suggestion above we could go on saying "starts a "private browsing session
> in which..."

Changed to "Opening a private window..." but then I also had to change the last two sentences of that paragraph a bit, talking now about "subsequently opened" windows and when the "private session ends" (given that the context is now that we are already in that private session as we've opened the first window).

> Looking at the headings in general, I think we should either change some of
> the names or move content around a bit:
> 
> Browsing in a Private Window (I like this, but is it a bit too specific?)

If you look at the other headings in the "Using Privacy Features" page, they all describe activities (i.e., ending in "-ing"), thus using "Private Browsing" here wouldn't quite fit (and also would be ambiguous relative to the glossary title). I've kept this heading as is.

>   Opening a Private Browsing Window (could be renamed to Opening a Private Window)

Done.

>   Differences in Window Behavior (While the intro tell us about the
> differences, the sub-headings and their content doesn't)

Got rid of the "Differences" by making it "Behavior of a Private Window."

>     Navigation and Browsing Histories (contains more than what you expect,
> like Bookmarks etc)

I've split that up into "Navigation and Bookmarks" (which also contains the bullet item on "visited links" given that it's an immediate effect while browsing, though technically it would be more related to the history) and then "Browsing and other Histories" catching the rest.

(In reply to Stefan [:stefanh] from comment #24)
> Btw, I seem to have some (general) issues with the links. When I hit the
> "Learn more" button I only get the top of the help page. I see this also
> with, for example, clicking a glossary link. This is not related to your
> patch and I assume it works for you?

No problems on either Windows or Linux, but those builds aren't updated to the current tip. Thus, it may be either specific to Mac OSX or a recent regression.

Comment 26

[rsx11m]

Attachment: Proposed patch (v5)

(In reply to rsx11m from comment #25)
> If you look at the other headings in the "Using Privacy Features" page, they
> all describe activities (i.e., ending in "-ing"), ...

I've just noticed that I've missed something. The table of contents for the using_priv_help.xhtml topics is actually kept in privacy_help.xhtml and thus needs to be updated as well. I've missed that in bug 416234 already, thus I'm adding a link for the "Clearing Private Data" section here as well.

No other changes relative to attachment 757048 [details] [diff] [review].

Comment 27

[rsx11m]

Attachment: Proposed patch (v6)

And of course I managed to introduce a typo, so here comes yet another patch...

Comment 28

[Stefan [:stefanh]]

Comment on attachment 757067 [details] [diff] [review]
Proposed patch (v6)

Nice work - thanks!

Comment 29

[Stefan [:stefanh]]

http://hg.mozilla.org/comm-central/rev/170e76bf0acb

Comment 30

[Ian Neal]

Now that the command key has been set to B rather than P the shortcuts_navigator.xhtml needs to be fixed (bug 891081)

Comment 31

[Ian Neal]

Comment on attachment 757067 [details] [diff] [review]
Proposed patch (v6)

>+++ b/suite/locales/en-US/chrome/common/help/using_priv_help.xhtml

>+<h3>Browsing and other Histories</h3>
>+
>+<ul>
>+  <li>Previously established Browsing History and Location Bar History will
>+    be available to a private window, but new sites visited and locations
>+    entered into the location bar will not be recorded and saved.</li>
>+  <li>Files can be downloaded as usual, but no entries will be added to the
>+    Download Manager. The downloaded files themselves will not be removed.</li>
>+  <li>Saved Form and Search History will be available to a private window,
>+    thus providing suggestions for from fields or searches. However, any
Should this be "form" instead of "from"?

Comment 32

[rsx11m]

Oops, thanks for catching the typo. I've filed bug 897233 for both issues.