-
Notifications
You must be signed in to change notification settings - Fork 399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CFI Validation #150
Comments
I'm not sure this issue matters anymore. We've removed required support for authored epubcfi in 3.2, as it's unlikely they'll ever be used except by reading systems. I'd propose closing it. |
Yes, I agree. Let's close as |
well, maybe I was too quick in closing this: what should we do if we encounter CFIs in a publication however? If they're accepted, then it would make sense to validate them? I don't remember what 3.2 says about that. |
But what's the reality of that ever happening in a content document at this point? That's why support for authored CFIs was dropped, as reading systems aren't supporting them and there's no apparent likelihood of that changing. There are only two places left I can think of where a CFI might be encountered during validation:
If you want to tie this to realizing support for either of those, then it might make sense, but they're both also far from being realities. It'd be a really, really, really low priority, I suspect. (I'm personally not holding out hope that the satellite specs have much of a future anymore.) |
Yes, I definitely agree with you on the state of things. Unfortunately EpubCheck is used by almost everyone as a strict validator and not as a linter. In other words, its goal is not to report nonsensical content but just non-conforming content. I would argue it would be more useful to actually warn about the presence of CFI links, but if it's not a SHOULD NOT in the spec then unfortunately we can't do that. I'm leaning towards introducing a "soft" warning (a USAGE or INFO message) saying that CFI were detected and will not be checked further. That way, it serves both as a warning for no-longer-supported CFIs, and as an information on our non-validation of CFIs. WDYT? |
Right, we shouldn't add any language that isn't in the specification (like use being discouraged, when the spec is just completely silent on them), so noting and bailing out on verifying seems like a good direction for handling them. |
Hi guys, We have made a TypeScript EPUBCFI parser with validation built in which we are offering as open source to help reading systems and web annotation servers offer support for EPUBCFI's. We have not had time to put it on GitHub yet but it is on its way. If you want to use it in EpubCheck i will speed this up. |
Hi Daniel 🙂
We never had time to do the Open Source dist. Let me take it up with
Andreas again.
We really want it Open Sourced.
I'll get back to you asap 👍
Hope to see you soon again 😊
Lars
…On Mon, 25 Sept 2023 at 17:46, Daniel Weck ***@***.***> wrote:
Hi @larscwallin <https://github.com/larscwallin>
We have made a TypeScript EPUBCFI parser with validation built in which we
are offering as open source to help reading systems and web annotation
servers offer support for EPUBCFI's. We have not had time to put it on
GitHub yet but it is on its way.
Is your CFI code now open-source? (parser + generator?)
I'm gathering information about existing JS/TS implementations (various
degrees of correctness / test coverage):
- https://github.com/fread-ink/epub-cfi-resolver
-
https://github.com/vivliostyle/vivliostyle.js/blob/master/packages/core/src/vivliostyle/cfi.ts
- https://github.com/johnfactotum/foliate-js/blob/main/epubcfi.js
- https://github.com/readium/readium-cfi-js
-
https://github.com/satorumurmur/bibi/blob/master/__src/bibi/extensions/epubcfi.js
- Colibrio? :)
Thank you! Daniel
—
Reply to this email directly, view it on GitHub
<#150 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAFTDP7W7X2U4ZHBO3HV3QDX4GRNFANCNFSM4AIYXGHQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
From markus.g...@gmail.com on December 22, 2011 11:31:34
Add validation of CFI links:
a) syntactical validity
b) resolve
Original issue: http://code.google.com/p/epubcheck/issues/detail?id=150
The text was updated successfully, but these errors were encountered: