Footnote pop-up and backreference links #123
Open
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.
This adds an option to add backreference links at the end of footnote definitions, so that the user can return and continue reading the main body of the text.
The code is based on the footnote-rewrite.rs example.
The pop-up footnote behaviour requires the use of
<aside>
tag and so EPUB 3 is required.I think most users would expect this behaviour and so I set the
footnote-backrefs
option totrue
by default, but it is only used whenepub-version = 3
is already selected.On a Kindle Paperwhite, the footnote definition appears in a pop-up bottom window when the footnote reference number is tapped.
In KOReader on Remarkable 2 the footnote definition appears at the bottom of the screen.
The footnote definitions include a backreference link to jump back to the main body of the text.
This feature was also discussed at #65