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.
72 lines
2.9 KiB
Typst
72 lines
2.9 KiB
Typst
// DEFAULT TEACHER TEMPLATE (framework default; ADR-0011, outline shape ADR-0029).
|
|
//
|
|
// Lives in an engineering file at `exports/teacher.typ`. Compiled AS MAIN with
|
|
// the manifest injected:
|
|
// typst compile --root <eng-root> --input manifest=<path-rel-to-root> exports/teacher.typ <out>
|
|
//
|
|
// Self-contained (copyable into an engineering file). Identical to student.typ
|
|
// except the fixed target is "teacher" (so the (kind x target) render matrix in
|
|
// cph-render shows solutions and proofs). See student.typ for the full notes on
|
|
// why the include loop lives here (package virtual-root resolution) and on the
|
|
// OPEN optional-content (`fields`) contract point.
|
|
|
|
#import "@local/cph-render:0.1.0": render-lesson, part-fields, default-heading-numbering
|
|
|
|
// This template IS the teacher build, so the target is fixed.
|
|
#let target = "teacher"
|
|
|
|
// Read the injected manifest (a path string relative to typst --root).
|
|
#let manifest = toml(sys.inputs.manifest)
|
|
#let info = manifest.at("info", default: (:))
|
|
#let raw-outline = manifest.at("outline", default: ())
|
|
|
|
// Assemble each outline entry: an "element" entry includes its content fields
|
|
// and reads scalars from element.toml; a "section" entry (ADR-0029) passes
|
|
// title/depth straight through as a heading, no content to load.
|
|
#let outline = raw-outline.map(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: ()))
|
|
// Which optional content fields are present on disk (manifest-declared).
|
|
let present = raw.at("fields", default: ())
|
|
let entry = (entry-type: "element", kind: kind)
|
|
|
|
// Required content fields: <path>/<field>.typ (absolute, root-relative).
|
|
for field in spec.content {
|
|
entry.insert(field, include "/" + path + "/" + field + ".typ")
|
|
}
|
|
// Optional content fields: only when the manifest says the file exists.
|
|
for field in spec.optional-content {
|
|
if field in present {
|
|
entry.insert(field, include "/" + path + "/" + field + ".typ")
|
|
}
|
|
}
|
|
// Scalar fields come from <path>/element.toml.
|
|
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
|
|
}
|
|
})
|
|
|
|
// Presentation: per-level heading numbering. Default (一、 / 1.1 / 1.1.1) comes
|
|
// from cph-render; override here per engineering file if desired.
|
|
#render-lesson(
|
|
info: info,
|
|
target: target,
|
|
outline: outline,
|
|
heading-numbering: default-heading-numbering,
|
|
)
|