Skip to content
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

Should the canonical identifier resolve to a preferred version? #3

Closed
mattgarrish opened this issue Aug 6, 2019 · 5 comments · Fixed by #28
Closed

Should the canonical identifier resolve to a preferred version? #3

mattgarrish opened this issue Aug 6, 2019 · 5 comments · Fixed by #28

Comments

@mattgarrish
Copy link
Member

Without the web publications underpinnings, there isn't as strong a case for recommending URLs for the canonical identifier at the manifest level.

Should we consider removing this recommendation and leaving it to implementations to decide whether URLs are preferred?

@llemeurfr
Copy link
Contributor

In JSON-LD, node identifiers are IRIs (-> URLs per our WG decision), I don't see how we could relax this rule.

It's rather the definition of this identifier that should be relaxed, as every audiobook publication requires an identifier but not all audiobooks will live on the Web (and therefore have an id that can be derefenced).

@mattgarrish
Copy link
Member Author

Right, sorry, I wasn't being terribly clear with this issue. It's not so much URLs I care about as the requirement to dereference to a resource on the web:

The canonical identifier SHOULD be a URL that resolves to the preferred version of the digital publication.

That was fine as long as the basis was "web" publications. Given that we're not dealing with web deployment, it doesn't make a lot of sense to get into what the URL resolves to, if anything.

@llemeurfr
Copy link
Contributor

IMO the main issue with the current specification of a canonical id is this notion of "preferred version of the digital publication".
It's a URL and it's better if it can be dereferenced (this is a basic RDF expectation) but we should stick with what JSON-LD says about this "node identifier" (in JSON-LD speak).
By the way, the term "canonical" may be part of the problem: we have tried to give more emphasis on its use than really needed. ok, "node identifier" is not great and the publication may have other identifiers so "identifier" is not sufficient; "publication identifier" is misleading.

@mattgarrish
Copy link
Member Author

My inclination is that we drop all the prose about preferred versions and just leave it that the canonical id MUST be a URL (which includes URNs) that uniquely identifies the publication. The web resolution is very Web Pub-y, as there isn't a need to have or find a preferred version at the manifest level. Implementations can further expand on the definition to require the URL also resolve to a preferred version, if applicable.

Essentially, it becomes like EPUB's unique-identifier - the preferred identifier among possibly many.

Otherwise, we make resolving conditional so it doesn't bind implementations to web deployment - something like ... if a preferred version exists on the web, it should be the URL used.

@iherman any thoughts on this?

@mattgarrish mattgarrish changed the title Should the canonical identifier be a URL? Should the canonical identifier resolve to a preferred version? Aug 10, 2019
@iherman
Copy link
Member

iherman commented Aug 10, 2019

@mattgarrish, that sounds fine to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants