[Plugin] Backlog – per-article read tracking for anthology EPUBs

[cdrso]

Hi all, first post here. I wrote a small open-source KOReader plugin that some of you might find handy.

Some EPUBs aren't linear books, they're collections of standalone, cross-linked essays you read in any order, like blog archives, essay anthologies, or “complete works” bundles. KOReader treats the whole file as one book with a single progress bar, so when you follow a link to a referenced essay, there's no easy way to tell whether you've already read it.

Backlog treats each top-level table-of-contents entry as a separate “article” and remembers which ones you've read:

• An articles list showing each piece as read, currently reading, or unread, with a running count.
• Tap to jump to any article; long-press to toggle read/unread.
• Auto-marks an article read when you finish it. This is configurable: at the end / on leaving / either / off.
• A “jump to next unread” action you can bind to a gesture.
• Read state is saved per book in KOReader's sidecar, keyed by each article's location, so it survives font changes, re-pagination, and restarts.
• Opt-in per book: it does nothing until you open its article list, and leaves other books untouched.

It's a document-only plugin, so the menu shows up once a book is open, under Tools (wrench) -> More tools -> Backlog (articles read).

Source, screenshots, and install instructions: https://github.com/cdrso/backlog.koplugin

Latest release (.zip): https://github.com/cdrso/backlog.koplugin/releases

It's also installable on-device through the App Store plugin. It carries the koreader-plugin topic; just search for “Backlog”.

MIT-licensed. Feedback, bug reports, and suggestions are very welcome.