thegetty/quire

Quire EPUB QA

Erin-Cecele opened this issue · 4 comments

Erin-Cecele commented

Before proceeding, make sure there isn’t an existing issue for this bug.

  • I have searched the existing issues and determined this is a new bug.

Expected Behavior

This story is to capture all issues related to the core functioning and file output of the quire epub command.

EPUB files must pass EPUBCheck validation without ERRORS, and hopefully also without WARNINGS. Most EPUB vendors will not distribute files that do not validate. To run the validator, download the latest version and with Java installed run:

$ java -jar path/to/local/epubcheck-5.0.0/epubcheck.jar path/to/local/quire-project/epubjs.epub

Another useful tool for working with EPUBs is the ePub Zip/Unzip 2.0.1 script. Which allows you to zip and unzip the epubjs.epub file easily. (EPUB files must be zipped in a particular order, which isn't the default order on macOS.)

  • Individual XHTML files for EPUB are being output with extra HTML elements
  • HTML elements require their closing slash for EPUB
  • The ordering of pages in the EPUB is incorrect
  • Named HTML entities like   aren't allowed in EPUB
  • Contributor links cannot have "undefined" attributes in EPUB
  • Links can't wrap other links in EPUB
  • Images used as background images are not being included in _epub output
  • <title> elements must not be empty for EPUB
  • Internal links need to be rewritten to match EPUB file structure and naming
  • Video poster image is not being included in ouptut
  • EPUB manifest needs listing for static cover image
  • Pub date not formatting/validating correctly in EPUB manifest
  • EPUB pages that include SVGs must include SVG as property
  • Footnote id values are being truncated in EPUB output
  • <title> elements cannot include html tags in EPUB
  • EPUB files that start with numbers cause validation errors
  • Soundcloud player should not be included in EPUB or PDF output
  • Leading slash in asset paths in the EPUB cause validation errors
  • EPUB pages that include SVG icons, need the icons <symbol> info included
  • Links to anchors on other pages, are not being properly transformed for the EPUB
  • Title not being included in EPUB manifest if there's no subtitle

Actual Behavior

N/A

Steps to Reproduce

N/A

Version Numbers

N/A

Web Browser

N/A

Relevant Terminal/Shell Output

N/A

Supporting Information

N/A

Erin-Cecele commented

This Issue is currently in progress. Items will be checked off as they are completed.

Erin-Cecele commented

Updates:

  • EPUB pages that include SVGs must include SVG as property - this is currently blocked.
Erin-Cecele commented

update as of 10/11:

  • Links to anchors on other pages, are not being properly transformed for the EPUB - SELECTED FOR DEVELOPMENT
  • Title not being included in EPUB manifest if there's no subtitle - IN PROGRESS
Erin-Cecele commented

Closing this issue as the work is now complete.