Reference book page numbers missing in TOC and on song pages #25

New Issue

shahondin1624 · 2026-03-17T14:38:02+01:00

shahondin1624 commented

2026-03-17 14:38:02 +01:00

Description

The songbook supports cross-references to other songbooks via {ref: bookId pageNumber} directives in songs and reference_books configuration in songbook.yaml. These should appear as:

In the TOC: Additional columns showing page numbers in other songbooks (one column per reference book)
On song pages: A footer showing reference book abbreviations and corresponding page numbers

Both features have rendering code (TocRenderer for TOC columns, PdfBookRenderer for song page footer), but the reference information is not appearing in the rendered output. This could be due to:

The reference data not being parsed correctly from song files
The referenceBooks config not being loaded properly
Conditional rendering guards preventing output (e.g., empty references map)
The recent overflow/split changes (PR #20) breaking the footer positioning

Acceptance Criteria

When reference_books is configured in songbook.yaml and songs contain {ref: ...} directives, the TOC displays additional columns with reference book abbreviations as headers and page numbers in the data rows
When a song has references, a footer on the song page shows the reference book abbreviations and corresponding page numbers, separated from the song content by a line
The toc.highlight_column configuration correctly highlights the specified column in the TOC
Songs without references do not show an empty footer
Existing tests pass
The reference footer is correctly positioned on the last page of multi-page songs

Relevant Code

parser/.../ChordProParser.kt — parsing of {ref: bookId pageNumber} directives
renderer-pdf/.../TocRenderer.kt — TOC reference columns
renderer-pdf/.../PdfBookRenderer.kt — song page reference footer
layout/.../MeasurementEngine.kt:94-99 — space reservation for reference footer
model/.../Song.kt — references: Map<String, Int>
model/.../BookConfig.kt — referenceBooks: List<ReferenceBook>

## Description The songbook supports cross-references to other songbooks via `{ref: bookId pageNumber}` directives in songs and `reference_books` configuration in `songbook.yaml`. These should appear as: 1. **In the TOC**: Additional columns showing page numbers in other songbooks (one column per reference book) 2. **On song pages**: A footer showing reference book abbreviations and corresponding page numbers Both features have rendering code (`TocRenderer` for TOC columns, `PdfBookRenderer` for song page footer), but the reference information is not appearing in the rendered output. This could be due to: - The reference data not being parsed correctly from song files - The `referenceBooks` config not being loaded properly - Conditional rendering guards preventing output (e.g., empty references map) - The recent overflow/split changes (PR #20) breaking the footer positioning ## Acceptance Criteria - [ ] When `reference_books` is configured in `songbook.yaml` and songs contain `{ref: ...}` directives, the TOC displays additional columns with reference book abbreviations as headers and page numbers in the data rows - [ ] When a song has references, a footer on the song page shows the reference book abbreviations and corresponding page numbers, separated from the song content by a line - [ ] The `toc.highlight_column` configuration correctly highlights the specified column in the TOC - [ ] Songs without references do not show an empty footer - [ ] Existing tests pass - [ ] The reference footer is correctly positioned on the last page of multi-page songs ## Relevant Code - `parser/.../ChordProParser.kt` — parsing of `{ref: bookId pageNumber}` directives - `renderer-pdf/.../TocRenderer.kt` — TOC reference columns - `renderer-pdf/.../PdfBookRenderer.kt` — song page reference footer - `layout/.../MeasurementEngine.kt:94-99` — space reservation for reference footer - `model/.../Song.kt` — `references: Map<String, Int>` - `model/.../BookConfig.kt` — `referenceBooks: List<ReferenceBook>`

shahondin1624 referenced this issue from a commit

2026-03-17 14:59:28 +01:00

fix: position reference footer below content to prevent overlap (Closes #25)

shahondin1624 referenced a pull request that will close this issue

2026-03-17 14:59:41 +01:00

fix: position reference footer below content to prevent overlap (Closes #25) #28

shahondin1624 closed this issue

2026-03-17 14:59:49 +01:00

shahondin1624 referenced this issue from a commit

2026-03-17 14:59:49 +01:00

fix: position reference footer below content to prevent overlap (Closes #25) (#28)

Sign in to join this conversation.