Keyboard shortcuts in the Web staff client not noted within menus

[Jane Sandberg]

In the XUL client, the menus list keyboard shortcuts for menu items. For example, the first entry in the circulation menu reads "Check Out Items F1".

Though the F1 shortcut still works in the Web staff client, it is not noted in the menu (the menu entry simply reads "Check Out"). Users of the web client would not therefore not be able to learn about this nice time-saving functionality, except perhaps by accident.

This report is based on the current Webby demo server.

[Michele Morgan (mmorgan)]

I have noticed this while working in the web client as well. Displaying the function keys within the menus provides a built in cheat sheet for the function keys, as well as cluing in the user that the functionality exists.

[Alberto Martinez (0101martinez)]

Hello,

I'm currently working on noting the shortcut keys in the drop down menu. Almost done :)

[Terran McCanna (tmccanna)]

Great! Thanks, Alberto!

[Alberto Martinez (0101martinez)]

https://github.com/evergreen-library-system/Evergreen/pull/55

Fixed it! :D

[Terran McCanna (tmccanna)]

Thanks, Alberto!

A few notes:

Line 82: l('Check Out') was changed to l('Check Out ') which would break the translation.

Line 130: "Ctrol" should be "Ctrl"

These two are missing:
  F8 Retrieve Last Patron
  Shift-F8 Retrieve Last Bib Record

Since this is changing translatable strings, the language files should also be updated to match or else current translations will break. Alternatively these could separate the strings for the shortcut keys into two parts so that the current translations wouldn't break and only the new strings would need to be added for translations:

<span>[% l('Search the Catalog') %][% l('- F3') %]</span>

[Alberto Martinez (0101martinez)]

Hello,

I recently uploaded a new version with all the fixes:
https://github.com/evergreen-library-system/Evergreen/pull/55/files#diff-bb661cbacbce40d2d8d0ca8415c86600

Regards,

Alberto Martinez

On Wed, Jun 6, 2018 at 11:14 AM, Terran McCanna <
<email address hidden>> wrote:

> Thanks, Alberto!
>
> A few notes:
>
> Line 82: l('Check Out') was changed to l('Check Out ') which would break
> the translation.
>
> Line 130: "Ctrol" should be "Ctrl"
>
> These two are missing:
> F8 Retrieve Last Patron
> Shift-F8 Retrieve Last Bib Record
>
> Since this is changing translatable strings, the language files should
> also be updated to match or else current translations will break.
> Alternatively these could separate the strings for the shortcut keys
> into two parts so that the current translations wouldn't break and only
> the new strings would need to be added for translations:
>
> <span>[% l('Search the Catalog') %][% l('- F3') %]</span>
>
> --
> You received this bug notification because you are a bug assignee.
> https://bugs.launchpad.net/bugs/1622358
>
> Title:
> Keyboard shortcuts in the Web staff client not noted within menus
>
> Status in Evergreen:
> Confirmed
>
> Bug description:
> In the XUL client, the menus list keyboard shortcuts for menu items.
> For example, the first entry in the circulation menu reads "Check Out
> Items F1".
>
> Though the F1 shortcut still works in the Web staff client, it is not
> noted in the menu (the menu entry simply reads "Check Out"). Users of
> the web client would not therefore not be able to learn about this
> nice time-saving functionality, except perhaps by accident.
>
> This report is based on the current Webby demo server.
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/evergreen/+bug/1622358/+subscriptions
>

[Terran McCanna (tmccanna)]

Hi Alberto,

We applied the patches to our 3.0.2 test server, but it is causing us to lose our menus entirely (we are just seeing a green bar). I'm not sure what is causing the breakage.

Terran

[Remington Steed (rjs7)]

I added a comment on the github pull request to the code lines that might be causing the problem.

[Alberto Martinez (0101martinez)]

Hello,

I will check it out and get right back to you.

Thank you

On Fri, Jun 22, 2018 at 9:39 AM, Remington Steed <email address hidden> wrote:

> I added a comment on the github pull request to the code lines that
> might be causing the problem.
>
> --
> You received this bug notification because you are a bug assignee.
> https://bugs.launchpad.net/bugs/1622358
>
> Title:
> Keyboard shortcuts in the Web staff client not noted within menus
>
> Status in Evergreen:
> Confirmed
>
> Bug description:
> In the XUL client, the menus list keyboard shortcuts for menu items.
> For example, the first entry in the circulation menu reads "Check Out
> Items F1".
>
> Though the F1 shortcut still works in the Web staff client, it is not
> noted in the menu (the menu entry simply reads "Check Out"). Users of
> the web client would not therefore not be able to learn about this
> nice time-saving functionality, except perhaps by accident.
>
> This report is based on the current Webby demo server.
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/evergreen/+bug/1622358/+subscriptions
>

[Dawn Dale (ddale)]

I am testing this patch.

[Dawn Dale (ddale)]

I am not able to test this patch. Chris says it looks like it is still being worked on and not ready to test.

[Jane Sandberg (sandbergja)]

A note that these shortcuts will also have to be noted within the ang6 menu: Open-ILS/src/eg2/src/app/staff/nav.component.html

[Jane Sandberg (sandbergja)]

Hi all! Here's a new branch that does the following:
* Squashes Alberto's code into a single commit
* Adds Remington's fix
* Duplicates Alberto's solution in the Angular client

It's called user/sandbergja/lp1622358_shortcut_keys_in_menus

Here's a link: https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/sandbergja/lp1622358_shortcut_keys_in_menus

[Jane Sandberg (sandbergja)]

It also rebases Alberto's code against current master.

[Jane Sandberg (sandbergja)]

Removing pullrequest and adding needsdiscussion tags. I just noticed two things about the Angular client:

1) The keyboard shortcuts are not all added to the Angular client yet. I split this off into this bug: https://bugs.launchpad.net/evergreen/+bug/1829567
2) The Angular client has a different way to let the user know about keyboard shortcuts. If you type Ctrl+H into the Angular client, it will give you a list of keyboard shortcuts. I think it's worth some discussion about whether we should note keyboard shortcuts in both places.

[Jennifer Weston (jweston)]

Discussed in CWG -- many comments in favor of having keyboard shortcuts in both places.

General agreement with comment #1 from Michele -- "Displaying the function keys within the menus provides a built in cheat sheet for the function keys, as well as cluing in the user that the functionality exists."

[Terran McCanna (tmccanna)]

Since Ctrl+H only works in the pages that have been updated to Angular and not in any of the older pages, I'm in favor of adding the shortcut hints to the menu items.

[Michele Morgan (mmorgan)]

Adding a link to related bug 1999955.

Also, since this info doesn't seem to be widely known (and is easily forgotten :) ), the following are used to open the keyboard shortcut modals.

Ctrl+H - angular screens
? - angularjs screens