search

readium / webpub-manifest

📜 A JSON based Web Publication Manifest format used at the core of the Readium project
BSD 3-Clause "New" or "Revised" License
92 stars 23 forks source link

Readium WebPub manifest JSON-LD and JSON-Schema, URI/URL stability, versioning / revisioning #11

Open danielweck opened 6 years ago

danielweck commented 6 years ago

In the "Readium desktop" app, a backend database is used to store WebPubManifest and OPDS models, so @clebeaupin has been wondering about how to detect potentially-breaking changes (such as spine vs. readingOrder) using URI comparisons to differentiate model revisions (no need for semantic versioning overkill, unless we envision many updates in the model definitions)

Right now, how "finalized" is the JSON-LD context? I imagine it is pretty stable now, but I am wondering about "multilingual strings" etc. (in reference to the design details that are moving targets in W3C Web Publications) Same question about JSON-Schema.

Related issue: https://github.com/readium/webpub-manifest/issues/10

HadrienGardeur commented 6 years ago

I would say that it's fairly stable as well, but there might be minor tweaks related to metadata. There's no plan to change the URI (we were affected by the readium.org migration before) and versioning seems overkill to me.

For multilingual strings, the more I read about them in the W3C repo, the more I feel that we've made the right choice and will stick to it.