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

Disable popup footnotes, hiding the note contents only in some cases is confusing (aside + footnote semantics only, not endnotes) #2833

Open
lindheli opened this issue Mar 3, 2025 · 9 comments

Comments

@lindheli
Copy link

lindheli commented Mar 3, 2025

For Epub publications, under Display, when Disable footnotes is checked, the footnotes are shown and when Disable footnotes is unchecked, the footnotes are not shown. Shouldn’t it be the other way around? It is difficult to understand what this means. Perhaps the wording could be changed to “Hide footnotes” and the default setting would be unticked.

@danielweck
Copy link
Member

Hello, thank you for the bug report! This is now fixed in the develop branch for French and English languages, could you please make corrections in your locale via Weblate? https://hosted.weblate.org/projects/thorium-reader/thorium-reader-translation/

@lindheli
Copy link
Author

lindheli commented Mar 3, 2025

Have I understood it correctly that you have changed the wording from "Disable footnotes" to "Disable popup footnotes"?

The behavior is still confusing.
Unticked Disable (popup) footnotes: footnotes disappears from view, but endnotes are still visible
Ticked Disable (popup) footnotes: footnotes and endnotes are visible

We would prefer that all notes are always visible, also when the Disable (popup) footnotes is unticked.

@danielweck
Copy link
Member

Hello, "popup footnotes" is an EPUB3 feature. Thorium overrides the default link activation / click behaviour by intercepting the navigation event (which would normally take the user to the end of the current document, or to another document in the ebook spine).

If the referenced note content is located inside an aside element and marked with one of the correct semantic roles of "note", then the aside becomes hidden (CSS display=none).

Some EPUBs don't use the correct semantics on the note link and/or the note content, so without specific details about your use-case I cannot tell with certainty whether there is a bug in Thorium's implementation / interpretation of the specification.

Could you please clarify? Thank you very much :)

@danielweck
Copy link
Member

PS: my email is [email protected] if you are allowed to share an EPUB privately so I can run tests at my end.

@lindheli
Copy link
Author

lindheli commented Mar 3, 2025

I will send you the epub in an email. In it, you can see that the footnotes are located inside aside elements, but the endnotes are not. For a reader, we think it will be confusing that footnotes "disappear" when the popup is enabled, while the endnotes don't.

@danielweck
Copy link
Member

I think that the rationale for hiding footnotes that are reachable via the "popup footnotes" mechanism (instead of plain hyperlinking) is that there is need to allocate screen real estate (i.e. document space) for content that is presented in a "special way" (dismissable modal popup dialog overlay).

But I need to dig deeper into your particular EPUB so I can understand the confusion. Let's improve this! :)

@danielweck
Copy link
Member

danielweck commented Mar 3, 2025

Linda, your EPUB is very helpful, thank you :)

So, there are note links (epub:type="noteref" / role="doc-noteref") and there are note contents (epub:type="footnote" / role="doc-footnote", or epub:type="endnote" / role="doc-endnote" etc....)

There is indeed an inconsistency: Thorium only hides aside with with footnote semantics, not the other possible "note" semantics. Yet, the "popup footnote" feature is activated for any link with the "noteref" semantic.

I will investigate further in the code to double-check my assumptions. This is not a bug per-se, but the inconsistency is clearly problematic for end users. Unfortunately the EPUB specification is quite vague on this topic, there is basically no strict standard, there is just an expectation from publishers / users that Reading Systems support the "popup" style of notes.

Apple:
https://help.apple.com/itc/booksassetguide/en.lproj/itccf8ecf5c8.html

Use the <aside> element when you want to hide the footnote

@danielweck danielweck reopened this Mar 3, 2025
@danielweck danielweck changed the title Disable footnotes meaning is unclear Disable popup footnotes, hiding the note contents only in some cases is confusing (aside + footnote semantics only, not endnotes) Mar 3, 2025
@danielweck
Copy link
Member

Lots of debating around the lack of interoperability in reading systems:

https://www.google.com/search?q=epub+popup+footnotes+aside+site:www.mobileread.com

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

No branches or pull requests

2 participants