[GSoC'24] Feature: Instant Note Editor to allow adding cloze card #16393

criticalAY · 2024-05-14T17:29:12Z

Purpose / Description

GSOC

On top of:

[GSoC'24] Init: Instant Note Editor Activity #16497

This PR aims to provide basic functionality for the instant note editor i.e. allowing the user to add cloze card without actually opening AnkiDroid application, to achieve this we utilize a transparent activity with custom theme.

The activity has intent filter to register and receive text when user taps share button after selecting text
Instant card label used for the activity
EditTextGestureHelper allows user to single tap and turn words to cloze
User can also long press and select multiple words/text and turn it to cloze
Deck spinner allows user to change deck
User can tap in/out manual mode if wanted
Cloze increment button allows user to increment cloze number

How Has This Been Tested?

OnePlus Nord CE:
Current UI:

Record_2024-06-02-02-02-58.mp4

Learning (optional, can help others)

How we can use transparent activities [Google and Stackoverflow but didn't save links to them]

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-05-14T17:29:24Z

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,

david-allison

Brief thoughts, not a thorough review

AnkiDroid/src/main/AndroidManifest.xml

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/EditFieldState.kt

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/TextSurroundHelper.kt

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

david-allison · 2024-05-14T19:35:27Z

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

+    }
+
+    private fun changeToClozeType() {
+        val model = getColUnsafe.notetypes.all().first { noteType ->


A user may have more than one 'cloze' note type

Probably needs an option to select the desired one

First select the note type (cloze) then editor dialog or should we allow that from the dialog itself?

Pick a reasonable default, and have an 'options' menu where power users can change it

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/EditFieldState.kt

criticalAY · 2024-05-14T23:35:31Z

I have extracted the long press callback here:

[GSoC'24] chore: extract ActionMode.Callback from NoteEditor #16401

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

ShridharGoel · 2024-05-19T15:13:02Z

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

+            ).apply {
+                initializeNoteEditorDeckSpinner(col)
+                launchCatchingTask {
+                    selectDeckById(deckId, true)


What if deckId isn't loaded yet?

Shouldn't happen but just in case it happens then deck with index 1 will be loaded i.e.
i.e. config.get(Decks.CURRENT_DECK) ?: 1L

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt

AnkiDroid/src/test/java/com/ichi2/anki/instanteditor/InstantEditorViewModelTest.kt

david-allison

Looking really good!

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt

AnkiDroid/src/test/java/com/ichi2/anki/instanteditor/InstantEditorViewModelTest.kt

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

david-allison · 2024-06-01T00:00:57Z

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

+        /** Allows to keep track of the current cloze number, reset to 0 when activity is destroyed **/
+        var currentClozeNumber: Int = 0


Shouldn't this exist in the ViewModel?

This shouldn't be global

No, this is also used in the custom text helper to track and put clozes hence not in viewModel

This shouldn't be global

* Activity to support adding notes without opening AnkiDroid * Text surround helper to tap and turn to cloze * unitTest: InstantEdtitorViewModel unit test

david-allison

I'm /REALLY/ happy, either last, or penultimate review.

The aim of TODOs is to add them and not block the review on code changes

If they seem to be trivial, feel free to do them

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

david-allison · 2024-06-01T23:00:03Z

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

+        /** Allows to keep track of the current cloze number, reset to 0 when activity is destroyed **/
+        var currentClozeNumber: Int = 0


This shouldn't be global

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt

* added TODOs to the viewModel and activity

david-allison

LGTM, some TODOs to be handled later

Congrats! It's happening 🎊

david-allison · 2024-06-02T09:36:43Z

Blocked on: Updated strings from Crowdin 2024/06/02 09:01 #16526

github-actions · 2024-06-03T17:42:34Z

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 bot added the Strings label May 14, 2024

criticalAY changed the title ~~Feature: Instant Note Editor to allow adding cloze card~~ [GSOC'24] Feature: Instant Note Editor to allow adding cloze card May 14, 2024

criticalAY added Needs Review GSoC Pull requests authored by a Google Summer of Code participant [Candidate/Selected], for GSoC mentors labels May 14, 2024

criticalAY force-pushed the instant-note-editor branch from 2fb94c9 to cbba540 Compare May 14, 2024 17:36

criticalAY requested review from david-allison and ShridharGoel May 14, 2024 17:37

criticalAY force-pushed the instant-note-editor branch from 9880043 to 2801a2f Compare May 14, 2024 18:08

david-allison reviewed May 14, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/EditFieldState.kt Outdated Show resolved Hide resolved

criticalAY changed the title ~~[GSOC'24] Feature: Instant Note Editor to allow adding cloze card~~ [GSoC'24] Feature: Instant Note Editor to allow adding cloze card May 14, 2024

criticalAY force-pushed the instant-note-editor branch 2 times, most recently from 182ab0e to 0912aa3 Compare May 15, 2024 18:43

ShridharGoel reviewed May 16, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt Outdated Show resolved Hide resolved

ShridharGoel reviewed May 16, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt Outdated Show resolved Hide resolved

ShridharGoel reviewed May 19, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt Outdated Show resolved Hide resolved

ShridharGoel reviewed May 19, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt Show resolved Hide resolved

ShridharGoel reviewed May 19, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt Outdated Show resolved Hide resolved

ShridharGoel reviewed May 19, 2024

View reviewed changes

david-allison reviewed May 21, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantNoteEditorActivity.kt Outdated Show resolved Hide resolved

github-actions bot added the Has Conflicts label May 22, 2024

criticalAY force-pushed the instant-note-editor branch from 9546fe4 to c3a0191 Compare May 22, 2024 18:30

criticalAY removed the Has Conflicts label May 22, 2024

ShridharGoel reviewed May 26, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt Outdated Show resolved Hide resolved

ShridharGoel reviewed May 26, 2024

View reviewed changes

AnkiDroid/src/main/java/com/ichi2/anki/instantnoteeditor/InstantEditorViewModel.kt Show resolved Hide resolved

criticalAY force-pushed the instant-note-editor branch from 7858409 to 4cbd03b Compare May 26, 2024 21:53

criticalAY requested review from ShridharGoel and david-allison May 27, 2024 11:26

david-allison reviewed May 31, 2024

View reviewed changes

criticalAY mentioned this pull request May 31, 2024

[Code] Extract "text/plain" as constant #16508

Closed

4 tasks

david-allison reviewed Jun 1, 2024

View reviewed changes

criticalAY force-pushed the instant-note-editor branch from 658e1b9 to 888e019 Compare June 1, 2024 09:30

github-actions bot added the Has Conflicts label Jun 1, 2024

criticalAY force-pushed the instant-note-editor branch 2 times, most recently from 6c1211a to ddce37d Compare June 1, 2024 16:24

criticalAY removed Has Conflicts Strings labels Jun 1, 2024

feature: Instant Note Editor to allow adding cloze card

d1f13c1

* Activity to support adding notes without opening AnkiDroid * Text surround helper to tap and turn to cloze * unitTest: InstantEdtitorViewModel unit test

criticalAY force-pushed the instant-note-editor branch from f2052e3 to d1f13c1 Compare June 1, 2024 16:42

set the activity to dev only

a38908e

criticalAY added the Strings label Jun 1, 2024

ShridharGoel approved these changes Jun 1, 2024

View reviewed changes

criticalAY added Needs Second Approval Has one approval, one more approval to merge and removed Needs Review labels Jun 1, 2024

david-allison requested changes Jun 1, 2024

View reviewed changes

refactor: activity to use viewModel to set warning

c58f6fd

* added TODOs to the viewModel and activity

david-allison approved these changes Jun 2, 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 Jun 2, 2024

criticalAY mentioned this pull request Jun 3, 2024

[GSoC'24] Enhancements: Instant Note Editor Improvements #16534

Open

5 tasks

lukstbit added this pull request to the merge queue Jun 3, 2024

Merged via the queue into ankidroid:main with commit dfe33b6 Jun 3, 2024
8 checks passed

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 Jun 3, 2024

github-actions bot added this to the 2.19 release milestone Jun 3, 2024

lukstbit mentioned this pull request Jun 3, 2024

Updated strings from Crowdin 2024/06/03 17:47 #16539

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GSoC'24] Feature: Instant Note Editor to allow adding cloze card #16393

[GSoC'24] Feature: Instant Note Editor to allow adding cloze card #16393

criticalAY commented May 14, 2024 •

edited

github-actions bot commented May 14, 2024

david-allison left a comment

david-allison May 14, 2024

criticalAY May 14, 2024

david-allison May 14, 2024

criticalAY commented May 14, 2024

ShridharGoel May 19, 2024

criticalAY May 20, 2024

david-allison left a comment

david-allison Jun 1, 2024

criticalAY Jun 1, 2024

david-allison Jun 1, 2024

david-allison left a comment •

edited

david-allison Jun 1, 2024

david-allison left a comment •

edited

david-allison commented Jun 2, 2024

github-actions bot commented Jun 3, 2024

		/ Allows to keep track of the current cloze number, reset to 0 when activity is destroyed /
		var currentClozeNumber: Int = 0

[GSoC'24] Feature: Instant Note Editor to allow adding cloze card #16393

[GSoC'24] Feature: Instant Note Editor to allow adding cloze card #16393

Conversation

criticalAY commented May 14, 2024 • edited

Purpose / Description

GSOC

How Has This Been Tested?

Learning (optional, can help others)

Checklist

github-actions bot commented May 14, 2024

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

Choose a reason for hiding this comment

criticalAY commented May 14, 2024

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

Choose a reason for hiding this comment

david-allison left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

david-allison left a comment • edited

Choose a reason for hiding this comment

david-allison commented Jun 2, 2024

github-actions bot commented Jun 3, 2024

criticalAY commented May 14, 2024 •

edited

david-allison left a comment •

edited

david-allison left a comment •

edited