EPUB3 "popup" footnotes #505
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rkwright
added
priority:High
type:Enhancement
func:Highlight
func:UX
status:Reproducible
and removed
enhancement
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Work In Progress
See the shared-js PR: Waffle connects to readium/readium-shared-js#33
Demos:
http://readium-footnotes.surge.sh/?epub=https%3A%2F%2Freadium.firebaseapp.com%2Fepub_content%2Fmoby_dick&goto=%7B%22idref%22%3A%22xpreface_001%22%2C%22elementCfi%22%3A%22%2F4%2F2%2F2%2F2%2C%2F1%3A0%2C%2F1%3A1%22%7D
http://readium-footnotes.surge.sh/?epub=https%3A%2F%2Fcdn.rawgit.com%2FIDPF%2Fepub3-samples%2Fmaster%2F30%2Fgeorgia-cfi&goto=%7B%22idref%22%3A%22doc1%22%2C%22elementCfi%22%3A%22%2F4%2F2%5Bd10e42%5D%2F18%5Bd10e150%5D%2F4%5Bd10e155%5D%2C%2F1%3A762%2C%2F1%3A763%22%7D
http://readium-footnotes.surge.sh/?epub=https%3A%2F%2Fcdn.rawgit.com%2Fmichal-h21%2Fepub3sample%2Fmaster%2Fhsmmt10t.epub&goto=%7B%22idref%22%3A%22file21%22%2C%22elementCfi%22%3Anull%7D
The basic principle is that handling of popup footnotes can be disabled via a runtime configuration flag (reverting to regular hyperlinking), and that the actual display of the note contents (popup overlay) can be customized in a particular app implementation. Right now in this feature branch, we use an application-level popup dialog (which is fully accessible to screen readers), but it could potentially be a div overlay inside the EPUB HTML. The main challenge is to render some HTML+CSS fragment outside of the main rendering context, to sanitize the HTML markup, the hyperlinks, etc.