Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Footnote pop-up and backreference links #123

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

gambhiro
Copy link
Contributor

@gambhiro gambhiro commented Nov 7, 2024

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.

[output.epub]
epub-version = 3

I think most users would expect this behaviour and so I set the footnote-backrefs option to true by default, but it is only used when epub-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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant