daisy / daisy/pipeline-modules
EPUB 3 Enhancer script's input description may be incorrect
- Dominant language
- HTML
- Stars
- 4
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
EPUB Enhancer's input description says
> You may alternatively use the "mimetype" document if your input is a unzipped/"exploded" version of an EPUB.
but mimetype files are just for zipped epubs _(from [EPUB 3.3](https://www.w3.org/TR/epub-33/#sec-container-file-and-dir-structure))_:
> The file name mimetype in the root directory is reserved for use by [OCF ZIP containers](https://www.w3.org/TR/epub-33/#dfn-ocf-zip-container), as explained in [4.3 OCF ZIP container](https://www.w3.org/TR/epub-33/#sec-container-zip).
Contributor guide
No contributing guide indexed for this repository
Research direction
Search the EPUB 3 Enhancer script for the quoted input description and read the surrounding help text. Check the EPUB 3.3 container guidance linked in the issue, then revise the description so it accurately explains which input form can use the mimetype file; the corrected help text should no longer claim it applies to exploded EPUBs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100