fix(converter): use sequential display numbers for footnotes/endnotes#94
Merged
fix(converter): use sequential display numbers for footnotes/endnotes#94
Conversation
Per ECMA-376, the w:id attribute on footnoteReference/endnoteReference elements is a reference identifier linking to definitions, not the display number. Display numbers should be sequential (1, 2, 3...) based on document order. Previously, we incorrectly used raw XML IDs (e.g., 2, 3, 4...) as display numbers, causing footnotes to be numbered starting from 2 instead of 1. Changes: - Add FootnoteNumberingTracker class to map XML IDs to sequential display numbers based on document order - Update ProcessFootnoteReference/ProcessEndnoteReference to use display numbers instead of XML IDs - Update RenderFootnotesSection/RenderEndnotesSection to order notes by document order and use correct display numbers - Update RenderPaginatedFootnoteRegistry for pagination mode - Update documentation in docs/ooxml_corner_cases.md
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
1 participant
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.
Summary
w:idis a reference identifier, not the display numberProblem
Documents with footnotes were showing incorrect numbers. For example, a document with 91 footnotes would display them as 2-92 instead of 1-91, because we were using raw XML
w:idvalues.Solution
Added
FootnoteNumberingTrackerclass that:footnoteReference/endnoteReferenceelements in document orderChanges
Docxodus/WmlToHtmlConverter.cs: Core fix with new tracker class and updated renderingdocs/ooxml_corner_cases.md: Documentation of the issue and fixCHANGELOG.md: Entry addedTest plan