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

Remove advice on HTML file extension #1294

Closed
dauwhe opened this issue Sep 6, 2019 · 6 comments · Fixed by #1423
Closed

Remove advice on HTML file extension #1294

dauwhe opened this issue Sep 6, 2019 · 6 comments · Fixed by #1423
Labels
EPUB33 Issues addressed in the EPUB 3.3 revision Spec-EPUB3 The issue affects the core EPUB 3.3 Recommendation Status-Proposed Solution A proposed solution has been included in the issue for working group review Topic-ContentDocs The issue affects EPUB content documents

Comments

@dauwhe
Copy link
Contributor

dauwhe commented Sep 6, 2019

I thought we had discussed this, but I can't find an issue.

Content Docs says

The XHTML Content Document filename SHOULD use the file extension .xhtml

I think we should delete this sentence, and remove the corresponding test from EPUBCheck. I think this annoys users without helping anyone else. And if you use file extensions to tell you anything about a file, you're going to have a bad time.

@dauwhe dauwhe added the Topic-ContentDocs The issue affects EPUB content documents label Sep 6, 2019
@mattgarrish
Copy link
Member

Maybe we should do this across the board. We also recommend file extensions for the package document, svg, pls lexicons and smil files.

@dauwhe
Copy link
Contributor Author

dauwhe commented Nov 11, 2020

Maybe we should do this across the board. We also recommend file extensions for the package document, svg, pls lexicons and smil files.

Yes!

@mattgarrish
Copy link
Member

Ya, I wanted to remove these while retooling the conformance sections, but didn't want to get bogged down in a conformance change. I'll open a PR.

@mattgarrish
Copy link
Member

Proposed Solution

Remove the recommended file extensions for Package Documents, XHTML Content Documents, PLS Lexicons and Media Overlay Documents.

Add a note in the package document definition section to refer to the media type registration for more info about file properties.

@mattgarrish mattgarrish added the Status-Proposed Solution A proposed solution has been included in the issue for working group review label Nov 11, 2020
@dauwhe
Copy link
Contributor Author

dauwhe commented Nov 12, 2020

Did some testing. Made the "Ivan nightmare" file where an XHTML content document used the file extension .svg. The resulting EPUB gives a warning in EPUBCheck, of course, but works in:

  1. Apple Books
  2. Calibre
  3. Adobe Digital Editions 3.0
  4. Thorium

Interestingly, when I tried to convert the EPUB to a non-EPUB format, the conversion tool complained.

@mattgarrish
Copy link
Member

Epubcheck doesn't inspect the content to verify the media type, so it's the easiest to fool. Faking media types was a periodic suggestion in the idpf forums for avoiding fallback requirements.

@mattgarrish mattgarrish added the EPUB33 Issues addressed in the EPUB 3.3 revision label Nov 13, 2020
@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 Status-Proposed Solution A proposed solution has been included in the issue for working group review Topic-ContentDocs The issue affects EPUB content documents
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants