Add Manga Notes

[imkunet]

Foreword

This is my first time ever working on anything Android related (the time of me downloading Android Studio is about two days ago), so any feedback on how to improve or pointing out any pitfalls is appreciated. This is also my first time contributing to a medium-sized open source project.

Manga Notes

What

This feature adds built-in per-manga markdown¹ notes to help remember the details of manga inside and outside your library. It can be accessed through the top overflow menu or a button just below the tags through a button.

Why

Picture this: you have 50 or so forgettable isekai² manga in your library. Because they are all in fact the same story with slight modifications, you lose track of the individual differences in each manga.

With the notes feature, you can add small (or large) reminders about the plot to each (easily) forgettable manga to make the reading experience of new chapters not completely horrible.

Intentions

I will commit to helping maintain this feature (when necessary) and improve this feature as to not place undue burden upon existing project maintainers.

Known issues

• No collapsing/expanding notes on manga screen
  Addressed: Recent design revisions have the manga notes in the collapsible description section
• Manga screen lazy list "jumps" when there is an extraordinarily long note Addressed: it's in the desc box now
• No limit on note size (in theory could work correctly with notes 2^31-1 characters long, but not tested)
  Addressed: Imposed a 10k length limit with a visible warning when close to limit (tested) (it is now 250)
• AOSP keyboard hates all Mihon TextFields and its auto-suggestion selects 1 space character extra behind the current word (not related to this feature itself)
• Possibly conflicts with Edit basic Manga information #398

---

Demonstration

Old video

Revised.mp4

(latest video)

animations.mp4

Footnotes

1. Markdown was chosen over something like rich text for being just enough for formatting if ever needed without requiring any additional bundle overhead without interfering with normal text.
   EDIT: The current revision uses rich text (HTML) for compatibility with the WYSIWYG editor EDIT 2: Back to markdown! ↩

2. Meaning: "Another world" ↩

[imkunet]

This comment is no longer relevant.

With the new rebase on main as well as the 0e0a9aa (Make spotless) commit (as well as the detekt gradle task) the information in this comment no longer makes any sense.

Its contents are hidden here for posterity.

Hidden

Commenting on the remaining failing ./gradlew detekt violations after ce9a3ac¹:

---

This is a pre-existing issue with this function.

/mihon/data/src/main/java/tachiyomi/data/manga/MangaMapper.kt:8:17 [LongParameterList]
The function mapManga(...) has too many parameters. The current threshold is set to 6.

This is a pre-existing issue with this function.

/mihon/data/src/main/java/tachiyomi/data/manga/MangaMapper.kt:58:24 [LongParameterList]
The function mapLibraryManga(...) has too many parameters. The current threshold is set to 6.

This is a pre-existing issue with this data class.

/mihon/app/src/main/java/eu/kanade/tachiyomi/data/backup/models/BackupManga.kt:43:18 [MagicNumber]
This expression contains a magic number. Consider defining it to a well named constant.

Pretty much all the previews in the codebase have the same issue.

/mihon/app/src/main/java/eu/kanade/presentation/manga/components/MangaNotesSection.kt:96:13 [UnusedPrivateMember]
Private function MangaNotesSectionPreview is unused.

---

Let me know if there are any important issues that need to be fixed.

Footnotes

1. detekt errors re-formatted for reading convenience ↩

[CrepeTF]

I've created a mock-up for this.

User interaction would be:
View -> (Sheet or fullscreen page presenting the full note)
↳ Edit notes -> Save

[Turhvjbufv]

Why not view and edit notes buttons?(Instead of only the view button)
Seems like an extra step for nothing

[imkunet]

Hi @CrepeTF .

I'm not sure if putting it in a outlined rounded rectangle is a good idea.

The padding on the sides removes vertical space that can be used for text and the button is quite distracting as I believe the text of your notes are should be first and foremost.

On the other hand, I like how attention grabbing it is and draws your attention to whatever you wrote about the manga. Perhaps there is a middle ground somewhere? It might be weird to have a big colored notes box when there are no notes added yet.

[imkunet]

Rebased off of main, prevent silly merge commit from messing everything up. :)

[AntsyLich]

Good to see you're still motivated despite me not reviewing. If you can hop on to Mihon discord for design discussion that'll be great.

[imkunet]

Updated demonstration video with recent changes:

Preview.mp4

[KairuDeibisu]

Is this still being worked on?

[imkunet]

There has been discussion in the Discord right around the time I stopped working on this about the exact character limit, particularly opposing thoughts on whether markdown or html or richtext should be used, or whether the characters are to be limited to 250. At the moment, I'm not quite sure what to do... though later today I might do a rebase and recheck the sentiment in the Discord chat with respect to the current feature set.

[imkunet]

animations.mp4

[AntsyLich]

Add changelog entry

[imkunet]

Missed some names because of the vestiges of how it used to work, hopefully that's been smoothed over now. Thanks for the catch!

[AntsyLich]

Aside from this i'm more or less satisfied. I'll do a deep look land merge it on the weekend

[AntsyLich]

Suggested change

	class SetMangaNotes(
	private val mangaRepository: MangaRepository,
	) {
	suspend fun awaitSetNotes(mangaId: Long, notes: String): Boolean {
	class UpdateMangaNotes(
	private val mangaRepository: MangaRepository,
	) {
	suspend fun await(mangaId: Long, notes: String): Boolean {

[AntsyLich]

Suggested change

	fun saveText(content: String) {
	fun updateNotes(content: String) {