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.

Sign up for GitHub

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

Jump to bottom

Properties removed from the link vocabulary #1457

Closed
mattgarrish opened this issue Dec 9, 2022 · 1 comment · Fixed by #1468
Closed

Properties removed from the link vocabulary #1457

mattgarrish opened this issue Dec 9, 2022 · 1 comment · Fixed by #1468
Assignees
@rdeltour
Labels
status: has PR The issue is being processed in a pull request type: spec The issue is related to a Specification update
Milestone
v5.0.0-rc

Comments

@mattgarrish
Copy link
Member

As we found no evidence of xmp records being used, there was no case for keeping the xmp properties value as under-implemented, or even keeping it as deprecated (only the onix property is used). It should be safe to remove this from validation.

The acquire rel value was also removed from the vocabulary, but it should be left valid because it was defined in the Previews spec. I think we have some partial validation support for previews, but it's probably not worth the effort of making it valid only in those types of publications - just leave it as an acceptable rel value.

See w3c/epub-specs#2489
@mattgarrish
Copy link
Member Author

Note that if acquire remains valid, the test for it in the test suite should be untagged: https://github.com/w3c/epubcheck/blob/main/src/test/resources/epub3/D-vocabularies/metadata-link.feature#L18

This will no longer be part of the report.

Running a search on the epub3 feature folder the only test that needs updating to remove an xmp link is here: https://github.com/w3c/epubcheck/blob/main/src/test/resources/epub3/D-vocabularies/files/link-rel-record-properties-valid.opf#L10

That line can be removed without having to change anything else, as it has an onix link that remains valid.

@rdeltour rdeltour self-assigned this Dec 15, 2022
@rdeltour rdeltour added this to the v5.0.0-rc milestone Dec 15, 2022
@rdeltour rdeltour added type: spec The issue is related to a Specification update status: ready for implem The issue is ready to be implemented labels Dec 15, 2022
rdeltour added a commit that referenced this issue Dec 23, 2022
@rdeltour
feat: "xmp" is no longer a valid package link property
ab13ef0 
The following entries were removed from the metadata link vocabulary in
EPUB 3.3, due to low usage report:

- the "acquire" relationship
- the "xmp" property

This commit removes the "xmp" from the link property vocabulary, so any
use of it will be reported as an error.

It keeps the "acquire" property in the relationship vocabulary, for
backward compatibility notably with the EPUB Previews specification were
it is defined.

Close #1457
@rdeltour rdeltour mentioned this issue Dec 23, 2022
Merged
@rdeltour rdeltour added status: has PR The issue is being processed in a pull request and removed status: ready for implem The issue is ready to be implemented labels Dec 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rdeltour rdeltour

Labels
status: has PR The issue is being processed in a pull request type: spec The issue is related to a Specification update
Projects
None yet
Milestone
v5.0.0-rc
Development

Successfully merging a pull request may close this issue.

feat: "xmp" is no longer a valid package link property w3c/epubcheck
2 participants
@rdeltour @mattgarrish