[GSoC'24]: Implement Keyboard Shortcuts Helper #16880

SanjaySargam · 2024-08-16T06:37:03Z

Purpose / Description

Keyboard shortcuts for Chromebook users are important because they make it easier and faster to use AnkiDroid. Alt + K shortcut will show keyboard shortcuts dialog

How Has This Been Tested?

HP CHROMEBOOK
Screen recording 2024-08-16 11.38.57 AM.webm

Learning (optional, can help others)

Describe the research stage

_Links to blog posts, patterns, libraries or addons used to solve this problem
https://developer.android.com/develop/ui/compose/touch-input/keyboard-input/keyboard-shortcuts-helper

Checklist

Please, go through these checks before submitting the PR.

You have a descriptive commit message with a short title (first line, max 50 chars).
You have commented your code, particularly in hard-to-understand areas
You have performed a self-review of your own code
UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
UI Changes: You have tested your change using the Google Accessibility Scanner

github-actions · 2024-08-16T06:37:15Z

Message to maintainers, this PR contains strings changes.

Before merging this PR, it is best to run the "Sync Translations" GitHub action, then make and merge a PR from the i18n_sync branch to get translations cleaned out.
Then merge this PR, and immediately do another translation PR so the huge change made by this PR's key changes are all by themselves.

Read more about updating strings on the wiki,

AnkiDroid/src/main/java/com/ichi2/compat/Compat.kt

AnkiDroid/src/main/res/values/02-strings.xml

Arthur-Milchior · 2024-08-16T10:05:25Z

AnkiDroid/src/main/res/values/02-strings.xml

@@ -425,4 +425,35 @@ opening the system text to speech settings fails">
    <string name="play_recording">Play</string>
    <string name="next_recording">Next</string>

+    <!--Keyboard Shortcut Dialog-->
+    <string name="show_keyboard_shortcuts_dialog">Show keyboard shortcuts dialog</string>


I'm sorry, because, this is going to be very boring. But can you check that all of those strings are new. If they are not, then please simply consider reusing it.
I would expect that for most case, you'd have an entry in the menus. For example, instead of "Save Note", I think we could reuse "Save" that is already used as a label of the tick in the note editor.

Ideally, I 'd like the strings to be grouped with other strings related to the same feature. E.g. the Open Statistics could be in 10-preferences. After all, I expect that, from a translator point of view (which is what matters here), they should see this string when they want to consider the Preferences.

Finally, I'm going to ask you to add a comment for all of them, because it's probably not clear for translators that this string appear in the context of a shortcut description, or of the category of shortcuts.

It could be simply something such as
comment="Description of the shortcut that open the statistics page"

FYI, "Open statistics" is good, I'm happy that the descriptions are small as much as possible. However, the comment should be very very explicit. Because the translator can't just test the shortcut (as they are not currently using the app, and even if they have a smartphone with ankidroid, they may not even have a keyboard)
And they should be very sure what the shortcut does so that they can find an appropriate short description

Also: do other apps use Title Case, or Sentence case for these strings?

Yes
Ex: Discord

Arthur-Milchior · 2024-08-16T10:07:10Z

AnkiDroid/src/main/java/com/ichi2/compat/CompatV24.kt

+            )
+
+        val cardTemplateEditorShortcutGroup =
+            KeyboardShortcutGroup(


As discussed on discord, I'd prefer this to be in a companion object in the CardTemplateEditor. It will be simpler to find where to edit the shortcut content when you edit the code for shortcut.

Also, I'd appreciate if, near the function dealing with shortcut, you can add a comment that state "When you edit this field, reflect the change in cardTemplateEditorShortcutGroup

As discussed on discord, I'd prefer this to be in a companion object in the CardTemplateEditor. It will be simpler to find where to edit the shortcut content when you edit the code for shortcut.

Is this goes similar to other screens (DeckPicker, NoteEditor, CardBrowser) ??

david-allison

Fundamentally: great change!

AnkiDroid/src/main/java/com/ichi2/compat/CompatV23.kt

david-allison · 2024-08-19T13:42:30Z

AnkiDroid/src/main/java/com/ichi2/anki/AnkiActivity.kt

+        menu: Menu?,
+        deviceId: Int
+    ) {
+        val shortcutGroups = CompatHelper.compat.getAllShortcuts(this)


Why are we showing shortcuts irrelevant to the current screen?

The reply also be a code comment

We include all shortcuts here so that the keyboard shortcut dialog can be opened from anywhere in the app using the Alt+K shortcut, ensuring users have quick access to all available shortcuts regardless of the current screen.

I'll leave this one to @Arthur-Milchior

Personally:

If a screen has no specific actions, I'd want everything

If a screen has specific actions, I'd only want to see relevant actions + global actions

@Arthur-Milchior FYI

Oops sorry.
In my mind, if a screen has no specific action, I prefer to see only the ankidroid general actions, even if they are only two.
And, most importantly, let's not show the snackbar to tell users to use alt-k. After all, when there is no specific action, this snackbar is pointless

david-allison · 2024-08-19T13:44:15Z

AnkiDroid/src/main/java/com/ichi2/anki/AnkiActivity.kt

+    }
+
+    override fun onKeyUp(keyCode: Int, event: KeyEvent): Boolean {
+        if (keyCode == KeyEvent.KEYCODE_K && event.isAltPressed) {


This is a good start, but realistically nobody is going to know about this keyboard shortcut

There's a number of things we can do here, for example:

If a user presses an unmapped shortcut, show a message that "Alt+K" shows all shortcuts?

How can I get unmapped shortcut? Do you know any easy way to achieve it

Typically: super is not called if the action is handled

The snackbar shows up every time any key is pressed, which includes the back and volume buttons.

And why Alt+K? Is that a standard somewhere? In iPadOS it is Command (https://support.apple.com/en-us/102393). Anything that can benefit from external consistency is good to me.

If a user presses an unmapped shortcut, show a message that "Alt+K" shows all shortcuts?

It is useful only once and very annoying every time a miss a shortcut in the future. Alos, that will be a nightmare with controllers, special keys and special devices.

I refined the statement in a follow-up comment to only include shortcuts with modifier keys pressed

AnkiDroid/src/main/java/com/ichi2/compat/CompatV23.kt

david-allison · 2024-08-19T13:45:41Z

AnkiDroid/src/main/res/values/02-strings.xml

@@ -425,4 +425,35 @@ opening the system text to speech settings fails">
    <string name="play_recording">Play</string>
    <string name="next_recording">Next</string>

+    <!--Keyboard Shortcut Dialog-->
+    <string name="show_keyboard_shortcuts_dialog">Show keyboard shortcuts dialog</string>


Also: do other apps use Title Case, or Sentence case for these strings?

AnkiDroid/src/main/java/com/ichi2/compat/CompatV24.kt

AnkiDroid/src/main/res/values/02-strings.xml

AnkiDroid/src/main/res/values/07-cardbrowser.xml

david-allison · 2024-08-22T15:30:43Z

AnkiDroid/src/main/java/com/ichi2/anki/AnkiActivity.kt

+        menu: Menu?,
+        deviceId: Int
+    ) {
+        val shortcutGroups = CompatHelper.compat.getAllShortcuts(this)


I'll leave this one to @Arthur-Milchior

Personally:

If a screen has no specific actions, I'd want everything

If a screen has specific actions, I'd only want to see relevant actions + global actions

brishtibheja · 2024-08-24T15:21:11Z

Is Alt+K used in other Android devices? I couldn't find that on my own. In my Android, the global shortcut is Search+/ and it also works in Google keep notes. The app-specific shortcuts are shown along with the system shortcuts here.

SanjaySargam · 2024-08-24T15:53:51Z

Is Alt+K used in other Android devices?

Nope. Here K for keyboard shortcuts

brishtibheja · 2024-08-24T16:59:05Z

It would be nice to have it match with other apps/system shortcuts, although I'm not sure if there's a standard or it just depends on app/device.

Arthur-Milchior · 2024-08-25T03:35:32Z

My bad, I'm very sorry, my mistake.
When I saw

on https://developer.android.com/develop/ui/compose/touch-input/keyboard-input/keyboard-shortcuts-helper
I thought that "System" "Input" and "Open Apps" were three KeyboardShortcutGroup.

I would have been fine to have such a UI. Let's say you're in card browser, you'll see the CardBrowser group first. And if you wanted, you could open the other groups, to get an idea of what you can do in the deck picker let's say. But by default, you'd only get the currently relevent shortcuts.

Clearly, I was wrong, and the "groups" are all displayed at once in a single list. This indeed looks far too busy. I don't like it.

So, yeah, I'm sorry and I'll ask you to revert and only show the shortcuts from the current activities.

Please also only display the message about shortcut only if there are available shortcuts, so that we don't offer to the user a list of shortcut that only contains alt+k

Arthur-Milchior

@david-allison there was quite some changes since you reviewed. Including one that corrected a real bug. So I'd appreciate if you could re-review before we merge

Arthur-Milchior · 2024-10-03T17:55:28Z

I'm quite sorry @SanjaySargam it tooks more conflict. Can you solve them?

AnkiDroid/src/main/java/com/ichi2/anki/AnkiActivity.kt

AnkiDroid/src/main/java/com/ichi2/anki/CardBrowser.kt

AnkiDroid/src/main/java/com/ichi2/anki/NoteEditor.kt

AnkiDroid/src/main/java/com/ichi2/compat/CompatV24.kt

AnkiDroid/src/main/res/values/02-strings.xml

david-allison

Thanks so much!

Needs strings sync

david-allison · 2024-10-05T19:54:01Z

Synced, but needs a squash (then probably another sync)

Alt + K shows the keyboard shortcuts dialog

david-allison · 2024-10-06T03:41:03Z

I've squashed the commit and fixed a couple of 'additional newline' nitpicks which weren't addressed.

Strings are clean, but this needs a follow-up translation sync

github-actions · 2024-10-06T04:05:23Z

Maintainers: Please Sync Translations to produce a commit with only the automated changes from this PR.

Read more about updating strings on the wiki,

github-actions · 2024-12-29T15:37:06Z

Hi there @SanjaySargam! This is the OpenCollective Notice for PRs merged from 2024-10-01 through 2024-10-31

If you are interested in compensation for this work, the process with details is here:

https://github.com/ankidroid/Anki-Android/wiki/OpenCollective-Payment-Process#how-to-get-paid

Important

PLEASE NOTE: The process was updated in August 2024. Re-read the Payment Process page if you have not already.

We only post one comment per person per month to avoid spamming you, regardless of the number of PRs merged, but this note applies to all PRs merged for this month

Please understand that our monthly budget is never guaranteed to cover all claims - the cap on payments-per-person may be lower, but we try to make our process as fair and transparent as possible, we just need your understanding.

Thanks!

github-actions bot added the Strings label Aug 16, 2024

SanjaySargam added Needs Review GSoC Pull requests authored by a Google Summer of Code participant [Candidate/Selected], for GSoC mentors Strings and removed Strings labels Aug 16, 2024

SanjaySargam force-pushed the keyboard-shortcut-helper branch 2 times, most recently from ee30b44 to a76f17d Compare August 16, 2024 09:53

Arthur-Milchior reviewed Aug 16, 2024

View reviewed changes

SanjaySargam force-pushed the keyboard-shortcut-helper branch from a76f17d to a5452c3 Compare August 17, 2024 12:20

github-actions bot added the Has Conflicts label Aug 19, 2024

david-allison added the Needs Author Reply Waiting for a reply from the original author label Aug 19, 2024

david-allison reviewed Aug 19, 2024

View reviewed changes

SanjaySargam force-pushed the keyboard-shortcut-helper branch from a5452c3 to 0c326ac Compare August 20, 2024 20:03

SanjaySargam removed the Has Conflicts label Aug 20, 2024

SanjaySargam force-pushed the keyboard-shortcut-helper branch from 0c326ac to 01902e2 Compare August 21, 2024 18:37

SanjaySargam removed the Needs Author Reply Waiting for a reply from the original author label Aug 21, 2024

SanjaySargam requested a review from Arthur-Milchior August 21, 2024 18:38

SanjaySargam force-pushed the keyboard-shortcut-helper branch from 01902e2 to 278d9e9 Compare August 22, 2024 05:18

SanjaySargam requested a review from david-allison August 22, 2024 06:01

david-allison requested changes Aug 22, 2024

View reviewed changes

SanjaySargam force-pushed the keyboard-shortcut-helper branch from 278d9e9 to f450244 Compare August 23, 2024 11:48

SanjaySargam requested a review from david-allison August 23, 2024 11:48

github-actions bot added the Has Conflicts label Aug 24, 2024

SanjaySargam force-pushed the keyboard-shortcut-helper branch from f450244 to 508aa7b Compare August 24, 2024 08:14

SanjaySargam removed the Has Conflicts label Aug 24, 2024

SanjaySargam force-pushed the keyboard-shortcut-helper branch from 81ac1eb to 6b75e7b Compare September 21, 2024 20:46

Arthur-Milchior added the squash-merge The pull request currently requires maintainers to "Squash Merge" label Sep 21, 2024

Arthur-Milchior requested a review from david-allison September 21, 2024 21:24

Arthur-Milchior approved these changes Sep 21, 2024

View reviewed changes

github-actions bot added the Has Conflicts label Sep 28, 2024

SanjaySargam force-pushed the keyboard-shortcut-helper branch from 6b75e7b to 9ff5084 Compare October 3, 2024 18:10

SanjaySargam removed the Has Conflicts label Oct 3, 2024

SanjaySargam requested a review from Arthur-Milchior October 3, 2024 18:10

david-allison requested changes Oct 4, 2024

View reviewed changes

SanjaySargam force-pushed the keyboard-shortcut-helper branch 2 times, most recently from b3cf0ee to ca9f39e Compare October 5, 2024 13:22

david-allison approved these changes Oct 5, 2024

View reviewed changes

david-allison added Pending Merge Things with approval that are waiting future merge (e.g. targets a future release, CI wait, etc) and removed Needs Second Approval Has one approval, one more approval to merge labels Oct 5, 2024

david-allison force-pushed the keyboard-shortcut-helper branch from ca9f39e to 96c70b6 Compare October 6, 2024 03:37

feat: keyboard shortcuts helper

30456fd

Alt + K shows the keyboard shortcuts dialog

david-allison force-pushed the keyboard-shortcut-helper branch from 96c70b6 to 30456fd Compare October 6, 2024 03:40

david-allison removed Review High Priority Request for high priority review squash-merge The pull request currently requires maintainers to "Squash Merge" labels Oct 6, 2024

david-allison enabled auto-merge October 6, 2024 03:42

david-allison added this pull request to the merge queue Oct 6, 2024

Merged via the queue into ankidroid:main with commit 75d9e56 Oct 6, 2024
9 checks passed

github-actions bot added this to the 2.19 release milestone Oct 6, 2024

github-actions bot removed the Pending Merge Things with approval that are waiting future merge (e.g. targets a future release, CI wait, etc) label Oct 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GSoC'24]: Implement Keyboard Shortcuts Helper #16880

[GSoC'24]: Implement Keyboard Shortcuts Helper #16880

SanjaySargam commented Aug 16, 2024

github-actions bot commented Aug 16, 2024

Arthur-Milchior Aug 16, 2024

SanjaySargam Aug 17, 2024

david-allison Aug 19, 2024

SanjaySargam Aug 20, 2024

Arthur-Milchior Aug 16, 2024

SanjaySargam Aug 21, 2024

david-allison left a comment

david-allison Aug 19, 2024

SanjaySargam Aug 20, 2024

david-allison Aug 22, 2024 •

edited

Loading

david-allison Aug 24, 2024

Arthur-Milchior Aug 29, 2024

david-allison Aug 19, 2024

SanjaySargam Aug 20, 2024

david-allison Aug 22, 2024

BrayanDSO Aug 26, 2024

david-allison Aug 29, 2024

david-allison Aug 19, 2024

david-allison Aug 22, 2024 •

edited

Loading

brishtibheja commented Aug 24, 2024

SanjaySargam commented Aug 24, 2024

brishtibheja commented Aug 24, 2024

Arthur-Milchior commented Aug 25, 2024

Arthur-Milchior left a comment

Arthur-Milchior commented Oct 3, 2024

david-allison left a comment •

edited

Loading

david-allison commented Oct 5, 2024

david-allison commented Oct 6, 2024 •

edited

Loading

github-actions bot commented Oct 6, 2024

github-actions bot commented Dec 29, 2024

[GSoC'24]: Implement Keyboard Shortcuts Helper #16880

[GSoC'24]: Implement Keyboard Shortcuts Helper #16880

Conversation

SanjaySargam commented Aug 16, 2024

Purpose / Description

How Has This Been Tested?

Learning (optional, can help others)

Checklist

github-actions bot commented Aug 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

david-allison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

david-allison Aug 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

david-allison Aug 22, 2024 • edited Loading

Choose a reason for hiding this comment

brishtibheja commented Aug 24, 2024

SanjaySargam commented Aug 24, 2024

brishtibheja commented Aug 24, 2024

Arthur-Milchior commented Aug 25, 2024

Arthur-Milchior left a comment

Choose a reason for hiding this comment

Arthur-Milchior commented Oct 3, 2024

david-allison left a comment • edited Loading

Choose a reason for hiding this comment

david-allison commented Oct 5, 2024

david-allison commented Oct 6, 2024 • edited Loading

github-actions bot commented Oct 6, 2024

github-actions bot commented Dec 29, 2024

david-allison Aug 22, 2024 •

edited

Loading

david-allison Aug 22, 2024 •

edited

Loading

david-allison left a comment •

edited

Loading

david-allison commented Oct 6, 2024 •

edited

Loading