forked from EduCraft/curriculum-project-hub
hongjr03
9927d38c18
ADR-0029 — nested outline manifest, supersedes ADR-0008's flat [[parts]]:
- cph-model: recursive loader over manifest.toml containers / element.toml
leaves; Lesson.parts (pure elements, DFS order) + Lesson.outline (elements
interleaved with section headings at their DFS-open position); rejects
ambiguous/incomplete folders and root-vs-container table misplacement
- cph-diag: new DiagCode::ManifestMalformed for carrier-document structure
errors (discharges an existing TODO)
- cph-typst: augmented manifest now serializes the outline (element/section
entries) instead of a flat parts array
- render/lib.typ: render-lesson renders section headings at their depth
- examples/TH-141 migrated to 5 nested section containers + 3 root segments,
byte-identical element order; smoke-verified via cph check/build + pdftotext
ADR-0030 — batch & combined export, extends ADR-0009/0011:
- cph build with no --target batches every declared target (repeatable
--target for an explicit subset); any target failure => non-zero exit,
per-target ledger, independent per-target execution
- cph-model: bundle.toml loader (directory + [info]/[targets.*]/ordered
lessons with per-lesson target overrides)
- cph-typst: augmented bundle manifest (path-prefixed member outlines),
Engine::{compile_check_bundle,build_bundle_pdf}
- render/lib.typ: render-bundle assembles member lessons under per-lesson
headings, depth-shifts their own section headings, resets example/lemma
counters at each lesson boundary by default
- cph-cli: `cph bundle <path> --target <name>` subcommand, same batching
contract as `cph build`
- new bundle fixtures/tests (cph-model unit + cph-typst through-template PDF
compile), smoke-verified via a real 2-lesson merged PDF
Verification: cargo fmt/clippy/test clean across the workspace (68 tests);
real cph check/build/bundle runs against TH-141 and a bundle fixture, PDF
content inspected via pdftotext.
77 lines
3.0 KiB
Typst
77 lines
3.0 KiB
Typst
// DEFAULT BUNDLE TEMPLATE (ADR-0030, outline shape ADR-0029).
|
|
//
|
|
// Lives in a bundle at `<bundle-root>/exports/<target>.typ`, e.g.
|
|
// `exports/merged.typ`. Compiled AS MAIN with the augmented BUNDLE manifest
|
|
// injected:
|
|
// typst compile --root <bundle-root> --input manifest=<path-rel-to-root> exports/merged.typ <out>
|
|
//
|
|
// Structurally identical to the single-lesson `student.typ`/`teacher.typ`
|
|
// templates (see their notes on why the include loop lives in the template,
|
|
// not in cph-render), except it reads `manifest.lessons` (an ordered array of
|
|
// per-lesson `(info, target, outline)` tables — see
|
|
// `cph_typst::build_augmented_bundle_manifest`) instead of a single
|
|
// `manifest.outline`, and calls `render-bundle` instead of `render-lesson`.
|
|
//
|
|
// Every outline entry's `path` in a bundle manifest is ALREADY prefixed with
|
|
// that lesson's own bundle-root-relative directory (done by the Rust engine),
|
|
// so the same `include "/" + path + "/" + field + ".typ"` computation used by
|
|
// a single-lesson template resolves correctly here too — no special-casing
|
|
// needed in this loop.
|
|
|
|
#import "@local/cph-render:0.1.0": render-bundle, part-fields, default-heading-numbering
|
|
|
|
#let manifest = toml(sys.inputs.manifest)
|
|
#let info = manifest.at("info", default: (:))
|
|
#let raw-lessons = manifest.at("lessons", default: ())
|
|
|
|
// Assemble one outline entry exactly as a single-lesson template would.
|
|
#let assemble-entry(raw) = {
|
|
if raw.at("type", default: "element") == "section" {
|
|
(
|
|
entry-type: "section",
|
|
kind: raw.at("kind", default: none),
|
|
title: raw.at("title", default: ""),
|
|
depth: raw.at("depth", default: 1),
|
|
)
|
|
} else {
|
|
let kind = raw.at("kind", default: none)
|
|
let path = raw.at("path", default: none)
|
|
let spec = part-fields.at(kind, default: (content: (), optional-content: (), scalars: ()))
|
|
let present = raw.at("fields", default: ())
|
|
let entry = (entry-type: "element", kind: kind)
|
|
|
|
for field in spec.content {
|
|
entry.insert(field, include "/" + path + "/" + field + ".typ")
|
|
}
|
|
for field in spec.optional-content {
|
|
if field in present {
|
|
entry.insert(field, include "/" + path + "/" + field + ".typ")
|
|
}
|
|
}
|
|
if spec.scalars.len() > 0 {
|
|
let element = toml("/" + path + "/element.toml")
|
|
for field in spec.scalars {
|
|
let v = element.at(field, default: none)
|
|
if v != none and v != "" { entry.insert(field, v) }
|
|
}
|
|
}
|
|
entry
|
|
}
|
|
}
|
|
|
|
#let lessons = raw-lessons.map(raw => (
|
|
info: raw.at("info", default: (:)),
|
|
target: raw.at("target", default: "student"),
|
|
outline: raw.at("outline", default: ()).map(assemble-entry),
|
|
))
|
|
|
|
// Presentation: shared per-level heading numbering across the whole bundle,
|
|
// and the ADR-0030 recommended default of resetting auto-counters at each
|
|
// lesson boundary (override `reset-counters: false` for continuous numbering).
|
|
#render-bundle(
|
|
info: info,
|
|
lessons: lessons,
|
|
heading-numbering: default-heading-numbering,
|
|
reset-counters: true,
|
|
)
|