940116 - Australis application menu buttons have inconsistent tooltips

Status: VERIFIED FIXED

(Firefox :: Toolbars and Customization, defect)

Description

[Cameron McCormack (:heycam)]

The buttons in the Australis application menu have these tooltips:

Cut: "Cut"
Copy: "Copy"
Paste: "Paste"
-: "Zoom out"
100%: "Reset zoom level"
+: "Zoom in"
New Window: "Open a new window"
New Private Window: "Open a new Private Browsing window (⌘⇧P)"
Save Page: "Save this page (⌘s)"
Print: "Print this page"
History: "History... (⌘⇧h)"
Full Screen: "Display the window in full screen"
Find: "Find in this page (⌘f)"
Preferences: "Preferences..."
Add-ons: "Add-ons Manager (⌘⇧A)"
Help: -
Customize: -
Quit: -

There are a few inconsistencies in the tooltip text:

* Some shortcuts are shown with lowercase letters, and some with uppercase.
  They should all be uppercase.
* Some shortcuts are shown and others are not.  All of these buttons have
  shortcuts (apart from History and Help, which slide menus over, and Customize)
  so I think they should be shown.
* Most of the tooltips are imperative phrases, like "Do this thing".  The ones
  for History, Preferences and Add-ons aren't, but should be.  Although with
  History I'm not sure, due to its menu sliding behaviour.
* The use of ellipses is not consistent with the menu bar.  For example,
  the menu item is "Save this page..." while here it is "Save this page".  A
  modal window is opened, so I think "..." should be used.  Same with "Print this
  page" (although note that in the menu bar it is "Print..." and not "Print this
  page...".  I don't think History should have an ellipsis, as it doesn't open
  a modal window.

Comment 2

[Justin Dolske [:Dolske]]

Should the shortcut keys even be in the tooltop for OS X? That seems unusual. (Not an issue on Windows.)

Comment 3

[Francesco Lodolo [:flod]]

(In reply to Justin Dolske [:Dolske] from comment #2)
> Should the shortcut keys even be in the tooltop for OS X? That seems
> unusual. (Not an issue on Windows.)

I don't find it unusual honestly (it's handy), and I don't think that's common to have tooltips on Windows either.

Comment 4

[:Gijs (he/him)]

This touches strings and is low-hanging polish fruit, so let's try to get this done.

Comment 5

[:Gijs (he/him)]

(In reply to :Gijs Kruitbosch from comment #4)
> This touches strings and is low-hanging polish fruit, so let's try to get
> this done.

Madhava, can you or someone else from UX give us final strings for these (or reprioritize)?

(In reply to Cameron McCormack (:heycam) from comment #0)
> The buttons in the Australis application menu have these tooltips:
> 
> Cut: "Cut"
> Copy: "Copy"
> Paste: "Paste"
> -: "Zoom out"
> 100%: "Reset zoom level"
> +: "Zoom in"
> New Window: "Open a new window"
> New Private Window: "Open a new Private Browsing window (⌘⇧P)"
> Save Page: "Save this page (⌘s)"
> Print: "Print this page"
> History: "History... (⌘⇧h)"
> Full Screen: "Display the window in full screen"
> Find: "Find in this page (⌘f)"
> Preferences: "Preferences..."
> Add-ons: "Add-ons Manager (⌘⇧A)"
> Help: -
> Customize: -
> Quit: -
> 
> There are a few inconsistencies in the tooltip text:
> 
> * Some shortcuts are shown with lowercase letters, and some with uppercase.
>   They should all be uppercase.

Should they? On beta, most of the UI tooltips I can see on the toolbars are lowercased, e.g. "Go back one page", "Display your bookmarks", "Display the progress of ongoing downloads", ...

> * Some shortcuts are shown and others are not.  All of these buttons have
>   shortcuts (apart from History and Help, which slide menus over, and
> Customize)

Preferences and Quit don't have a shortcut on Windows. Generally, we steal these shortcuts from <key> elements. I'm not sure such elements exist for all of these.

Comment 6

[:Gijs (he/him)]

(In reply to :Gijs Kruitbosch from comment #5)
> (In reply to Cameron McCormack (:heycam) from comment #0)
> > * Some shortcuts are shown with lowercase letters, and some with uppercase.
> >   They should all be uppercase.
> 
> Should they? On beta, most of the UI tooltips I can see on the toolbars are
> lowercased, e.g. "Go back one page", "Display your bookmarks", "Display the
> progress of ongoing downloads", ...

Ugh, early morning reading fail. Ignore me.

Comment 7

[Zhenshuo Fang (:fang) - Firefox UX Team]

Summary of an earlier conversation on irc with Gijs and Madhava:

1. Use "Customize the Menu and Toolbars" for the customize button
2. For Quit button change to "Quit Firefox(⌘Q)"
3. Show shortcuts in parentheses if the action has a keyboard shortcut
4. Use ellipses when there's more action needed to complete the action

So, the tooltips should be:
Cut: "Cut(⌘X)"
Copy: "Copy(⌘C)"
Paste: "Paste(⌘V)"
-: "Zoom out(⌘-)"
100%: "Reset zoom level(⌘0)"
+: "Zoom in(⌘+)"
New Window: "Open a new window(⌘N)"
New Private Window: "Open a new Private Browsing window (⌘⇧P)"
Save Page: "Save this page...(⌘S)"
Print: "Print this page...(⌘P)"
History: "Show your history(⌘⇧H)"
Full Screen: "Display the window in full screen(^⌘F)"
Find: "Find in this page...(⌘F)"
Preferences: "Open Preferences(⌘,)"
Add-ons: "Open Add-ons Manager(⌘⇧A)"
Bookmarks: "Show your bookmarks"
Email Link: "Email Link..."
Subscribe: "Subscribe to this page..."
Sync: "Set up Sync..." or "Sync now"
Help: "Open Help menu"(I'm not 100% sure about the name "Help Menu", "Help" probably works just fine)
Character Encoding: "Show Character Encoding options"
Tab groups: "Group your tabs"
Open file: "Open file...(⌘O)"
Developer: "Web Developer Tools(⌘⌥|)"
Customize: "Customize the Menu and Toolbars"
Quit: "Quit Firefox(⌘Q)"

Did I forget anything?

Comment 8

[:Gijs (he/him)]

(In reply to Zhenshuo Fang (:fang) - Firefox UX Team from comment #7)
> Summary of an earlier conversation on irc with Gijs and Madhava:
> 
> 1. Use "Customize the Menu and Toolbars" for the customize button
> 2. For Quit button change to "Quit Firefox(⌘Q)"
> 3. Show shortcuts in parentheses if the action has a keyboard shortcut
> 4. Use ellipses when there's more action needed to complete the action
> 
> So, the tooltips should be:
> Cut: "Cut(⌘X)"
> Copy: "Copy(⌘C)"
> Paste: "Paste(⌘V)"
> -: "Zoom out(⌘-)"
> 100%: "Reset zoom level(⌘0)"
> +: "Zoom in(⌘+)"
> New Window: "Open a new window(⌘N)"
> New Private Window: "Open a new Private Browsing window (⌘⇧P)"
> Save Page: "Save this page...(⌘S)"
> Print: "Print this page...(⌘P)"
> History: "Show your history(⌘⇧H)"
> Full Screen: "Display the window in full screen(^⌘F)"
> Find: "Find in this page...(⌘F)"
> Preferences: "Open Preferences(⌘,)"
> Add-ons: "Open Add-ons Manager(⌘⇧A)"
> Bookmarks: "Show your bookmarks"
> Email Link: "Email Link..."
> Subscribe: "Subscribe to this page..."
> Sync: "Set up Sync..." or "Sync now"
> Help: "Open Help menu"(I'm not 100% sure about the name "Help Menu", "Help"
> probably works just fine)
> Character Encoding: "Show Character Encoding options"
> Tab groups: "Group your tabs"
> Open file: "Open file...(⌘O)"
> Developer: "Web Developer Tools(⌘⌥|)"
> Customize: "Customize the Menu and Toolbars"
> Quit: "Quit Firefox(⌘Q)"
> 
> Did I forget anything?

The text for Quit Firefox should be platform-dependent. And I think we need a different tooltip for "Exit customize" when you're in customization mode.

Comment 9

[:Gijs (he/him)]

Attachment: part 1 of many, fix customize/quit/help labels,

Likely the first of several. Per discussion with fang on IRC, for exiting customize mode, 'Finish Customizing'.

Comment 10

[u428464]

On Windows at least "Tab Groups" has a shortcut Ctrl+Shift+E

Comment 11

[Jared Wein [:jaws] (please needinfo? me)]

Comment on attachment 8367028 [details] [diff] [review]
part 1 of many, fix customize/quit/help labels,

Review of attachment 8367028 [details] [diff] [review]:
-----------------------------------------------------------------

::: browser/locales/en-US/chrome/browser/customizableui/customizableWidgets.properties
@@ +84,5 @@
> +
> +# LOCALIZATION NOTE(quit-button.tooltiptext.linux): %S is the keyboard shortcut
> +quit-button.tooltiptext.linux = Quit (%S)
> +# LOCALIZATION NOTE(quit-button.tooltiptext.mac): %1$S is the brand name (e.g. Firefox),
> +# %2$$ is the keyboard shortcut

nit, s/%2$$/%2$S/

Comment 12

[:Gijs (he/him)]

Comment on attachment 8367028 [details] [diff] [review]
part 1 of many, fix customize/quit/help labels,

w/ nit,

remote:   https://hg.mozilla.org/integration/fx-team/rev/9b3dc7c6dae9

Comment 13

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/9b3dc7c6dae9

Comment 14

[:Gijs (he/him)]

Attachment: part 2, include more shortcuts inside Australis widgets,

I believe this covers the other items, with the exception of new window, print, full screen, bookmarks, sync and tab groups, all of which are old-style toolbar buttons, so fixing them is harder.

Comment 15

[Jared Wein [:jaws] (please needinfo? me)]

Comment on attachment 8367549 [details] [diff] [review]
part 2, include more shortcuts inside Australis widgets,

Review of attachment 8367549 [details] [diff] [review]:
-----------------------------------------------------------------

::: browser/locales/en-US/chrome/browser/customizableui/customizableWidgets.properties
@@ +6,2 @@
>  history-panelmenu.label = History
> +history-panelmenu.tooltiptext2 = Show your history (%S)

nit, place the localization note above the referenced string (here and for email-link-button.tooltiptext2).

Comment 16

[:Gijs (he/him)]

Comment on attachment 8367549 [details] [diff] [review]
part 2, include more shortcuts inside Australis widgets,

w/ nits,

remote:   https://hg.mozilla.org/integration/fx-team/rev/e50578e8c8a4

Comment 17

[Tim Taubert [:ttaubert] (inactive)]

https://hg.mozilla.org/mozilla-central/rev/e50578e8c8a4

Comment 18

[:Gijs (he/him)]

So these remain:

(In reply to Zhenshuo Fang (:fang) - Firefox UX Team from comment #7)
> New Window: "Open a new window(⌘N)"
> Print: "Print this page...(⌘P)"
> Full Screen: "Display the window in full screen(^⌘F)"

> Bookmarks: "Show your bookmarks"

This has shortcuts though... either for adding bookmarks, showing the bookmarks sidebar, or showing the library. Do we not want to display any?

> Sync: "Set up Sync..." or "Sync now"
> Tab groups: "Group your tabs"

This also has a shortcut. And, arguably, does need more action in order to group your tabs...

Can you clarify?

Comment 19

[Zhenshuo Fang (:fang) - Firefox UX Team]

(In reply to :Gijs Kruitbosch from comment #18)
> So these remain:

Right!
For bookmarks we can use the shortcut for show all bookmarks, so:
Bookmarks: "Show your bookmarks(⇧⌘B)" 
Tab Groups: "Group your tabs(⇧⌘E)"

Comment 20

[:Gijs (he/him)]

Attachment: part 3: update XUL buttons to have a dynamic tooltip that includes a shortcut (Australis),

This covers the XUL buttons except for sync, which Zhenshuo and I discussed on IRC - as it currently has a dynamic tooltip which contains the time you last synced, and no shortcut, we decided to leave it alone at least as far as this bug is concerned.

Comment 21

[Jared Wein [:jaws] (please needinfo? me)]

Comment on attachment 8368126 [details] [diff] [review]
part 3: update XUL buttons to have a dynamic tooltip that includes a shortcut (Australis),

Review of attachment 8368126 [details] [diff] [review]:
-----------------------------------------------------------------

::: browser/base/content/browser.js
@@ +4839,5 @@
> +  "new-window-button": "key_newNavigator",
> +  "fullscreen-button": "key_fullScreen",
> +  "tabview-button": "key_tabview",
> +};
> +const gDynamicTooltipCache = new Map();

This cache will be created once per window. Can it be moved to the CustomizableUI.jsm or something like that?

Comment 22

[:Gijs (he/him)]

remote:   https://hg.mozilla.org/integration/fx-team/rev/579ea635878a


Per discussion with Jared, not migrating the cache elsewhere for now.

Also, the bookmarks menu tooltip might or might not work correctly if the button has been in the toolbar before, I'm not 100% sure - if it doesn't, the patch I put up in bug 964218 will fix that (it's to do with the nested toolbar button tooltip).

Comment 23

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/579ea635878a

Comment 24

[u428464]

Panorama has still no shortcut in its tooltip.

Comment 25

[:Gijs (he/him)]

:-(

Comment 26

[:Gijs (he/him)]

Attachment: fix tabview button tooltip for Australis,

Comment 27

[:Gijs (he/him)]

Attachment: fix tabview button tooltip for Australis,

In fact, that string isn't referenced elsewhere, so that can just go away.

Comment 28

[u428464]

I don't know if it's by design but the print widget has no shortcut on Windows (it may be since "print preview" that is opened on click hasn't one).

Comment 29

[:Gijs (he/him)]

(In reply to Guillaume C. [:ge3k0s] from comment #28)
> I don't know if it's by design but the print widget has no shortcut on
> Windows (it may be since "print preview" that is opened on click hasn't one).

Yes, that's by design, because, as you noted, it opens print preview, which has no shortcut.

Comment 30

[:Gijs (he/him)]

Tabview fix:

remote:   https://hg.mozilla.org/integration/fx-team/rev/26c994a28b5e


For any further issues, please open new bugs.

Comment 31

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/26c994a28b5e

Comment 32

[:Gavin Sharp [email: [e-mail]]]

Comment on attachment 8367549 [details] [diff] [review]
part 2, include more shortcuts inside Australis widgets,

>diff --git a/browser/locales/en-US/chrome/browser/customizableui/customizableWidgets.properties b/browser/locales/en-US/chrome/browser/customizableui/customizableWidgets.properties

>-history-panelmenu.tooltiptext = History⦠(%S)
>+history-panelmenu.tooltiptext2 = Show your history (%S)

For future reference: better to put the "2" in the non-leaf portion of the string name (i.e. history-panelmenu2.tooltiptext), leaving the descriptive "tooltiptext" portion alone, since some l10n tools treat those specially.

Comment 33

[Cornel Ionce [:noni] [Hubs QA]]

Verified as fixed on latest Aurora (build ID: 20140309004003) using Windows 7 32bit, Ubuntu 13.04 and Mac OS X 10.9.

Also verified on a Microsoft Surface Pro 2 device running Windows 8.1 64bit.

Commented in bug 979479 for the remaining issues so marking this verified.