Repository navigation
HTML_TOC: omit the footnotes block - #819
Merged
Merged
Conversation
The table of contents renderer used the HTML footnote callbacks, so a document with footnotes appended the footnotes div inside the list. Those callbacks are not headings, so the TOC renderer leaves them unset. A footnote body is not parsed when nothing is going to render it.
Collaborator
|
Would love a screenshot of the before and after so I can see how the rendering changes due to this PR. |
Contributor
Author
|
Here is the same note, before and after.
The footnotes block was sitting inside the Title item. The contents list is only the heading now. The footnote body is empty in that picture because the TOC renderer has no paragraph callback, so the visible change is the rule and the number. |
mattr-
approved these changes
Oct 14, 2026
Collaborator
|
Thanks for the screenshot! Will merge this as soon as the tests pass. |
Contributor
Author
|
Thanks for the merge. Glad the picture made the footnotes obvious. |
This file contains hidden or 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
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.
HTML_TOCrendered the footnotes block inside the contents list. A footnote is not a heading.The TOC renderer no longer sets the footnote callbacks. A footnote body is not parsed when the renderer has no footnote definition callback, so a heading inside a footnote cannot change the list nesting.
A normal HTML render still includes the footnotes block.
Red: the TOC contained
<div class="footnotes">. Green: the list is only the heading.bundle exec rake test:unitpassed, 151 tests. The conformance suite was not run.Fixes #815