Add color highlight menu #11044

smasher816 · 2023-10-26T16:56:40Z

Pass a configurable ColorRGB32 to bb:paintRect / bb:lightenRect.
If isColorEnabled is unset then original B&W Color8/uint8_t is passed in.

Requires corresponding Cbb patch.
koreader/koreader-base#1680

Fix #9024

ChangeLog:

ReaderHighlight: Add a "Highlight color" submenu (via a single column button on the last row) to the "Highlight style" dialog. Works for every style except invert ;).
ReaderHighlight: Same for the "Highlight style" submenu, where you can change the defaults and mass update existing annotations.
ReaderHighlight: Default to yellow highlights on isColorEnabled devices.
ReaderHighlight: Reword the "Highlight opacity" stuff now that it only applies to gray.
ReaderView: Ensure pages with color highlights will use a Kaleido waveform mode on compatible devices.
ReaderView: And, of course, support drawing color highlights ;).
PDFDocument: Support drawing color annotations.
CheckButton: Support a bold & bgcolor being set, and forward that to TextWidget
RadioButtonTable: Support bold, fgcolor & bgcolor
RadioButtonWidget: Allow caller to specify that colors are used (via a new colorful field), and use that information to make sure the refresh will use a Kaleido waveform mode on compatible devices.
TextBoxWidget: Support color fg & bg colors (you previously could only use grayscale shades, i.e., Color8, like in basically all our UI ;p).
Terminal: Completely random drive-by log message tweak when the device doesn't support the plugin.
Misc: Clarify the lightenRect/darkenRect calls across the codebase.

(Depends on koreader/koreader-base#1680)

This change is

smasher816 · 2023-10-26T17:08:08Z

Initial inspiration. #9024 (comment)

frontend/apps/reader/modules/readerview.lua

hius07 · 2023-10-27T05:03:45Z

Since the color is constant within a page, it can be calculated outside of the loop on each box.

frontend/apps/reader/modules/readerhighlight.lua

frontend/apps/reader/modules/readerview.lua

hius07 · 2023-10-27T07:39:30Z

people will want different color per highlight

In view of this in the future, the general setting should be done as a submenu, not RadioButtonWidget, similar to highlight style.
RadioButtonWidget would be used in a certain highlight style editing (personal style would include drawer, color and maybe opacity).

hius07 · 2023-10-27T07:48:09Z

BTW, we do not have a feature "apply default style to all highlights in the book", it might be useful.

ryanwwest · 2023-10-27T20:57:24Z

Initial inspiration. #9024 (comment)

This is great. I was wondering if the highlight colors could possibly match the default hex colors offered in Zotero, if they aren't finalized? It looks like what you currently have is already very close and that issue also mentions Zotero. I'd like to at some point develop some sort of sync between Zotero highlights and KOReader highlights so you can read/write them in either app and this would solve one of the big issues listed here. The colors seem to be these.

smasher816 · 2023-10-28T04:39:15Z

Newest revision now supports per-highlight colors. This extra info should be part of highlight exports, thus making it queryable to outside integrations.
Settings menu is disabled if color screen is not present.

@hius07 I fail to see how the radio menu is bad. It seems to work fine for both setting the default, and for editing a single highlight.
Apply default style to all highlights can be a future MR.

@ryanwwest the color values came from the Onyx drawing app. These are pretty finicky in that certain colors appear identical (I had to manually tweak orange to not be the same as yellow). I suspect that really these may need to be tweaked per-device.
I think it might be a good idea to make the list of colors configurable using a table in settings.lua, but I'm unsure how much work that would be. Edits to the config would likely have to be manual (or through the advance screen) since there is no easy way to edit these values. Regardless, I think this can be a future addition to avoid feature creep.
For the Zotero integration, I don't think it would be tough to have a lookup table / translation layer to accomplish your goal.

frontend/apps/reader/modules/readerhighlight.lua

smasher816 · 2023-10-28T13:36:56Z

Latest revision allows for customizable colors in settings.lua
(this one is for you @ryanwwest )

    ["highlight_colors"] = {
        [1] = {
            [1] = "Rojo",
            [2] = "#fe4400",
        },
        [2] = {
            [1] = "Naranja",
            [2] = "#ff8800",
        },
        [3] = {
            [1] = "Amarillo",
            [2] = "#fdff32",
        },
        [4] = {
            [1] = "Verde",
            [2] = "#00ad65",
        },
        [5] = {
            [1] = "Morada",
            [2] = "#ee00ff",
        },
        [6] = {
            [1] = "Gris Oscuro",
            [2] = "#303030",
        },
    },

Edit color button is now completely removed on non-color devices.

frontend/apps/reader/modules/readerhighlight.lua

smasher816 · 2023-10-28T13:59:43Z

Newest revision should now pass in pdf annotation colors to mupdf backend.
Base MR has also been updated to receive this value.

ryanwwest · 2023-10-28T14:12:23Z

Latest revision allows for customizable colors in settings.lua (this one is for you @ryanwwest )

Thanks. FYI, the way Zotero allows highlight colors is it directly stores (with the highlight) any color hex code and displays that color. But the UI color picker that shows up when you select text to highlight only has like 8 or 9 preset colors, so users don't usually see other colors. I'm not sure if that would also work here (not looking super closely at the code) but if not it might be okay. As a future annotation syncer plugin with Zotero could instead create a new highlight_colors entry with each incoming zotero color hex code not already found in the table.

smasher816 · 2023-10-28T15:45:41Z

Custom colors are now with patches.
See #11044 (comment)

poire-z · 2023-10-28T16:16:54Z

Should we really save the rgbcolor (#FF0000) in the highlight item?
Wouldn't it be cleaner/more abstract if we save keywords (red, green...) - so the change-color-dialog shows always something checked - and we can change what color is "red" and have it apply to all past "red" highlights ?

ryanwwest · 2023-10-28T16:20:18Z

Should we really save the rgbcolor (#FF0000) in the highlight item? Wouldn't it be cleaner/more abstract if we save keywords (red, green...) - so the change-color-dialog shows always something checked - and we can change what color is "red" and have it apply to all past "red" highlights ?

I'd prefer the rgbcolor itself to be saved into each highlight item as then it allows any number of highlight colors (and also easier for future sync with Zotero). It seems confusing to me to change the color of 'red' to be a non-red color (slight shades of red variation makes more sense but I'm not thinking of a common use case for this).

poire-z · 2023-10-28T16:30:34Z

change the color of 'red' to be a non-red color (slight shades of red variation makes more sense but I'm not thinking of a common use case for this).

I was thinking about the "slight shades of red" case, just for people wanting to adjust the red saturation/tone to make it more readable to them on their devices (color eInk or Android) when set on a black or blue or grey text - they may want to make it lighter or darker when they later meet greyish text in books and realize that initial red is not working well in some cases.

I don't think people are so in love with red that they will want to override our blue to be another kind of lighter red than our red, and our yellow to be another variation of
https://www.color-meanings.com/shades-of-red-color-names-html-hex-rgb-codes/
(but I may be wrong :)

ryanwwest · 2023-10-28T16:33:00Z

Well you could have both - hex codes to allow any color, and some preset red/green/yellow string which is mapped to a configurable hex code. I see benefits for both of them..

ryanwwest · 2023-10-28T16:35:33Z

I am not sure how this fits in with the existing highlight styles. is it just a new field, separate and in addition to underline/strikeout/invert/highlight, or do you have a color in place of those? I'm indifferent to either option, though I don't know if invert fits with colors.

poire-z · 2023-10-28T16:36:18Z

I'm not thinking so much about users of external tools, just our internal code - and it feels keywords would allow more future features than harcoded color codes - ie what we do with underline/striken, one could in the bookmark list show all "red" highlights only, if for that user, "red" means "typo error to correct", etc...

smasher816 · 2023-10-28T16:37:46Z

Saving the name still allows for "any number of highlight colors". I don't see any downside to doing that, and having the ability to easily patch old highlights seems useful to me.
And ryam, it'. separate field. You can still highlight/underline/strikeout with the selected color. It just changes how it is shown.
Invert has no color option, since it flips whatever is already drawn on the page.

smasher816 · 2023-10-28T20:17:58Z

ReaderHighlight now stores string names, and ReaderView now has a name->rgb lookup table.
There are fallbacks if a lookup fails (someone may add a new name in a patch which is then later disabled).

NiLuJe

Reviewed 7 of 8 files at r19, 1 of 1 files at r20, 1 of 1 files at r21, all commit messages.
Reviewable status: all files reviewed, 24 unresolved discussions (waiting on @hius07, @poire-z, and @smasher816)

NiLuJe · 2024-08-27T10:47:50Z

ChangeLog:

ReaderHighlight: Add a "Highlight color" submenu (via a single column button on the last row) to the "Highlight style" dialog. Works for every style except invert ;).
ReaderHighlight: Same for the "Highlight style" submenu, where you can change the defaults and mass update existing annotations.
ReaderHighlight: Default to yellow highlights on isColorEnabled devices.
ReaderHighlight: Reword the "Highlight opacity" stuff now that it only applies to gray.
ReaderView: Ensure pages with color highlights will use a Kaleido waveform mode on compatible devices.
ReaderView: And, of course, support drawing color highlights ;).
PDFDocument: Support drawing color annotations.
CheckButton: Support a bold & bgcolor being set, and forward that to TextWidget
RadioButtonTable: Support bold, fgcolor & bgcolor
RadioButtonWidget: Allow caller to specify that colors are used (via a new colorful field), and use that information to make sure the refresh will use a Kaleido waveform mode on compatible devices.
TextBoxWidget: Support color fg & bg colors (you previously could only use grayscale shades, i.e., Color8, like in basically all our UI ;p).
Terminal: Completely random drive-by log message tweak when the device doesn't support the plugin.
Misc: Clarify the lightenRect/darkenRect calls across the codebase.

(Depends on koreader/koreader-base#1680)

NiLuJe · 2024-08-27T10:51:17Z

Commit history will be archived in my color-highlights branch

hius07 · 2024-08-27T10:59:17Z

frontend/apps/reader/modules/readerhighlight.lua

+                    return T(_("Highlight color: %1"), string.lower(v[1]))
+                end
+            end
+            return T(_("Highlight color: %1"), saved_color)


For what color?

Not sure I understand the question ;).

But: all of them? This is to set the defaults, so you have access to all of them (including gray).

It is executed when saved_color is not in self.highlight_colors.

I still don't understand where you're going with that, sorry ;).

If the color is unsupported (somehow, that would require some pretty heinous trickery I guess?), this would show the actual color name stored, but it would be rendered as gray.

I mean, how did the unsupported color appear in saved_color?

It shouldn't, unless someone manually mangled annotations, or we somehow fuck up the list of color names in the future ;).

I'm not reading all the context of this pull request, but I'd appreciate if all possible RBX hex colors (not just the ~10 or so official ones we allow users to pick) can still be displayed in their proper color, instead of grey.

They technically can, but that requires you to user-patch the list of name = code in blitbuffer for what you want to use.

(i.e., annotations store a color name, not a color code; and it's up to the device to render that according to what it thinks that color should be mapped to. I guess the intent was to be able to move annotations between devices where some of them can be very very bad at rendering certain colors).

It shouldn't, unless someone manually mangled annotations, or we somehow fuck up the list of color names in the future ;).

Oh, or, if, I guess, someone user-patched both blitbuffer and readerhighlight to add more color names, and that was moved to another device where those color names are unknown.

annotations store a color name, not a color hash

Hmm, okay. I understand the idea of different hex codes for the same color depending on the device (but also wonder if that would ever actually happen).

My eventual idea is syncing these annotations between KOReader and Zotero and since Zotero stores hex codes, not color names (and allows any hex combination), I imagined this would be similar. But, that's just hypothetical and may never happen so doesn't make sense to design it here just for that. Still, that's my reasoning.

See the original discussion you were part of last year at the top of this issue, I didn't come up with that, I just picked up the baton ;).

It's already coded like this, and I bet a plugin could somehow make it work with this code. Like e.g. from what you said

[a plugin] user-patched both blitbuffer and readerhighlight to add more color names, and that was moved to another device where those color names are unknown

So it's fine. Zotero doesn't have underlining/invert highlight style anyway so those I'd need to some sort of mapping in KOReader regardless.

frontend/apps/reader/modules/readerhighlight.lua

Don't do anything if the device doesn't support Kaleido wfm, or if color is disabled. Also, use full to prevent partial being "upgraded" to flashui, which wouldn't be eligible for Kaleido (on Kobo, at least, PB has a less granular wfm selection, so it doesn't care about this distinction).

frontend/apps/reader/modules/readerhighlight.lua

@hius07

annotation expert @hius07 ;).

hius07 · 2024-08-27T13:51:43Z

frontend/apps/reader/modules/readerview.lua

+            if Blitbuffer.isColor8(color) then
+                bb:paintRect(x, y + h - 1, w, Size.line.medium, color)
+            else
+                bb:paintRectRGB32(x, y + h - 1, w, Size.line.medium, color)


You draw the note marking underline with the same color as the highlighting itself, not visible.

I imagine we probably actually want to keep those in black, always, not only the underline?

Although... I can sort of see the sideline being in color somewhat useful?

Mildly less enthused about the icon, but I'm really, really not the target audience, so, no idea ^^

Oh, the icon is already B&W only, so we're good ;p.

Underline and icon always in black I think, sideline on b/w devices in black and on color devices maybe in color.

indeed doesn't make any sense, good catch ;).

poire-z

Looks ok. Trusting @hius07 for all the widgets in ReaderHighlight.

Looks like we're showing the Highlight color menu/widget item even on B&W devices, right?
In #11044 (review) and next one, @hius07 wanted them only on color devices. Is that resolved?

NiLuJe · 2024-08-27T22:39:08Z

Looks like we're showing the Highlight color menu/widget item even on B&W devices, right?

Yep, it allows modifying colors on imported highlights.

(Or, hell, even on the same device if you happen to disable color rendering on it ;p).

I think the original comment was from when the color button was added to the initial on-hold strip of buttons widget thingy; this is no longer the case, it's just an extra row at the bottom of the Style popup now.

poire-z · 2024-08-27T23:02:14Z

Imported highlights between a color device and another b&w device must be a rare use case.
So, people with a single B&W device will get this menu, be able to set a color - but will bascailly see nothing? Do our gray highlights will change grayness if you set them to different colors?

NiLuJe · 2024-08-27T23:22:50Z

Do our gray highlights will change grayness if you set them to different colors?

Yep!

ryanwwest · 2024-08-30T20:12:52Z

This is awesome, thanks so much to everyone for making this happen!!

NiLuJe · 2024-08-30T21:16:06Z

Many thanks to @smasher816 for the initial implementation, and to @hius07 for his help pushing this through the finish line during the various iterations of this PR ;).

CobriMediaJulien · 2024-08-30T21:31:22Z

Does this mean the feature is going to be in the next build/ release? Awesome, many thanks guys.

Commodore64user · 2024-08-30T22:27:15Z

Sorry, just saying: I can't wait for it to be ready, I'm dreaming so much about this feature. It will be the best day in my girl life. 😀

p.s. If you need any possible help, I will be glad to help you, guys 🫶

You are making the best day in a girl’s life a reality. How wholesome.

poire-z · 2024-08-31T08:00:43Z

Looks like I get a crash when I open a book starting on a page with a highlight (made before this PR I guess) - and also after opening on a blank page when going to a page with a highlight:

08/31/24-09:57:48 DEBUG CreDocument: goto page 1147 flow 0
./luajit: ./ffi/blitbuffer.lua:2610: attempt to index local 'name' (a nil value)
stack traceback:
 ./ffi/blitbuffer.lua:2610: in function 'colorFromName'
 frontend/apps/reader/modules/readerview.lua:595: in function 'drawSavedHighlight'
 frontend/apps/reader/modules/readerview.lua:237: in function 'paintTo'
 frontend/ui/widget/container/inputcontainer.lua:87: in function 'paintTo'
 frontend/ui/uimanager.lua:1259: in function '_repaint'
 frontend/ui/uimanager.lua:1482: in function 'handleInput'
 frontend/ui/uimanager.lua:1582: in function 'run'
 reader.lua:265: in main chunk
 [C]: at 0x556b40db27af

Is it just me?

uroybd · 2024-08-31T08:11:54Z

Looks like I get a crash when I open a book starting on a page with a highlight (made before this PR I guess) - and also after opening on a blank page when going to a page with a highlight:

08/31/24-09:57:48 DEBUG CreDocument: goto page 1147 flow 0
./luajit: ./ffi/blitbuffer.lua:2610: attempt to index local 'name' (a nil value)
stack traceback:
 ./ffi/blitbuffer.lua:2610: in function 'colorFromName'
 frontend/apps/reader/modules/readerview.lua:595: in function 'drawSavedHighlight'
 frontend/apps/reader/modules/readerview.lua:237: in function 'paintTo'
 frontend/ui/widget/container/inputcontainer.lua:87: in function 'paintTo'
 frontend/ui/uimanager.lua:1259: in function '_repaint'
 frontend/ui/uimanager.lua:1482: in function 'handleInput'
 frontend/ui/uimanager.lua:1582: in function 'run'
 reader.lua:265: in main chunk
 [C]: at 0x556b40db27af

Is it just me?

It happened to me also.

My workaround was to apply the default highlight style to all from the menu.

poire-z · 2024-08-31T08:18:18Z

Went with:

-                    local color = Blitbuffer.colorFromName(item.color)
+                    local color = Blitbuffer.colorFromName(item.color or "blah")

to move on.

By killing colors early, we act for a better future #11044 (comment)

(They'll be drawn them in gray, as before) Regression since koreader#11044 (koreader#11044 (comment))

#12438) (They'll be drawn in gray, as before) Regression since #11044 (#11044 (comment))

NiLuJe reviewed Oct 26, 2023

View reviewed changes

frontend/apps/reader/modules/readerview.lua Outdated Show resolved Hide resolved

hius07 reviewed Oct 27, 2023

View reviewed changes

frontend/apps/reader/modules/readerhighlight.lua Show resolved Hide resolved

hius07 reviewed Oct 27, 2023

View reviewed changes

frontend/apps/reader/modules/readerview.lua Outdated Show resolved Hide resolved

smasher816 force-pushed the master branch from 2d33563 to 10df57d Compare October 28, 2023 04:32

hius07 reviewed Oct 28, 2023

View reviewed changes

frontend/apps/reader/modules/readerhighlight.lua Outdated Show resolved Hide resolved

hius07 reviewed Oct 28, 2023

View reviewed changes

frontend/apps/reader/modules/readerhighlight.lua Outdated Show resolved Hide resolved

smasher816 force-pushed the master branch from 10df57d to 75c15be Compare October 28, 2023 13:32

poire-z reviewed Oct 28, 2023

View reviewed changes

frontend/apps/reader/modules/readerhighlight.lua Outdated Show resolved Hide resolved

smasher816 force-pushed the master branch from 75c15be to 419a04d Compare October 28, 2023 13:58

smasher816 force-pushed the master branch from 419a04d to bb746b2 Compare October 28, 2023 14:09

smasher816 force-pushed the master branch from bb746b2 to 84ecfc2 Compare October 28, 2023 15:44

smasher816 force-pushed the master branch from 84ecfc2 to ebe803e Compare October 28, 2023 20:15

NiLuJe requested a review from poire-z August 27, 2024 10:36

NiLuJe reviewed Aug 27, 2024

View reviewed changes

hius07 reviewed Aug 27, 2024

View reviewed changes

frontend/apps/reader/modules/readerhighlight.lua Outdated Show resolved Hide resolved

Missed an API change ;)

4129277

hius07 reviewed Aug 27, 2024

View reviewed changes

frontend/apps/reader/modules/readerhighlight.lua Show resolved Hide resolved

hius07 reviewed Aug 27, 2024

View reviewed changes

frontend/apps/reader/modules/readerhighlight.lua Outdated Show resolved Hide resolved

We should have a guarantee drawer is set, according to our resident

63605a4

annotation expert @hius07 ;).

hius07 reviewed Aug 27, 2024

View reviewed changes

Drawing the underline note mark in the same color as the main annotation

fb197ff

indeed doesn't make any sense, good catch ;).

poire-z approved these changes Aug 27, 2024

View reviewed changes

NiLuJe mentioned this pull request Aug 30, 2024

Bump base & android #12434

Merged

Frenzie merged commit 60e0e3e into koreader:master Aug 30, 2024
2 of 5 checks passed

NiLuJe added a commit to NiLuJe/koreader that referenced this pull request Aug 31, 2024

ReaderView: Don't crash on highlights without a color field

b915ccc

(They'll be drawn them in gray, as before) Regression since koreader#11044 (koreader#11044 (comment))

NiLuJe mentioned this pull request Aug 31, 2024

ReaderView: Don't crash on pre-#11044 highlights without a color field #12438

Merged

hius07 mentioned this pull request Aug 31, 2024

FR: Direct access to the color menu from the highlight control. #12439

Closed

NiLuJe added a commit that referenced this pull request Aug 31, 2024

ReaderView: Don't crash on pre-#11044 highlights without a color field (

cf83dc8

#12438) (They'll be drawn in gray, as before) Regression since #11044 (#11044 (comment))

Add color highlight menu #11044

Add color highlight menu #11044

Conversation

smasher816 commented Oct 26, 2023 • edited by NiLuJe Loading

smasher816 commented Oct 26, 2023

hius07 commented Oct 27, 2023

hius07 commented Oct 27, 2023

hius07 commented Oct 27, 2023

ryanwwest commented Oct 27, 2023 • edited Loading

smasher816 commented Oct 28, 2023

smasher816 commented Oct 28, 2023

smasher816 commented Oct 28, 2023

ryanwwest commented Oct 28, 2023 • edited Loading

smasher816 commented Oct 28, 2023

poire-z commented Oct 28, 2023

ryanwwest commented Oct 28, 2023

poire-z commented Oct 28, 2023

ryanwwest commented Oct 28, 2023

ryanwwest commented Oct 28, 2023

poire-z commented Oct 28, 2023

smasher816 commented Oct 28, 2023

smasher816 commented Oct 28, 2023

NiLuJe left a comment

Choose a reason for hiding this comment

NiLuJe commented Aug 27, 2024 • edited Loading

NiLuJe commented Aug 27, 2024

Choose a reason for hiding this comment

NiLuJe Aug 27, 2024 • edited Loading

Choose a reason for hiding this comment

hius07 Aug 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NiLuJe Aug 27, 2024 • edited Loading

Choose a reason for hiding this comment

NiLuJe Aug 27, 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

NiLuJe Aug 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hius07 Aug 27, 2024 • edited Loading

Choose a reason for hiding this comment

poire-z left a comment

Choose a reason for hiding this comment

NiLuJe commented Aug 27, 2024 • edited Loading

poire-z commented Aug 27, 2024

NiLuJe commented Aug 27, 2024

ryanwwest commented Aug 30, 2024

NiLuJe commented Aug 30, 2024

CobriMediaJulien commented Aug 30, 2024

Commodore64user commented Aug 30, 2024 • edited Loading

poire-z commented Aug 31, 2024

uroybd commented Aug 31, 2024

poire-z commented Aug 31, 2024

smasher816 commented Oct 26, 2023 •

edited by NiLuJe

Loading

ryanwwest commented Oct 27, 2023 •

edited

Loading

ryanwwest commented Oct 28, 2023 •

edited

Loading

NiLuJe commented Aug 27, 2024 •

edited

Loading

NiLuJe Aug 27, 2024 •

edited

Loading

hius07 Aug 27, 2024 •

edited

Loading

NiLuJe Aug 27, 2024 •

edited

Loading

NiLuJe Aug 27, 2024 •

edited

Loading

NiLuJe Aug 27, 2024 •

edited

Loading

hius07 Aug 27, 2024 •

edited

Loading

NiLuJe commented Aug 27, 2024 •

edited

Loading

Commodore64user commented Aug 30, 2024 •

edited

Loading