pdfkit: document outline (bookmarks) via AddOutlineItem - #23
Merged
Conversation
A generated PDF had no outline, so a viewer showed no bookmark sidebar to navigate a document's sections. Add Document.AddOutlineItem(title, level, pageIndex): items nest by level (an item deeper than the one before becomes its child) and Write builds the /Outlines tree — each a /Title with a /Dest to [page /Fit] and the /Parent //Prev //Next //First //Last //Count links a PDF outline requires. An invalid level or an out-of-range page is ignored; a document with no items carries no catalog /Outlines. Tests cover a nested tree (section/subsection with a stack unwind back to top level), the sibling and child links, and the ignored-item and no-outline paths; 100% coverage, go vet and gofmt clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
A generated PDF had no outline, so a viewer showed no bookmark sidebar to navigate a document's sections.
How
Document.AddOutlineItem(title, level, pageIndex)records a bookmark; items nest by level (an item deeper than the one before becomes its child), andWritebuilds the/Outlinestree — each entry a/Titlewith a/Destto[page /Fit]plus the/Parent·/Prev·/Next·/First·/Last·/Countlinks a PDF outline requires. An invalid level or out-of-range page is ignored; a document with no items carries no catalog/Outlines.Verification
Tests cover a nested tree (section → subsection with a stack unwind back to top level), the sibling/child links, and the ignored-item and no-outline paths. 100% coverage,
go vet,gofmtclean.Enables a bookmark sidebar in go-tex/engine (a follow-up feeds section headings from the engine's TOC entries).
🤖 Generated with Claude Code