8000 Proposal: add a "description" rel value · Issue #1666 · w3c/epub-specs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
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

Proposal: add a "description" rel value #1666

Closed
iherman opened this issue May 7, 2021 · 4 comments · Fixed by #1669
Closed

Proposal: add a "description" rel value #1666

iherman opened this issue May 7, 2021 · 4 comments · Fixed by #1669
Labels
EPUB33 Issues addressed in the EPUB 3.3 revision Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation Topic-PackageDoc The issue affects package documents Type-FeatureRequest The issue requests new functionality be added

Comments

@iherman
Copy link
Member
iherman commented May 7, 2021

More precisely: add a "description" term to the Link Relationships Vocabulary.

This would make it possible to use the Link Element to refer to an extended description with a specific media type (e.g., HTML, Markdown...).

For the origin of the use case see: #1650, the proposed solution in #1650 (comment).

(Note, the WG resolution is not to accept the proposal as it was originally raised in #1650, this would be a replacement.)

@iherman iherman added Topic-PackageDoc The issue affects package documents Type-FeatureRequest The issue requests new functionality be added labels May 7, 2021
@mattgarrish
Copy link
Member

Do we need to mint another description value when you can already do:

<link rel="dcterms:description" href="..." media-type="..."/>

(or even rel="dc:description" or rel="schema:description"?)

Ideally, we're supposed to keep bare name rel values compatible the IANA and HTML link relations. Neither currently defines a description value. HTML has a DCTERMS.description proposed value, but I think in our case it would be better to keep the prefixed version.

@iherman
Copy link
Member Author
iherman commented May 8, 2021

Pragmatically, you are right, and maybe that is what we should do. My reticence comes from my semantic web influence, I guess: if I look at the meta and link elements and (informally, I know) translate them to proper triple statements, then what I get is that the statement with a property dc:description has a value of a URI and not a text which, I believe, is not in line with the DCMI specification.

But I acknowledge that this is a theoretical purity issue; if everyone is fine with this approach, I am happy to settle on this.

@mattgarrish
Copy link
Member
mattgarrish commented May 8, 2021

then what I get is that the statement with a property dc:description has a value of a URI and not a text which

But isn't this what you're supposed to be doing with dcterms linked metadata? The expected type is property, not literal text. I know they've relaxed their rules/expectations to allow text values all for the properties, but most are supposed to be links.

But even if we mint another description term, we're still going to end up with a triple whose value is a URL, no?

I'm fine adding an example to the spec if we want to acknowledge that you can use link for individual properties in another format and not just full records.

@iherman
Copy link
Member Author
iherman commented May 8, 2021

Heh. I did not realize that DCMI side-stepped this issue. I looked into the dcterms RDF definition, which also defined dc:description as an (RDF) subproperty of dc:description in the dc RDF defintion and, in both cases, all it says for the description (sic!) of description is:

"Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource."

but there is no rdfs:range that would say the value is supposed to be a literal (which I expected would be the case). Ie, I was wrong in believing that we would be violating using dc:description as the property of a <link> element because we do require the value to be a URL.

Bottom line: using dc:description is indeed a good approach and solves the original use case and this issue is rubbish :-)

But adding an example that covers the original use case would actually be a good idea. I am happy to put in a PR on this on Monday, unless you beat me into it...

@mattgarrish mattgarrish added the EPUB33 Issues addressed in the EPUB 3.3 revision label May 11, 2021
@mattgarrish mattgarrish added the Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation label Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EPUB33 Issues addressed in the EPUB 3.3 revision Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation Topic-PackageDoc The issue affects package documents Type-FeatureRequest The issue requests new functionality be added
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants
0