koreader / koreader

An ebook reader application supporting PDF, DjVu, EPUB, FB2 and many more formats, running on Cervantes, Kindle, Kobo, PocketBook and Android devices
http://koreader.rocks/
GNU Affero General Public License v3.0
15.73k stars 1.22k forks source link

X-Ray-like feature #6023

Open boriar opened 4 years ago

boriar commented 4 years ago

Is it possible to include support for X-Ray feature? Also, like is a feature for mobi and azw3, will be too difficult to implement also with epub?

Thanks for your work and attention

Frenzie commented 4 years ago

Seems to be a Kindle thing: https://en.wikipedia.org/wiki/X-Ray_(Amazon_Kindle)

I wouldn't hold my breath for new features being added to Mobi. ;-) More important, it seems like it has to be part of the file (?) so I imagine that's not a thing in EPUB.

If I understand that page correctly, the main thing effectively "missing" is the common knowledge about a book from a place like LibraryThing and/or GoodReads?

boriar commented 4 years ago

Yes. It's a feature that Amazon include with software for his Kindles. It isn't into/modified mobi but a separete archive with his own format and used only with mobi and azw3 format (not in new kfx). I think is a usefull feature because inform about terms of a book, not a dictionary but like an encyclopedia. You know, show information about the characters or places named in the book. Also, like you did sometimes with features from fb2 applies to epub, I ask if will be posible to implement on epub because is a more universal format.

You can inform about it better here (a thread on mobilread of a calibre plugin): https://www.mobileread.com/forums/showthread.php?t=245754

And view an example here (Amazon presentation of the feature): https://www.youtube.com/watch?v=AbzOLua2baw

NiLuJe commented 4 years ago

Someone cobbled something together by (ab)using ruby tags, which we don't support, IIRC.

There's already an issue open where something similar was discussed in greater details ;).

NiLuJe commented 4 years ago

Oops, confused X-Ray w/ WordWise (https://github.com/koreader/koreader/issues/3044) ^^.

xxyzz commented 2 years ago

Hi @boriar, please try my calibre plugin: https://github.com/xxyzz/WordDumb. It adds X-Ray footnotes to EPUB books. I haven't release this feature yet, so you have to download the latest plugin from GitHub Actions(the artifact is double zipped) or build(zip) from source.

boriar commented 2 years ago

Hi @xxyzz , but I don't know how to compile the code from actions. If you show me (or link) a tutorial I will try it.

xxyzz commented 2 years ago

You can download the artifact from GitHub Actions Artifacts.

Or clone the code, run these commands:

$ ./data/dump_lemmas.sh
$ calibre-customize -b .

More instructions can be found at README.

arpanghosh8453 commented 2 days ago

@xxyzz I have a suggestion for making this work!

From what i understand, this will generate a separate modified file with the x-ray data. But I was wondering if we can design something that does not require modifying the original file. Because Koreader uses hash to idetify files across devices for syncing, it's hard to replace the whole library. Better if there is an open format (like a dictionary) where Koreader can search when the user highlight a name which is present in the x-ray. That way, the format will not cause issues and we don't need to modify the actual ebooks present. And with Koreader you will be able to support Kobo devices apart from kindle.

I am not sure what the devs think about implementing this. Any thoughts @Frenzie and @NiLuJe? This seems like a good feature as it's popular in Kindle already!

Frenzie commented 2 days ago

For the most part that probably doesn't make too much of a difference, but if someone were interested it'd be a good thing to keep in mind.