search

readium / kotlin-toolkit

A toolkit for ebooks, audiobooks and comics written in Kotlin
https://readium.org/kotlin-toolkit
BSD 3-Clause "New" or "Revised" License
180 stars 77 forks source link

[Feature] Need standard epubcfi() format for highlights. #497

Closed AISpaceExplorer closed 5 months ago

AISpaceExplorer commented 5 months ago

Describe the bug

I want the standard epubcfi() format for the highlights. I see that we have partialCfi() in the code, but that was not used anywhere.

Are there any plans for it? If not, can anyone suggest a way or any other sdks which supports the standard epubcfi() format.

How to reproduce?

It's a new feature

Readium version

2.4.0

Android API version

33

Additional context

No response

mickael-menu commented 5 months ago

Hello, we have no plan to support EPUB CFIs in the Readium toolkits at the moment.

What's your use case for it, why do you need them?

AISpaceExplorer commented 5 months ago

Hi, thanks for your reply. We have a requirement to include EPUB reader in our app. The web is developing it using epub.js library which used the epubcfi() format for the highlights and selectors.

As this radium library has all the required features, we tried to use this in mobiles, but since the locator info data is different compared to what the web is working on, we wanted to check with you guys regarding it.

Since, you guys have included partialcfi into your code but never implemented it, we thought of checking with you guys if there are any plans to implement this.

Note: The documentation for the readium web app is not proper it seems.

On Fri, Apr 19, 2024, 23:58 Mickaël Menu @.***> wrote:

Hello, we have no plan to support EPUB CFIs in the Readium toolkits at the moment.

What's your use case for it, why do you need them?

— Reply to this email directly, view it on GitHub https://github.com/readium/kotlin-toolkit/issues/497#issuecomment-2067087751, or unsubscribe https://github.com/notifications/unsubscribe-auth/BH6ACTTVDLHTFYVYFNWK66TY6FO5HAVCNFSM6AAAAABGOUDJTGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANRXGA4DONZVGE . You are receiving this because you authored the thread.Message ID: @.***>

-- CONFIDENTIALITY NOTICE and STATEMENT

This email correspondence from UWorld contains information which may be confidential and privileged.  It is intended solely for the use of the recipient.  If you are not the intended recipient, be aware that any copying,

disclosure, distribution,

review or use of the contents of this message is strictly prohibited.  If you have received this email correspondence in error, please destroy it immediately.

mickael-menu commented 5 months ago

The web is developing it using epub.js library which used the epubcfi() format for the highlights and selectors.

Would you mind sharing the full locator that epub.js returns? If it contains some text context, you might be able to use it with Readium.

Note: The documentation for the readium web app is not proper it seems.

Yes it's something we want to improve this year. Right now it's still undergoing a lot of development.

AISpaceExplorer commented 5 months ago

Hi,

Here is the standard epubcfi() format sample. It includes nodes, chapter information, line numbers, etc.

epubcfi(/6/6[Ch9_Calculations_I_2024_V3_FINAL-3]!/4[Ch9_Calculations_I_2024_V3_FINAL-3]/8[_idContainer083]/2/48/2[_idTextSpan1198],/1:3,/1:11)

Yes it's* something we want to improve this year. Right now it's still undergoing a lot of development. *(Oh! okay. Looking forward to it) [image: UWorld.com] http://www.uworld.com/

      [image: UWorld's Facebook]

https://www.facebook.com/uworldusmle/?ref=br_rs [image: UWorld's Instagram] https://www.instagram.com/uworld/ [image: UWorld's Twitter] https://twitter.com/uworld_?lang=en [image: UWorld's LinkedIn] https://www.linkedin.com/company/uworld-llc/ S V Kranthi Kumar Sr. Software Engineer - 1 - Android

o: 8179770919

On Mon, Apr 22, 2024 at 5:19 PM Mickaël Menu @.***> wrote:

The web is developing it using epub.js library which used the epubcfi() format for the highlights and selectors.

Would you mind sharing the full locator that epub.js returns? If it contains some text context, you might be able to use it with Readium.

Note: The documentation for the readium web app is not proper it seems.

Yes it's something we want to improve this year. Right now it's still undergoing a lot of development.

— Reply to this email directly, view it on GitHub https://github.com/readium/kotlin-toolkit/issues/497#issuecomment-2069194234, or unsubscribe https://github.com/notifications/unsubscribe-auth/BH6ACTR4GH6UPM4QGFHP5ELY6T2NXAVCNFSM6AAAAABGOUDJTGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANRZGE4TIMRTGQ . You are receiving this because you authored the thread.Message ID: @.***>

-- CONFIDENTIALITY NOTICE and STATEMENT

This email correspondence from UWorld contains information which may be confidential and privileged.  It is intended solely for the use of the recipient.  If you are not the intended recipient, be aware that any copying,

disclosure, distribution,

review or use of the contents of this message is strictly prohibited.  If you have received this email correspondence in error, please destroy it immediately.

mickael-menu commented 5 months ago

Don't you have also the text content of the selection with it?