298758 - Improve File->Exit doc, add Go->History doc

Status: RESOLVED FIXED

(Firefox Graveyard :: Help Documentation, defect)

Description

[Hendrik Maryns]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.1; nl-NL; rv:1.7.8) Gecko/20050511 Firefox/1.0.4
Build Identifier: Mozilla/5.0 (Windows; U; Windows NT 5.1; nl-NL; rv:1.7.8) Gecko/20050511 Firefox/1.0.4

In the menu reference, there is one menu item not documented, namely, the
History link under Go.  It is documented under View -> Sidebar -> History.

Also, the explanation under Quit/Exit is a bit nonsensical: it says `whenever a
window is open': There always is a window open, otherwise one couldn't select
this menu...

Also, the warning is issued by default, but shouldn't this be mentioned? 
Otherwise, people might read this and use Quit/Exit, thinking they could rely on
the warning, but it quits anyway.  The warning message which makes it possible
to switch this off, only speaks about open tabs, not about download or other
windows.

Reproducible: Always

Comment 1

[Peter van der Woude [:Peter6]]

Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.8b2) Gecko/20050625
Firefox/1.0+ ID:2005062508 (Deer Park Preview)

Go
-------------------------------------------------------------------------------
The Go menu contains a list of the most recently visited web sites.



Exit/Quit
-------------------------------------------------------------------------------
Closes all opened windows in Deer Park, including any active downloads,
    and exits Deer Park completely. If you happen to select this menu item with
    open tabs, windows, or downloads, Deer Park will ask you to confirm your
    choice to prevent accidental exits.

Seem to cover what you are talking about

I just filed Bug 298802 and Bug 298803 for Exit issues

Comment 2

[Hendrik Maryns]

(In reply to comment #1)
> Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.8b2) Gecko/20050625
> Firefox/1.0+ ID:2005062508 (Deer Park Preview)
> 
> Go
> -------------------------------------------------------------------------------
> The Go menu contains a list of the most recently visited web sites.

It does, but apart from that, it also has a separator line and History under it.
 I think this should be mentioned here too.  Even if it only were a reference to
the same menu item which is discussed a few paragraphs before.

> Exit/Quit
> -------------------------------------------------------------------------------
> Closes all opened windows in Deer Park, including any active downloads,
>     and exits Deer Park completely. If you happen to select this menu item with
>     open tabs, windows, or downloads, Deer Park will ask you to confirm your
>     choice to prevent accidental exits.
> 
> Seem to cover what you are talking about
> 
> I just filed Bug 298802 and Bug 298803 for Exit issues

`If you happen to select this menu item with open (tabs or) windows...' is
nonsense: how could you select this if you had NO window open??

And still I think a little more infofmation about the warning message would be
convenient.

Comment 3

[Peter van der Woude [:Peter6]]

> `If you happen to select this menu item with open (tabs or) windows...' is
> nonsense: how could you select this if you had NO window open??

No it isn't.
If you have multiple windows or multiple tabs or are downloading you'll get the
warning.
If you have 1 window with a single tab it just exits, in all other cases it warns.

Comment 4

[Hendrik Maryns]

(In reply to comment #3)
> > `If you happen to select this menu item with open (tabs or) windows...' is
> > nonsense: how could you select this if you had NO window open??
> 
> No it isn't.
> If you have multiple windows or multiple tabs or are downloading you'll get the
> warning.
> If you have 1 window with a single tab it just exits, in all other cases it warns.

Of course, I understand what it does, that is not the problem, I just think this
explanation does not say what it should.  In trying to be concise, too much
information is left out.  Just compare your last sentence with what is in the
help file.  But if you *really* don't want to change it, fine for me, I will
never need this help file, nor will I ever select File -> Exit.  Get my point?

Comment 5

[Peter van der Woude [:Peter6]]

I do, changing is not up to me though.

Comment 6

[Steffen Wilberg]

I agree that we can do better here. Something like "Closes all Firefox windows,
cancels all active downloads, and exits &brandShortName; completely." Blah blah
warning. You can switch off the warning in Tools > Options > blah blah.

Comment 7

[Hendrik Maryns]

(In reply to comment #6)
> I agree that we can do better here. Something like "Closes all Firefox windows,
> cancels all active downloads, and exits &brandShortName; completely." Blah blah
> warning. You can switch off the warning in Tools > Options > blah blah.

That's exactly what I had in mind, but I'd like someone more familiar with the
internals and the English language to do the rewording, hence my criticism.

Comment 8

[Steffen Wilberg]

Attachment: patch

I've renamed the IDs for the bookmarks and history sidebar to avoid conflicts
with the new Go->History item. I've also added a couple of <em> tags.

Comment 9

[Hendrik Maryns]

(In reply to comment #8)
> Created an attachment (id=188108) [edit]
> patch
> 
> I've renamed the IDs for the bookmarks and history sidebar to avoid conflicts
> with the new Go->History item. I've also added a couple of <em> tags.

My starting issue, that the text is a bit paradoxical still remains... 

I suggest ``If you happen to select this menu item with more than one open tab,
window, or downloads, ...'' Or something like that.

Otherwise very nice, I'll have some catching up to do for the dutch version (as
will probably all localisers... Is there an automatical warning scheme possible,
except for Bonsai?).

Comment 10

[Steffen Wilberg]

Attachment: patch v1.1

Comment addressed. And you can't turn off the "active download" warning, just
the "multiple tab" warning.

There's no "automatically warning scheme". You can query for specific files,
directories and dates in bonsai, see
http://wiki.mozilla.org/Firefox:1.1_Localization. After the MOZILLA_1_8_BRANCH
is cut, all string changes including help docs will be announced in the l10n
newsgroup and suchs bugs will carry the late-l10n keyword.

Of course you can watch [e-mail] (bugzilla
footer->prefs->email settings->users to watch) if you want to read all about
Firefox Help Documentation bugs. That's the same as being cc'ed on every bug in
that component.

Comment 11

[Jeff Walden (gone starting June 8)]

Comment on attachment 188114 [details] [diff] [review]
patch v1.1

>+    <p>Closes all Firefox windows, cancels any active downloads, and exits

&brandShortName;

>+      &brandShortName; completely. If you happen to select this menu item with
>+      more than one tab or window open, or any active downloads,

The ", or any active downloads" part is grammatically wrong in some way that I
can't name.  If you remove the comma and insert the word "with" before "any
active downloads", you'll fix the problem.

Make sure to make the above changes in both locations of "quitting"
documentation here.

Comment 12

[Steffen Wilberg]

That's not what I meant. There's a "you have multiple tabs open" warning, and
there's a "you are downloading" warning. You can switch off the former in the
Tabs panel.

How about "If you happen to select this menu item with more than one tab or
window open, *or you are currently downloading*, &brandShortName; will ask you
to confirm your choice to prevent accidental exits."?

Comment 13

[Steffen Wilberg]

Attachment: patch v1.2

Even better: two sentences for two separate warnings.

Comment 14

[Jeff Walden (gone starting June 8)]

Comment on attachment 188239 [details] [diff] [review]
patch v1.2

>+      the <em>Tabs</em> panel of &pref.menuPath;. &brandShortName; will also
>+      warn you if you are currently downloading.</p>

This makes it sound more than a little like the user himself is being
downloaded.  Please add "any files" in at the end of that sentence, and the
problem is then resolved.

Comment 15

[Steffen Wilberg]

Checked in with comment 14 addressed (both places).

Checking in mozilla/browser/locales/en-US/chrome/help/menu_reference.xhtml;
/cvsroot/mozilla/browser/locales/en-US/chrome/help/menu_reference.xhtml,v  <-- 
menu_reference.xhtml
new revision: 1.27; previous revision: 1.26
done
Checking in mozilla/browser/locales/en-US/chrome/help/firebird-toc.rdf;
/cvsroot/mozilla/browser/locales/en-US/chrome/help/firebird-toc.rdf,v  <-- 
firebird-toc.rdf
new revision: 1.28; previous revision: 1.27
done

Comment 16

[Thomas Stache]

The checked-in patch contains "Firefox" twice. Anybody noticed?

Comment 17

[Steffen Wilberg]

Sigh. I'll fix this later today. Thanks for noticing!

Comment 18

[Steffen Wilberg]

Checking in mozilla/browser/locales/en-US/chrome/help/menu_reference.xhtml;
/cvsroot/mozilla/browser/locales/en-US/chrome/help/menu_reference.xhtml,v  <-- 
menu_reference.xhtml
new revision: 1.28; previous revision: 1.27
done