Investigate TOC Fails - Githubissues

and-rad commented 4 years ago

Some table of contents entries fail to navigate to the specified position in the book. Clicking on them produces a No Section Found error.

Stack trace:

epub.min.js:formatted:5124 Uncaught (in promise) Error: No Section Found
    at b._display (epub.min.js:formatted:5124)
    at e.a.dequeue (epub.min.js:formatted:2541)
    at epub.min.js:formatted:2558
_display @ epub.min.js:formatted:5124
dequeue @ epub.min.js:formatted:2541
(anonymous) @ epub.min.js:formatted:2558
Promise.then (async)
dequeue @ epub.min.js:formatted:2541
(anonymous) @ epub.min.js:formatted:2558
requestAnimationFrame (async)
run @ epub.min.js:formatted:2557
enqueue @ epub.min.js:formatted:2535
display @ epub.min.js:formatted:5106
toSection @ app.js:1

Another problem is that TOC entries are not always highlighted even though they should be. Seems to be linked to url fragments.

An example file is attached.

[x] Fix section not found error
[x] Fix TOC highlighting
[x] Fix wrong TOC highlight when at beginning of section that contains subsections
[ ] Handle files that are listed in the spine but not in the nav document

and-rad commented 4 years ago

Helpful resources:

https://github.com/futurepress/epub.js/issues/1084 (explanation and suggestion for resolving the issue)
https://github.com/futurepress/epub.js/issues/1107 (issue mentions the same error message)
https://github.com/futurepress/epub.js/blob/a1e77b745ba3d0ba122d70d276a08afe44270d17/src/navigation.js#L150 (relevant source code)

and-rad commented 4 years ago

Helpful resources for the highlight issue

and-rad commented 4 years ago

How to handle files that are listed in the spine but not in the TOC? They won't show up in the table of contents, but more importantly, they cause the highlight to disappear from the TOC entry.

and-rad / books

Investigate TOC Fails #9