KOReader Annotation Plugin for Logseq

[isosphere]

Hello!

If you use Logseq (a PKMS) & KOReader, I made a plugin for that!

It's on the official plugin screen as "Logseq Koreader Sync". It'll pull annotations from a bunch of sidecar files into a page in your graph. I just got finished making it.

It enables this workflow for me:

1. Read and annotate in Koreader
2. Use Syncthing to unilaterally sync the SDR files to a file server
3. Logseq Koreader Sync reads those files and produces blocks out of them

I can then reference any annotations I've taken elsewhere in my notebook; it's nearly frictionless. Highlights and notes are collected, and documents are tagged with description and authors as block properties.

I think the only downside is that you can't edit the synced content; it'll mess up future syncs. Maybe bidirectional syncing will be supported one day.

It's free & open source, just like Logseq and KOReader. The repo is here. There's a short little demo recording there that illustrates the use of it.

[hius07]

Thanks for sharing!

I see you use the bookmark.text field only, that contains user's note.
You can also use bookmark.notes, that contains the highlighted text.

Also you expose the bookmark.page field, that for epubs contains the xpointer string, not very helpful for users.
You can enable the "Add page number/timestamp to bookmark" setting, to have the page number in every bookmark.text field.
(Please note that the page number is correct at the moment of making a highlight. If you later change the document layout (font size etc) page numbers in bookmarks will not be updated automatically.)

[isosphere]

Thank you for the feedback!

Originally Posted by hius07

You can also use bookmark.notes, that contains the highlighted text.

I do! See here: https://github.com/isosphere/logseq-...c/index.ts#L63

I present them in the outliner something like this:

> "Highlighted text represented as a markdown quote"

• child block which is the user's note on this highlight

You should see this in the little demo GIF on the readme page, near the end of it when I expand some things.

Originally Posted by hius07

Also you expose the bookmark.page field, that for epubs contains the xpointer string, not very helpful for users.

You can enable the "Add page number/timestamp to bookmark" setting, to have the page number in every bookmark.text field.
(Please note that the page number is correct at the moment of making a highlight. If you later change the document layout (font size etc) page numbers in bookmarks will not be updated automatically.)

I have noticed that the page references are sometimes a bit strange. Here's an example:

/body/DocFragment[10]/body/p[20]/text()[1].115

I guess that's telling us that it's paragraph 20 in doc fragment 10, whatever that means. It's nice that it probably won't vary with different layouts, but it is indeed kind of intractable to use for any purpose.

I'll play around with improving on this; if it comes to enabling a setting, I can always recommend that in the README.md.