Created a patch for KOReader Collections automation

[SinTan1729]

https://github.com/SinTan1729/koread...ollections.lua

This patch creates and managed collections using Calibre custom columns. I've set up my Calibre to create collections based on that on my Kobo's stock interface. So, I decided to replicate that on KOReader as well.

This is my first KOReader patch, so any feedback is welcome.

Check out the README for details.
https://github.com/SinTan1729/koreader-patches

[Fantomas]

I installed your patch, however it has not produced any collections on my device.

- Checked patch management. "Patches executed: 1" (only patch I have installed)
- It is listed in the "After setup" section and has a tick

I had modified the lua before installing - CUSTOM_COLUMN_USED = '#myshelves'
(this is a holdover from when I previously had a Kobo and I still make use of it in Calibre)

I am on a Kindle Paperwhite 11th Gen that was jailbroken with nosebleed. (in case this makes any difference)

I currently have 9 books. Am still going through settings things up, having only jailbroken the device yesterday.

Please advise if there is any additional info required. Also if you would like me to raise an issue on the github as opposed to communicating here.

Thanks in advance

[SinTan1729]

Opening GitHub issue would be helpful. We can continue the conversation there, but my first guess would be that you may be syncing from Calibre over WiFi. Unless a specific modified version of the Calibre plugin is installed, it won't work. (Idk about it, don't use it, sorry.) But it should work if you push the files and update the metadata over USB. Since you have the files already, try running update cached metadata from Calibre, over USB.

[SinTan1729]

It's being discussed here: https://github.com/SinTan1729/koreader-patches/issues/1

[Lys]

Does this work with only one custom column, or is it possible to create collections from multiple custom columns?

[SinTan1729]

Only one. But it should be easy enough modify it to support multiple columns. I think it gets messy when they have the same collection names. How exactly are you using multiple columns, and what do you want the patch to do with these collisions? I may be able to help you make the changes.

[Lys]

Originally Posted by SinTan1729

Only one. But it should be easy enough modify it to support multiple columns. I think it gets messy when they have the same collection names. How exactly are you using multiple columns, and what do you want the patch to do with these collisions? I may be able to help you make the changes.

My main gripe with KoReader is I can't find a way to set it up collections in the same automatic way I can do using calibre + KoboTouch plugin.

I currently use 6 different custom columns to create collections:

• Book Language
• Book Length (Novel, Novella, Short Stories, Articles, etc)
• Genre
• Reading List
• Sub-Genre (when needed)
• Awards

And since I have books in the thousands, having collections is the best way for me to navigate through (a folders-based navigation system is basically useless to me, since typically a book of mine belongs to at least 3/4 different collections)

So I was curious, if I could try this plugin out and make KoReader usable for my user-case (but please, don't waste time on my behalf, if it's something that may cause more issues than not )

[SinTan1729]

As long as the names of the collections do not collide, it should be fairly trivial to add. For your usecase, that seems to be the case. I'll make the changes and let you know.

[SinTan1729]

It should work now. Multiple column names can be provided using an array. Colliding names from different columns will be merged into a single collection. Hope this works for your usecase.

[Lys]

I'll try it out!
And thank you for your quick answer and implementation!

[Uncle Robin]

Originally Posted by Lys

My main gripe with KoReader is I can't find a way to set it up collections in the same automatic way I can do using calibre + KoboTouch plugin.

I currently use 6 different custom columns to create collections:

• Book Language
• Book Length (Novel, Novella, Short Stories, Articles, etc)
• Genre
• Reading List
• Sub-Genre (when needed)
• Awards

And since I have books in the thousands, having collections is the best way for me to navigate through (a folders-based navigation system is basically useless to me, since typically a book of mine belongs to at least 3/4 different collections)

So I was curious, if I could try this plugin out and make KoReader usable for my user-case (but please, don't waste time on my behalf, if it's something that may cause more issues than not )

This thread is very interesting, as I begin to explore collections on KOReader. But after reading the Calibre documentation on creating custom columns, I's still struggling to grok how to create them based on tags. What I'd love is to create custom columns for my TBR and current reading lists and then use this plugin (or one like it) to automatically update those collections as the status of my library changes. How do I do this?

[Lys]

Originally Posted by Uncle Robin

This thread is very interesting, as I begin to explore collections on KOReader. But after reading the Calibre documentation on creating custom columns, I's still struggling to grok how to create them based on tags. What I'd love is to create custom columns for my TBR and current reading lists and then use this plugin (or one like it) to automatically update those collections as the status of my library changes. How do I do this?

I'm not sure I got your scenario correctly, but let's say, you have a column (y/n) that marks the books you have selected for your TBR (#tbr column).
Then say you have a column for your reading status (#status column).

Now, you want that your "current TBR" (#currenttbr column, created from other columns) list is for books included in the original TBR column, but with a status different from "Finished".

You can use a template like this:

program: 

if $#status == "Finished"
then ""
else if $#tbr == "Y"
then
"TBR"
fi
fi

If a book is marked as Finished -> Current TBR column will be empty
If a book is not marked as Finished -> If the book is included in your TBR column, it will be marked as "TBR" in the current TBR column.

I'm not really good at coding in template language, and I'm sure there are a trillion better ways to code this case, but it should give you an idea.
In calibre sub-forumn, in the library management section, there are tons of post/threads dealing with custom columns built through a template that could help you

[Uncle Robin]

Thank you! That gives me something to start with and an idea of the framework needed

[robowolf]

Thank you for this patch! I have a Boox Go Color 7 Gen 2, and I can report that this patch has successfully created a collections column for the device in Calibre. I didn't have a "patches" folder yet, but I was able to create one to put the patch in.

This does not sync collections in Calibre with the device itself, however, is this correct? That is, I cannot create/edit collections in Calibre and then sync them to the device's collections column.