Add an option to allow both viewing and adding duplicates

[eloyrobillard]

Overview

This PR keeps add buttons on when the term has a duplicate:

This way the user can both add duplicate notes and check current duplicates if they wish to. As mentioned below this is mainly useful when mining for:

• a term with several different meanings
• a term with a difficult meaning / unclear how to use it in a sentence, where several example sentences help

Also, as @Maltesaa mentioned: this helps to recreate a card for suspended notes without having to manually delete those suspended notes

Based on #74

[github-actions]

⚠️ Visual differences introduced by this PR; please validate if they are desirable.

View Playwright Report (note: open the "playwright-report" artifact)

[toasted-nutbread]

Prior to getting into the details of the implementation, a question: in your experience, how frequent is it that you need to do this? Or anyone else as well, how frequently is it a problem that there is already a note but you want to add another "duplicate" note?

[eloyrobillard]

Prior to getting into the details of the implementation, a question: in your experience, how frequent is it that you need to do this? Or anyone else as well, how frequently is it a problem that there is already a note but you want to add another "duplicate" note?

Can't speak for anyone else, but this is the one feature I've always wished Yomichan/Yomitan offered (and looking at #74, I'm not the only one).
I'd say I add duplicates for about 5-10% of the terms, usually for 2 reasons:

• one term with several different meanings
• one term with a difficult meaning / unclear how to use it in a sentence, where several example sentences help (more than one sentence per card takes too long to read imo, so I split them up)

[toasted-nutbread]

Okay, the reason behind my asking is because IMO this should probably not be an option, but just be a right-click menu on the buttons or something like that.

[eloyrobillard]

Okay, the reason behind my asking is because IMO this should probably not be an option, but just be a right-click menu on the buttons or something like that.

@toasted-nutbread

1. As part of the existing Note IDs right-click menu for example, or on a different button?

2. Do you favor right-click menus because they are better at hiding advanced features, or for a different reason?
   If it's indeed to hide them, that may be hiding it too well. For the note IDs menu, for example, I couldn't find any info aside from random comments in GitHub.

The made gain of having this as an option as that it can be left on forever¹. Also, options are easy to document in the UI. Maybe it could be put all the way at the bottom of the "Check for card duplicates" section to further hide it, and call it "[Advanced]" or "Dangerously enable add buttons".

Or maybe even add an "You have duplicates for this card. Are you sure you want to add a new card?" alert when clicking the add buttons.

Footnotes

1. So that I only have to click the add button, as opposed to right-click + left-click every time. ↩

[Maltesaa]

Or anyone else as well, how frequently is it a problem that there is already a note but you want to add another "duplicate" note?

• one term with several different meanings
• one term with a difficult meaning / unclear how to use it in a sentence, where several example sentences help (more than one sentence per card takes too long to read imo, so I split them up)

Another use case for this is when you want to recreate a card for suspended notes, I do this all the time.

You could ofc just delete or move the suspended cards to another deck, but not having to remember to do that would be nice. Having duplicates would also make it so you're able to see that the already existing note has the leech tag which would be helpful when making the card.

[djahandarie]

@eloyrobillard
Regarding UI:

• I agree with @toasted-nutbread that this should not be a setting, as our settings page is way to complicated, and having settings introduces quite a bit of complexity into the codebase where you need to account for the combinatorial explosion of potential ways the app can be configured when trying to make any wide change after-the-fact
• That said, I think right click menus are basically not a feasible UI pattern in browsers as they are very rare and almost no one would think to right click on stuff. I don't think we should use them at all.
• I think we can achieve a decent "always-on" UI here by use of better iconography. For example, the plus icon can change into a "stacked" plus icon (i.e., the icon duplicated ontop of itself once and shifted maybe ~3px up and to the right), and change the hover text to indicate it's a duplicate add.

What do you think?

[eloyrobillard]

@djahandarie

The stacked "+" icon sounds fun, I'd be happy to implement it.

It would only show up when "Check for cards duplicates" is on, right?
In which case the description for "Check for card duplicates" wouldn't need to say "the add buttons will be disabled" anymore?

[Kuuuube]

I think it would be best if the icon shows up always. But when "Check for cards duplicates" is on it shouldnt let you add a duplicate and should be grayed out similar to how it is now.

Although this does make the option's name a bit of a misnomer I think that would best integrate into how things currently are done.

[eloyrobillard]

I think it would be best if the icon shows up always. But when "Check for cards duplicates" is on it shouldnt let you add a duplicate and should be grayed out similar to how it is now.

When we don't check for duplicates how would we choose between the normal or stacked "+" icon, since we wouldn't know if there are duplicates?

[Kuuuube]

It would have to always check for duplicates like that.

The main issue I see here with keeping the button active always when is "Check for cards duplicates" is on is visual clarity. At a very quick glance a user may not see the difference between a stacked + and a single +. If we're going to go that route and keep the option actually checking for dupes or not, maybe it should be something that stands out more like a red + when dupes are found instead.

[Kuuuube]

Though, red vs green raises its own issues (colorblindness). So maybe red and stacked makes the most sense.

[eloyrobillard]

True. Could also be a smaller circle in top-right of the "+" icon showing the number of duplicates.

Either way, always checking for duplicates is probably not an option since it would make Anki/AnkiConnect freeze for some users with ultra-massive Anki collections (as per FooSoft#993).

[Kuuuube]

Heres my suggestion for the icons, made them stacked based on what darius suggested as well:

If you want to use these heres the files icons.zip (they go into ext\images)

[codspeed-hq]

CodSpeed Performance Report

Merging #693 will degrade performances by 19.65%

_{Comparing eloyrobillard:add-duplicates-while-checking-for-them (1b860a6) with master (e47a0f4)}

Summary

⚡ 1 improvements
❌ 1 regressions
✅ 2 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	master	eloyrobillard:add-duplicates-while-checking-for-them	Change
⚡	transformations (n=57)	54.7 ms	37.2 ms	+47.13%
❌	Translator.prototype.findTerms - (n=39)	790.9 ms	984.2 ms	-19.65%

[eloyrobillard]

Here's what I have for now (using @Kuuuube's buttons):

The new add buttons only show up when the entry has duplicates in Anki (so only when "Check for card duplicates" is on).

[Kuuuube]

Gave it a test, it works well. Just needs a commit to actually add the svgs.

[eloyrobillard]

added the SVGs

[djahandarie]

@toasted-nutbread If you have any comments on the code please go ahead and review, otherwise will merge in a day or two

[toasted-nutbread]

New icons should probably be added to resources/icons.svg as new layers, as this has generally served as the source for editing icons. Idk if anyone has modified this since Yomichan, but I used Inkscaped for it.

[eloyrobillard]

New icons should probably be added to resources/icons.svg as new layers, as this has generally served as the source for editing icons. Idk if anyone has modified this since Yomichan, but I used Inkscaped for it.

done

[djahandarie]

Thanks for sticking through the long peer review process!

[StefanVukovic99]

Belated, but the description in settings

doesn't seem to fit the way it now works?

May also be good to update/expand the docs at https://github.com/themoeway/yomitan/blob/7681131782d958997663b1fb443a3e32e8eef550/docs/anki-integration.md?plain=1#L108 to explain the new feature.