Skip to content

fix(typst-book): localize orange-book running header when lang is set#14525

Draft
cderv wants to merge 7 commits into
mainfrom
fix/orange-book-typst-running-header-lang
Draft

fix(typst-book): localize orange-book running header when lang is set#14525
cderv wants to merge 7 commits into
mainfrom
fix/orange-book-typst-running-header-lang

Conversation

@cderv
Copy link
Copy Markdown
Member

@cderv cderv commented May 18, 2026

When rendering a Typst book with lang: set to a non-English locale, the orange-book running header keeps the English Chapter N. prefix instead of the locale's word (e.g. Chapitre N. for lang: fr).

Root cause

The orange-book book(...) exposes a supplement-chapter parameter (default "Chapter") consumed by a show heading.where(level: 1): set heading(supplement: ...) rule that drives the running header. The Quarto-side typst-show.typ never passed this parameter to book.with(...), so the English default applied regardless of lang:.

The localized value lives in format.language["crossref-ch-prefix"] (loaded from _language-<lang>.yml). languageFilterParams exposes it to Lua filter params, but no code wrote it into Pandoc YAML metadata where the $crossref-ch-prefix$ template variable would resolve.

The same gap affected the existing list-of-figure-title and list-of-table-title pipes in the same template — they silently rendered as empty strings when the user enabled lof: true / lot: true.

Fix

crossref/meta.lua now surfaces crossref-ch-prefix, crossref-lof-title, and crossref-lot-title from filter params into Pandoc metadata via a new surfaceParamToMeta(meta, key) helper in common/meta.lua. The orange-book typst-show.typ gains a gated supplement-chapter: "$crossref-ch-prefix$" pipe; the two list-title pipes start working as a side effect.

The template change landed upstream in quarto-ext/orange-book#3 and arrives in this branch via quarto dev-call pull-git-subtree orange-book (the squash + merge commits at the tip). The pipe is gated on $if(crossref-ch-prefix)$...$endif$ so older Quarto versions or non-Quarto consumers of the template fall back to book()'s own default Chapter.

User precedence is preserved: surfaceParamToMeta only writes when meta[key] is unset, so explicit metadata wins.

Documentation

A new llm-docs/localization-architecture.md maps the full localization pipeline across HTML, LaTeX/PDF, and Typst, and documents the design split between crossref: block (per-document overrides for a subset of keys) and language: block (translations for the full set, including crossref-ch-prefix / crossref-apx-prefix).

Two further doc additions, discovered during review, codify the subtree workflow for future contributors:

  • .claude/rules/extension-subtrees.md — path-scoped rule loaded when editing files under src/resources/extension-subtrees/, encoding the upstream-first procedure
  • dev-docs/subtree-extensions.md — gains "Updating an extension" and "Recovery" sections, plus a typo fix on the prefix path

Important

This branch contains subtree-pull commits at the tip and cannot be rebased — merge to main without rebasing.

Fixes #14524

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes
  • updated the appropriate changelog in the PR
  • ensured the present test suite passes
  • added new tests
  • created a separate documentation PR in Quarto's website repo and linked it to this PR
AI-assisted PR
  • AI tool used: Claude Code
  • Codebase grounding: local clone, DeepWiki MCP
  • Human review: I have reviewed, tested, and verified the AI-generated content before submitting.

@posit-snyk-bot
Copy link
Copy Markdown
Collaborator

posit-snyk-bot commented May 18, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@gordonwoodhull
Copy link
Copy Markdown
Member

This is the right fix! But currently it needs to be made on:

https://github.com/quarto-ext/orange-book

Then once it’s on main on that repo, run

quarto dev-call pull-git-subtree orange-book

to update the subtree.

Modifying it directly will “work”, but only until the next time that repo is updated. (And won’t help anyone who might have forked that repo for their own changes.)

It’s debatable whether that repo needs to be a subtree extension instead of fully built-in. My rationale is that it is somewhat independent of Quarto; could get forked; we could switch to another fork or another extension. Glad to discuss.

https://github.com/quarto-dev/quarto-cli/blob/main/dev-docs/subtree-extensions.md

For that matter it’s also possible to push your changes back to the repo with git subtree push but I haven’t tried that.

@cderv
Copy link
Copy Markdown
Member Author

cderv commented May 18, 2026

How did I forgot !! 🤦 We discussed it. Sorry for this and thanks for the reminder.

@gordonwoodhull
Copy link
Copy Markdown
Member

gordonwoodhull commented May 18, 2026

You’ll also find that you can’t rebase the subtree & will get weird path errors if you try. So you’ll need to merge the branch without rebasing.

(The complexity has to go somewhere I guess. Subtrees are still less confusing than submodules IMO.)

cderv added 6 commits May 19, 2026 13:03
Surfaces crossref-ch-prefix, crossref-lof-title, and crossref-lot-title
from format.language into Pandoc YAML metadata so they resolve in the
orange-book typst-show.typ template. Adds a small surfaceParamToMeta
helper in common/meta.lua for reuse by future channel-2b localized
template vars.

The supplement-chapter parameter on book.with(...) drives the running
header via a show heading rule; without the meta surfacing it defaulted
to the English literal "Chapter" regardless of lang. The existing
list-of-figure-title and list-of-table-title pipes in the same template
were affected by the same gap and silently rendered as empty strings.

Fixes #14524
Maps the full lang: → rendered output pipeline across HTML, LaTeX/PDF,
and Typst. Documents the three downstream surfaces from format.language
(Lua filter params, explicit format.metadata copies in pandoc.ts, direct
TS reads in HTML extras) and the design split between crossref: block
(per-document overrides) and language: block (translations) per the
crossref schema.
Adds a path-scoped .claude/rules/ guard so files under
src/resources/extension-subtrees/ surface a "do not edit directly"
warning when touched. Fleshes out dev-docs/subtree-extensions.md
with explicit "Updating an extension" and "Recovery" sections
covering the rare in-tree-edit case.
… 9f786e1b4..b11e50490

b11e50490 Merge pull request #3 from quarto-ext/fix/localize-running-header
77a306cb0 Forward crossref-ch-prefix to book() for localized running header

git-subtree-dir: src/resources/extension-subtrees/orange-book
git-subtree-split: b11e50490d1b802c919e85bf94e1fb9d20977611
@cderv cderv force-pushed the fix/orange-book-typst-running-header-lang branch from 439af28 to add83ea Compare May 19, 2026 11:11
@cderv
Copy link
Copy Markdown
Member Author

cderv commented May 19, 2026

git subtree push was not adapted here. It was inspected al 20000+ commits to split before pushing the one change.

So now I understand how it works, and it is a nice way to externalize some work, and have monorepo + external repo.

Anyway, I did quarto-ext/orange-book#3 and then rebase the branch to edit change before calling dev-call command.

It should be good.

@cderv
Copy link
Copy Markdown
Member Author

cderv commented May 19, 2026

I don't like the way those language var are exposed. So I think want to make a deeper feature fix by leveraging newest --variable-json for language keys. I'll look into this.

@cderv cderv marked this pull request as draft May 19, 2026 12:59
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

Successfully merging this pull request may close these issues.

Typst book running header not localized when lang: is set to a non-English locale

3 participants