Bug 39158 - Web Inspector: use platform-specific key designations in shortcuts help for mac
Summary: Web Inspector: use platform-specific key designations in shortcuts help for mac
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Web Inspector (Deprecated) (show other bugs)
Version: 528+ (Nightly build)
Hardware: All All
: P2 Normal
Assignee: Nobody
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-05-15 04:50 PDT by Andrey Kosyakov
Modified: 2010-06-02 18:05 PDT (History)
9 users (show)

See Also:


Attachments
patch (4.56 KB, patch)
2010-05-15 04:59 PDT, Andrey Kosyakov
no flags Details | Formatted Diff | Diff
screenshot (261.10 KB, image/png)
2010-05-15 05:02 PDT, Andrey Kosyakov
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Andrey Kosyakov 2010-05-15 04:50:59 PDT
Shortcut help screen needs to use platform-specific key symbols on Mac (Esc = ⎋, Tab = ⇥ etc)
Comment 1 Andrey Kosyakov 2010-05-15 04:59:24 PDT
Created attachment 56148 [details]
patch
Comment 2 Andrey Kosyakov 2010-05-15 05:02:32 PDT
Created attachment 56149 [details]
screenshot
Comment 3 Pavel Feldman 2010-05-15 07:01:47 PDT
(In reply to comment #0)
> Shortcut help screen needs to use platform-specific key symbols on Mac (Esc = ⎋, Tab = ⇥ etc)

I actually don't think this is a good idea. I am fine with Arrows, Tab, Backspace and Return, Mac's Control, Cmd, Option and Shift since they match the images on the actual keyboard.

But I am not such a great fan of ⎋ for Esc, PageUp, PageDown and the rest. I'd use a following rule: if an image matches the one on the keyboard - use it. Otherwise we make user wonder what ⎋ stands for. I did not know (or at least that it not on top of my head).

Another thing is that I would also try to render shortcut hints in as platform-agnostic manner as possible. That would ease the migration between platforms.
Comment 4 Timothy Hatcher 2010-05-15 08:52:24 PDT
Those symbols are what shows up in the menu for Esc, PageUp, etc. I think this is a good thing to do.

You can always add tooltips for the human readable meaning.
Comment 5 Joseph Pecoraro 2010-05-15 09:53:49 PDT
Yes, mac users should be familiar with these shortcut
key symbols. Further, these tools are for developers
who are even more likely to understand these symbols.
Comment 6 Andrey Kosyakov 2010-05-15 10:22:46 PDT
(In reply to comment #3)

> But I am not such a great fan of ⎋ for Esc, PageUp, PageDown and the rest. I'd use a following rule: if an image matches the one on the keyboard - use it. 
> Otherwise we make user wonder what ⎋ stands for. I did not know (or at least that it not on top of my head).

I admit this did surprise me too, but it's actually being used (e.g. by Finder), and PageUp, PageDown, Tab & En^H^HReturn actually do appear as these arrows on Apple keyboards. As this appears to be platform convention, I vote for following it rather than trying to stay consistent across the platforms, as even the shortcuts themselves are already diverging.
Comment 7 Pavel Feldman 2010-05-15 13:23:08 PDT
(In reply to comment #5)
> Yes, mac users should be familiar with these shortcut
> key symbols. Further, these tools are for developers
> who are even more likely to understand these symbols.

Please forgive my sarcastic tone below.

So what is wrong with these?
http://support.apple.com/kb/ht1343
http://www.apple.com/itunes/how-to/shortcuts.html
http://eg-www.apple.com/support/iphoto/shortcuts/
http://www.apple.com/pro/tips/secretcapture.html
http://trac.webkit.org/wiki/WebInspector#ShortcutKeys

Oh no, in the last one, someone is using "Esc", "Tab" and "Page Up"! Doesn't he know there are images for those?!?

Seriously, I think the purpose of this help screen is to make shortcuts more accessible. Parsing 'Esc' is easier and more accessible than parsing ⎋. That is why all the docs use 'Esc'. We are not a part of a Mac menu, we don't have constraints such as 'fewer symbols, align to the right'. We are a documentation page within the app. I am a happy Mac user for years, a developer. But I had to think a bit in order to parse images for esc and page up.

Sarcasm desert: I might consider agreeing with you in case you point me to a help topic / menu item in the (Snow?) Leopard standard distribution referring to a PageUp using the image you are suggesting :) (And yes, my keyboard does not have it as it has 'esc' for escape).
Comment 8 Andrey Kosyakov 2010-05-15 13:57:02 PDT
(In reply to comment #7)

> I might consider agreeing with you in case you point me to a help topic / menu item in the (Snow?) Leopard standard distribution referring to a PageUp using the image you are suggesting :) (And yes, my keyboard does not have it as it has 'esc' for escape).

System Preferences -> Keyboard & Mouse -> Keyboard Shortcuts -> Add?
(Can't really check PageUp/PageDown now as I don't have an external keyboard, but all the rest are symbolic)
Comment 9 Timothy Hatcher 2010-05-15 14:03:34 PDT
Terminal's View menu.

Escape is in the Apple menu.
Comment 10 Pavel Feldman 2010-05-15 21:37:20 PDT
(In reply to comment #9)
> Terminal's View menu.
> 

Ok, ok (although they have large and shiny 'Page Up' and 'Page Down' to the left, so confusion is unlikely to happen). You did not comment on the numerous shortcut help pages I mentioned, so I assume you still think we are different. Okay, time to give up for me!
Comment 11 WebKit Commit Bot 2010-06-02 18:05:46 PDT
Comment on attachment 56148 [details]
patch

Clearing flags on attachment: 56148

Committed r60584: <http://trac.webkit.org/changeset/60584>
Comment 12 WebKit Commit Bot 2010-06-02 18:05:53 PDT
All reviewed patches have been landed.  Closing bug.