[GSoC'24] Add NoteEditor to CardBrowser #16764

SanjaySargam · 2024-07-19T19:05:54Z

Purpose / Description

This feature aims to enhance the CardBrowser by adding a NoteEditor. This will allow users to edit card side by side on large screens

Approach

Attach NoteEditor to CardBrowser
Move NoteEditor menu to CardBrowser menu
Hide fragment when deck is empty

How Has This Been Tested?

Medium Tablet API 34

Screen_recording_20240711_015502.mp4

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

david-allison

All looks good, cheers!

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

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

Arthur-Milchior · 2024-08-11T14:44:56Z

I'm reviewing. Commenting because there is one main issue I've got that I'd want to be fixed before the feature is shipped to user.

If you are making any change, in the trailing side, and select a new card, any change you made is lost.
I'm sorry, I should have realized this sooner. But yeah, that does not really seems acceptable behavior, as it means that the user change are lost. And this could occur by simply tapping on the screen by accident.

The note editor is already able to stop the user from leaving the view if they are unsaved changes.
In my opinion, we should not do exactly the same change. After all, it's not clear how to save the changes (the tick icon may be clear to developer; I'm not sure it is to everyone when the screen is fragmented)
Instead, I'd suggest asking the user whether they want to save the change or discard them. In particular because, if they want to resume editing, they can still "save" and then come back to the card.

Arthur-Milchior

Another issue I found. Move to a deck with no card. You can still select the meny entry "copy note". And it'll copy the last selected note. This should become grayed. Same with, for "show toolbar" given that it lead to a crash if there is no note editor.

My main question is: how did you test it.
I understand this is Google Summer of Code, and you're not a quality assurance expert. Still, I'd have expected that you'd test your code with various configuration, such as phone, tablet with fragmented screen, tablet with the fragment hidden, and check all buttons. Or at least, all "note editor" related menu features.

Right now I'll keep reviewing other PR, and wait for you to answer to the remarks I made, I'll come back to it after you replied to them, or, ideally, fixed bugs and applied correction I wanted

Arthur-Milchior · 2024-07-31T08:45:37Z

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

+         * If both conditions are true, assign true to the variable [fragmented], otherwise assign false.
+         * [fragmented] will be true if the view size is large otherwise false
+         */
+        fragmented = noteEditorFrame != null && noteEditorFrame!!.visibility == View.VISIBLE


noteEditorFrame?.visibility == View.VISIBLE

I'm surprised, I thought I already had a recent request of change, but I can't find it

Arthur-Milchior · 2024-08-10T21:39:33Z

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

+     * Provides an instance of NoteEditorLauncher for editing a note
+     */
+    private val editNoteLauncher: NoteEditorLauncher
+        get() = NoteEditorLauncher.EditCard(viewModel.currentCardId, Direction.DEFAULT)


You can remove viewModel. given that currentCardId is a getter for viewModel.currentCardId

Arthur-Milchior · 2024-08-11T14:29:02Z

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

@@ -1427,6 +1468,9 @@ open class CardBrowser :
    private fun redrawAfterSearch() {
        Timber.i("CardBrowser:: Completed searchCards() Successfully")
        updateList()
+        // Sets the first card as the current card by default after searching for cards
+        currentCardId = viewModel.cards[0].id


I'm not really a fan of this line.
If the card selected belongs to the new search result, I'd expect it to still appear on the right side.
By the way, it would make sense to scroll to it, so that you see what's displayed. (Note however that I would like this change only on fragmented screen. I don't think it'd make sense to scroll if no card is displayed)

(Please also update the documentation for currentCardId if you change the behaviour.

If the card selected belongs to the new search result, I'd expect it to still appear on the right side.

It's already there as you were expecting. Will you please reproduce once?

Seems to work the way I expected right now. I won't double check with the past version of the PR

Arthur-Milchior · 2024-08-11T14:32:29Z

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

@@ -1427,6 +1468,9 @@ open class CardBrowser :
    private fun redrawAfterSearch() {
        Timber.i("CardBrowser:: Completed searchCards() Successfully")
        updateList()
+        // Sets the first card as the current card by default after searching for cards


I am confused by your "by default".
I'm not even sure if it's "Set by default" or "current - by default - card"

I think you should update the comment of currentCardId. Clearly, it's not only the "card that was clicked". I'd go with

The card to display in the note editor. Either in the trailing fragment or in an opened activity. It is the last card clicked without entering or being in multi select mode. If no card were clicked, then it's the first card of the search result, if any. Thus, it's null iff no cards are displayed.

By the way, I would think that, in multi select mode, we'd still want to display the content of the last touched card on the trailing side of the screen. After all, seeing the note content may be helpful to realize whether it's actually what we wanted to select

By the way, I would think that, in multi select mode, we'd still want to display the content of the last touched card on the trailing side of the screen. After all, seeing the note content may be helpful to realize whether it's actually what we wanted to select

Ok

then no need to write comments here right ?

Sets the first card as the current card by default after searching for cards

Fine with no comment

Arthur-Milchior · 2024-08-11T14:53:36Z

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

+        // Checks if the NoteEditorFragment is not an instance of `SingleFragmentActivity`
+        // and assign it to the variable inFragmentedActivity. This indicates whether the fragment
+        // is hosted within a fragmented activity or not.
+        inFragmentedActivity = requireActivity().javaClass != SingleFragmentActivity::class.java


I feel like I already made similar comment while reviewing #16529. But, given the size of the discussion, I don't want to go look to confirm or not.

In my opinion, most of the information provided here should be the documentation of the variable.

The variable could be similar to the other PR.

/** * Whether this is displayed in a fragment view. * If true, this fragment is on the trailing side of the card browser. */

Also, I'd find it cleaner if, instead of looking for the activity (maybe one day we'll change the activities and get a strange but), you'd just use the bundle you used to open the fragment to decides whether it's fragmented or not. After all, it's an information the opener is certainly able to provide

Arthur-Milchior · 2024-08-11T15:29:50Z

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

@@ -466,6 +476,11 @@ class NoteEditor : AnkiFragment(R.layout.note_editor), DeckSelectionListener, Su
            )
            setIconColor(MaterialColors.getColor(requireContext(), R.attr.toolbarIconColor, 0))
        }
+        // Hide mainToolbar if this fragment is a part of fragmented activity


I already added remarks regarding the comment in the template previewer fragment. I'd appreciate if you could apply them here too.

Ideally, I'd state that there is so many part of the code in common that it'd be nice to have some code moved to the parent class. But I don't think that is realistic, so I'll just ask for copy paste of the changes I requested in the other PR

I don't understand what's wrong with my comment here

Simply that it repeat what the code states. The code already state "If this then that is gone". Usually we try to add comment if either the code is really long/complex and we can summarize, or the reason of the code is not clear to the reader

Arthur-Milchior · 2024-08-11T16:38:01Z

One fundamental principle of UI design is that the user must have feedback on their action.
In the stand-alone note editor, the "save" action also close the UI, which is clear feedback something occurred.
Given that we are not closing the view anymore, I believe we should have a snackbar/toast, saying "change saved"

Also, I'd be interested maybe in having a change of color in the tick. Or maybe a red dot, the same way that the "sync" button let you know you must sync, so it's clear where to click to save changes.

Arthur-Milchior · 2024-08-11T16:57:19Z

I'd appreciate if the selected card could always be highlighted. It does not seems to be the case, for example, if you move the current card to another deck, and get a new selected card instead

Arthur-Milchior · 2024-08-11T17:02:18Z

This menu is far too long. That's not usable.

I'm really not sure what the right behavior is during multi select.
I think that, on the short term, we should hide the note editor.
On the long term, it'd be nice to see the content of the note, but not being able to edit it. Just to provide informations to the user.
I understand that adding a "read only" feature to the note editor is outside the scope of GSoC. If you feel you can do it, great (still, check with David or any other reviewer whether they agree with me first).
Otherwise, just hiding the note editor will lead to a more consistent user experience that would be simple for you to implement, hopefully

david-allison · 2024-08-14T16:54:30Z

I understand that adding a "read only" feature to the note editor is outside the scope of GSoC. If you feel you can do it, great (still, check with David or any other reviewer whether they agree with me first).

Don't do this, we're going to move it to a common codebase at some point, and this will complicate matters

mikehardy · 2024-08-16T01:58:10Z

(just closing/reopening as I changed the set of github actions that run / are required, this re-triggers CI with the new set)

SanjaySargam · 2024-08-22T08:15:15Z

Another issue I found. Move to a deck with no card. You can still select the meny entry "copy note". And it'll copy the last selected note. This should become grayed. Same with, for "show toolbar" given that it lead to a crash if there is no note editor.

I plan to hide note_editor menu if deck is empty

Arthur-Milchior

I feel like some problem I mentioned above were not resolved:

save provide little feedback
Change can be lost

actually, "save" moves to the first card, but the selection still appear to be on the card that was selected, which is a very strange behavior.
I don't feel like we can merge this until those are resolved.

I appreciate that, in case of multi select, we don't have the problem of the huge menu anymore. Thats nice

@david-allison You still have your approval there, do you want to remove it or do you think it's mergeable?
Since the feature is disabled by default, I can hear that it's mergeable. Still, I prefer if we could fix those issues first.

Arthur-Milchior · 2024-08-31T10:54:34Z

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

+    // The card to display in the note editor. Either in the trailing fragment or in an opened activity.
+    // It is the last card clicked without entering or being in multi select mode.
+    // If no card were clicked, then it's the first card of the search result, if any.
+    // Thus, it's null if no cards are displayed.


I would have used "if and only if". So that it's clear that it's an equivalence. That there is no way for it to be null when cards are displayed.

Arthur-Milchior · 2024-09-01T02:08:10Z

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

@@ -1427,6 +1468,9 @@ open class CardBrowser :
    private fun redrawAfterSearch() {
        Timber.i("CardBrowser:: Completed searchCards() Successfully")
        updateList()
+        // Sets the first card as the current card by default after searching for cards
+        currentCardId = viewModel.cards[0].id


Seems to work the way I expected right now. I won't double check with the past version of the PR

Arthur-Milchior · 2024-09-01T02:08:32Z

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

@@ -1427,6 +1468,9 @@ open class CardBrowser :
    private fun redrawAfterSearch() {
        Timber.i("CardBrowser:: Completed searchCards() Successfully")
        updateList()
+        // Sets the first card as the current card by default after searching for cards


Fine with no comment

Arthur-Milchior · 2024-09-01T02:15:27Z

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

@@ -466,6 +476,11 @@ class NoteEditor : AnkiFragment(R.layout.note_editor), DeckSelectionListener, Su
            )
            setIconColor(MaterialColors.getColor(requireContext(), R.attr.toolbarIconColor, 0))
        }
+        // Hide mainToolbar if this fragment is a part of fragmented activity


Simply that it repeat what the code states. The code already state "If this then that is gone". Usually we try to add comment if either the code is really long/complex and we can summarize, or the reason of the code is not clear to the reader

On xlarge screen, display the NoteEditor on the trailing side of the CardBrowser This commit introduces a new view, cardbrowser.xml, that contains the card browser (implemented in card_browser.xml) and the note_editor on xlarge screen.

This commit ensures that NoteEditor menu will be visible in CardBroswer activity

This commit ensure that NoteEditor frame will be hide is the deck is empty

This commit ensures that when adding note from cardbrowser it will load note editor on trailing side instead of launching NoteEditor on new screen

This commit ensures that the selected card should be highlighted on large screens only. By default first card should be highlighted

Prompt users to save or discard changes dialog if there is unsaved changes in NoteEditor before moving to another note, preventing accidental data loss.

I changed the status of the PR, but forgot to remove my approval

SanjaySargam · 2024-09-03T11:08:16Z

I feel like some problem I mentioned above were not resolved:

save provide little feedback
Change can be lost
actually, "save" moves to the first card, but the selection still appear to be on the card that was selected, which is a very strange behavior.

@Arthur-Milchior Resolved

SanjaySargam added the GSoC Pull requests authored by a Google Summer of Code participant [Candidate/Selected], for GSoC mentors label Jul 19, 2024

SanjaySargam force-pushed the card-browser branch 3 times, most recently from 5997d1f to a49e64c Compare July 20, 2024 09:39

SanjaySargam added the Needs Review label Jul 20, 2024

SanjaySargam requested review from Arthur-Milchior and david-allison July 21, 2024 07:32

SanjaySargam force-pushed the card-browser branch from a49e64c to 72cb215 Compare July 24, 2024 17:29

david-allison reviewed Jul 24, 2024

View reviewed changes

SanjaySargam force-pushed the card-browser branch from 72cb215 to 241a1f9 Compare July 25, 2024 15:49

david-allison previously approved these changes Aug 1, 2024

View reviewed changes

david-allison added Needs Second Approval Has one approval, one more approval to merge and removed Needs Review labels Aug 1, 2024

Arthur-Milchior reviewed Aug 11, 2024

View reviewed changes

david-allison self-requested a review August 11, 2024 16:36

david-allison added Needs Author Reply Waiting for a reply from the original author Needs Review and removed Needs Second Approval Has one approval, one more approval to merge labels Aug 11, 2024

SanjaySargam force-pushed the card-browser branch from 241a1f9 to e9b1a0c Compare August 15, 2024 04:40

mikehardy closed this Aug 16, 2024

mikehardy reopened this Aug 16, 2024

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

SanjaySargam force-pushed the card-browser branch from e9b1a0c to 56f2394 Compare August 22, 2024 08:49

SanjaySargam removed Has Conflicts Needs Author Reply Waiting for a reply from the original author labels Aug 22, 2024

SanjaySargam requested a review from Arthur-Milchior August 22, 2024 08:58

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

SanjaySargam force-pushed the card-browser branch from 56f2394 to 028d962 Compare August 29, 2024 14:48

david-allison removed the Has Conflicts label Aug 29, 2024

Arthur-Milchior reviewed Sep 1, 2024

View reviewed changes

SanjaySargam added 6 commits September 1, 2024 18:36

attach NoteEditor to CardBrowser

4462da9

On xlarge screen, display the NoteEditor on the trailing side of the CardBrowser This commit introduces a new view, cardbrowser.xml, that contains the card browser (implemented in card_browser.xml) and the note_editor on xlarge screen.

combine noteeditor menu into cardbrowser menu

5f5f841

This commit ensures that NoteEditor menu will be visible in CardBroswer activity

hide fragment when deck is empty

df88953

This commit ensure that NoteEditor frame will be hide is the deck is empty

loadNoteEditor when adding note

06d2403

This commit ensures that when adding note from cardbrowser it will load note editor on trailing side instead of launching NoteEditor on new screen

highlight selected card

9cccf86

This commit ensures that the selected card should be highlighted on large screens only. By default first card should be highlighted

show save dialog if there are unsaved changes

a027b8c

Prompt users to save or discard changes dialog if there is unsaved changes in NoteEditor before moving to another note, preventing accidental data loss.

SanjaySargam force-pushed the card-browser branch from 028d962 to a027b8c Compare September 1, 2024 19:26

SanjaySargam requested a review from Arthur-Milchior September 1, 2024 19:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GSoC'24] Add NoteEditor to CardBrowser #16764

[GSoC'24] Add NoteEditor to CardBrowser #16764

SanjaySargam commented Jul 19, 2024

david-allison left a comment

Arthur-Milchior commented Aug 11, 2024

Arthur-Milchior left a comment

Arthur-Milchior Jul 31, 2024

Arthur-Milchior Aug 10, 2024

Arthur-Milchior Aug 11, 2024

Arthur-Milchior Aug 11, 2024

SanjaySargam Aug 14, 2024

Arthur-Milchior Sep 1, 2024

Arthur-Milchior Aug 11, 2024

SanjaySargam Aug 14, 2024 •

edited

Loading

Arthur-Milchior Sep 1, 2024

Arthur-Milchior Aug 11, 2024

Arthur-Milchior Aug 11, 2024

SanjaySargam Aug 14, 2024

Arthur-Milchior Sep 1, 2024

Arthur-Milchior commented Aug 11, 2024

Arthur-Milchior commented Aug 11, 2024

Arthur-Milchior commented Aug 11, 2024

david-allison commented Aug 14, 2024 •

edited

Loading

mikehardy commented Aug 16, 2024

SanjaySargam commented Aug 22, 2024

Arthur-Milchior left a comment

Arthur-Milchior Aug 31, 2024

Arthur-Milchior Sep 1, 2024

Arthur-Milchior Sep 1, 2024

Arthur-Milchior Sep 1, 2024

SanjaySargam commented Sep 3, 2024

[GSoC'24] Add NoteEditor to CardBrowser #16764

Are you sure you want to change the base?

[GSoC'24] Add NoteEditor to CardBrowser #16764

Conversation

SanjaySargam commented Jul 19, 2024

Purpose / Description

Approach

How Has This Been Tested?

Checklist

david-allison left a comment

Choose a reason for hiding this comment

Arthur-Milchior commented Aug 11, 2024

Arthur-Milchior left a 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

SanjaySargam Aug 14, 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

Arthur-Milchior commented Aug 11, 2024

Arthur-Milchior commented Aug 11, 2024

Arthur-Milchior commented Aug 11, 2024

david-allison commented Aug 14, 2024 • edited Loading

mikehardy commented Aug 16, 2024

SanjaySargam commented Aug 22, 2024

Arthur-Milchior left a 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

SanjaySargam commented Sep 3, 2024

SanjaySargam Aug 14, 2024 •

edited

Loading

david-allison commented Aug 14, 2024 •

edited

Loading