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

glossary property in the manifest is not allowed on content documents #1170

Closed
acabal opened this issue Jul 30, 2020 · 4 comments · Fixed by #1204
Closed

glossary property in the manifest is not allowed on content documents #1170

acabal opened this issue Jul 30, 2020 · 4 comments · Fixed by #1204
Assignees
@rdeltour
Labels
spec: EPUB Dictionaries and Glossaries Impacting the support of the EPUB Dictionaries and Glossaries specification status: has PR The issue is being processed in a pull request type: false-positive This issue is about valid content being incorrectly rejected
Milestone
v4.2.5

Comments

@acabal
Copy link

acabal commented Jul 30, 2020 •
edited
Loading

Tested on epubcheck 4.2.4.

At Standard Ebooks we're trying to add a glossary according to the EPUB Dictionaries and Glossaries 1.0 spec.

In the manifest file, we add two items:

<item href="glossary-search-key-map.xml" id="glossary-search-key-map.xml" media-type="application/vnd.epub.search-key-map+xml" properties="search-key-map glossary"/>
<item href="text/glossary.xhtml" id="glossary.xhtml" media-type="application/xhtml+xml" properties="glossary"/>

According to the spec, we should be able to add the glossary property both to the search key map file to to indicate that the file applies to a glossary, and to the XHTML content document file to indicate that it contains the actual glossary.

However epubcheck outputs:

ERROR(OPF-015): /path/to/glossary.xhtml(-1,-1): The property 'glossary' should not be declared in the OPF file.

It seems to allow glossary for the search key map, but not for the XHTML file.
@acabal acabal changed the title glossary property in the manifest is not allowed glossary property in the manifest is not allowed on content documents Jul 30, 2020
@rdeltour
Copy link
Member

rdeltour commented Aug 4, 2020

Have you checked that your glossary.xhtml XHTML Content Document includes at least an element with the epub:type glossary? This is mandatory for the glossary property to be allowed on the manifest item.

If that's not the issue, then it's possibly a bug in EPUBCheck 😊

@rdeltour rdeltour self-assigned this Aug 4, 2020
@rdeltour rdeltour added status: waiting for feedback The development team needs feedback from the issue’s creator type: unverified The issue couldn't be reproduced labels Aug 4, 2020
@rdeltour rdeltour added this to the v4.2.5 milestone Aug 4, 2020
@acabal
Copy link
Author

acabal commented Aug 4, 2020

Yes, glossary.xhtml has an element with epub:type="glossary", though it's on a <section> element in glossary.xhtml, not a <dl> element.

@rdeltour
Copy link
Member

rdeltour commented Aug 5, 2020

OK, thanks for your answer 😊
Are you running EPUBCheck with the dict profile?
Would you be able to share a test EPUB?

@rdeltour
Copy link
Member

rdeltour commented Aug 5, 2020

I was able to reproduce, so no need to send a test EPUB after all 😉
I'll dig deeper, but it does seem like a bug. Thanks for the report!

@rdeltour rdeltour added status: accepted Ready to be further processed type: false-positive This issue is about valid content being incorrectly rejected spec: EPUB Dictionaries and Glossaries Impacting the support of the EPUB Dictionaries and Glossaries specification and removed status: waiting for feedback The development team needs feedback from the issue’s creator type: unverified The issue couldn't be reproduced labels Aug 5, 2020
rdeltour added a commit that referenced this issue Feb 26, 2021
@rdeltour
fix: allow the 'glossary' manifest item property
58d773c 
The `glossary` manifest item property is defined in the EPUB dictionaries
and Glossaries 1.0 specification:
  http://idpf.org/epub/dict/epub-dict.html#sec-2.5.3

This fix allows the property to be defined on XHTML manifest items when
the content contains an element with a `glossary` `epub:type` attribute.

Fixes #1170
@rdeltour rdeltour mentioned this issue Feb 26, 2021
Merged
@rdeltour rdeltour added status: has PR The issue is being processed in a pull request and removed status: accepted Ready to be further processed labels Feb 26, 2021
rdeltour added a commit that referenced this issue Feb 26, 2021
@rdeltour
fix: allow the 'glossary' manifest item property
d1727d8 
The `glossary` manifest item property is defined in the EPUB dictionaries
and Glossaries 1.0 specification:
  http://idpf.org/epub/dict/epub-dict.html#sec-2.5.3

This fix allows the property to be defined on XHTML manifest items when
the content contains an element with a `glossary` `epub:type` attribute.

Fixes #1170
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rdeltour rdeltour

Labels
spec: EPUB Dictionaries and Glossaries Impacting the support of the EPUB Dictionaries and Glossaries specification status: has PR The issue is being processed in a pull request type: false-positive This issue is about valid content being incorrectly rejected
Projects
None yet
Milestone
v4.2.5
Development

Successfully merging a pull request may close this issue.

fix: allow the 'glossary' manifest item property w3c/epubcheck
2 participants
@rdeltour @acabal