explico 0.4.0 → 0.6.0

package/src/compiler/collections.ts

@@ -24,6 +24,7 @@ import type {
   TrackDefinition,
 } from '../curriculum/validation';
 import type {
+  AbbreviationDefinitionInput,
   EditorialStatus,
   LocalNotationDefinitionInput,
   NotationAlignment,
@@ -37,6 +38,8 @@ import type {
 import { isSubstantiveMeaning } from '../reference/prose';
 import { parseEquationRef } from '../reference/equations.mjs';
 import { parseKeyedFloatRef } from '../reference/keyed-jsx-floats.mjs';
+import { parseKnowledgeCheckRef } from '../reference/knowledge-checks.mjs';
+import { parseMemoRef } from '../reference/remark-memo.mjs';
 import { resolveLabel } from '../reference/label';
 import { resolveGlosses } from '../reference/gloss';
 import {
@@ -231,13 +234,17 @@ export function extractNotationReferences(
     for (const match of searchable.matchAll(pattern)) {
       const key = (match[1] ?? '').trim();
       // `[[eq-key]]` / `[[slug#eq-key]]` are equation references (D7), and
-      // `[[tab-key]]`/`[[fig-key]]` (and their cross-page forms) are
-      // `<Table>`/`<Figure>` references (F-tables-figures) — all resolved by
-      // the remark pass and the manifest, not notation keys.
+      // `[[tab-key]]`/`[[fig-key]]`/`[[dia-key]]` (and their cross-page forms)
+      // are keyed-float references, `[[check-key]]` targets a lesson's
+      // assessment list, and `[[memo-key]]` is a page-local memo reference —
+      // all resolved by the remark pass and the manifest, not notation keys.
       if (
         parseEquationRef(key) ||
         parseKeyedFloatRef(key, { prefix: 'tab' }) ||
-        parseKeyedFloatRef(key, { prefix: 'fig' })
+        parseKeyedFloatRef(key, { prefix: 'fig' }) ||
+        parseKeyedFloatRef(key, { prefix: 'dia' }) ||
+        parseKnowledgeCheckRef(key) ||
+        parseMemoRef(key)
       ) {
         continue;
       }
@@ -438,6 +445,40 @@ function sharedNotationEntries(): SharedNotationDefinitionInput[] {
   });
 }
 
+/**
+ * Abbreviations table (rule N14) — a lighter tier than a notation card, read
+ * straight off disk the same way `sharedNotationEntries` reads `notation/`.
+ * The directory is optional: a course that never uses this feature need not
+ * create an empty `content/abbreviations/`.
+ */
+function abbreviationEntries(): AbbreviationDefinitionInput[] {
+  const directory = join(CONTENT_ROOT, 'abbreviations');
+  if (!existsSync(directory)) return [];
+  return filesBelow(directory, ['.md']).map((path) => {
+    const { file, data } = parseDocument(path);
+    const key = string(data.key, `${file} key`);
+    const filenameKey = basename(path, '.md');
+    if (key !== filenameKey) {
+      throw new Error(`${file} declares key ${key}; expected ${filenameKey}`);
+    }
+    const domain = optionalString(data.domain, `${file} domain`);
+    return {
+      key,
+      abbr: string(data.abbr, `${file} abbr`),
+      expansion: meaningText(data.expansion, `${file} expansion`),
+      aliases: strings(data.aliases, `${file} aliases`),
+      source: { file },
+      ...(domain === undefined ? {} : { domain }),
+    };
+  });
+}
+
+export async function loadAbbreviationRegistryInput(): Promise<
+  readonly AbbreviationDefinitionInput[]
+> {
+  return abbreviationEntries();
+}
+
 function notationLessonEntries(): NotationLessonInput[] {
   const lessons: NotationLessonInput[] = [];
   for (const path of filesBelow(join(CONTENT_ROOT, 'docs'), ['.md', '.mdx'])) {

package/src/compiler/course-config.ts

@@ -49,6 +49,39 @@ export interface CourseOperators {
   readonly deny?: readonly string[];
 }
 
+/**
+ * A course's edits to the shipped roman-label baseline (`BASE_ROMAN_LABELS`),
+ * consumed by the `roman-label-explained` consistency check (rule N10). A
+ * `\mathrm{…}` multi-letter label a lesson uses is fine when it is on the
+ * baseline plus `allow` minus `deny`; otherwise it needs a notation entry the
+ * reader can hover. Same shape as {@link CourseOperators}, one level down:
+ * this governs `\mathrm{KE}`-style labels, not `\operatorname{Var}`-style
+ * operators.
+ */
+export interface CourseRomanLabels {
+  /** Labels this course also treats as universal qualifiers (`eff`, `net`, …). */
+  readonly allow?: readonly string[];
+  /** Baseline labels this course wants explained anyway. */
+  readonly deny?: readonly string[];
+}
+
+/**
+ * A course's edits to the shipped abbreviation baseline (`BASE_ABBREVIATIONS`),
+ * consumed by the `abbreviation-explained` gate (rule N14). An abbreviation-
+ * shaped token — an all-caps acronym or a dotted form like `w.r.t.` — a
+ * lesson uses in prose is fine when it is on the baseline plus `allow` minus
+ * `deny`; otherwise it needs an entry in the `abbreviations` content
+ * collection, or — if it also names a math quantity — a notation entry the
+ * reader can hover. Same shape as {@link CourseOperators} / {@link
+ * CourseRomanLabels}.
+ */
+export interface CourseAbbreviations {
+  /** Abbreviations this course also treats as universal (`GDP`, `CPU`, …). */
+  readonly allow?: readonly string[];
+  /** Baseline abbreviations this course wants explained anyway. */
+  readonly deny?: readonly string[];
+}
+
 /** One person or team credited for the study material. */
 export interface CourseAuthor {
   readonly name: string;
@@ -83,6 +116,63 @@ export interface CourseAbout {
   readonly changelogHref?: string;
 }
 
+/**
+ * A course's chosen initial open/closed state for the engine's own built-in
+ * collapsible sections — the "Page notation" panel (`NotationLayer.astro`)
+ * and the generated "References" section (`remark-citation.mjs`). Each is
+ * independent of `defaultCollapsible.sections`/`.subsections` (an author's
+ * own `##` headings): both of these are engine-authored, not written by a
+ * lesson, so they need their own default rather than inheriting the site's
+ * general heading default.
+ *
+ * `true` starts open, `false` (or omitted) starts closed — the engine's own
+ * default is closed either way, matching a long panel a reader usually
+ * doesn't need open on arrival.
+ */
+export interface CourseDisclosureDefaults {
+  /** Initial state of the "Page notation" panel. Default: closed. */
+  readonly notation?: boolean;
+  /** Initial state of the generated "References" section. Default: closed. */
+  readonly references?: boolean;
+}
+
+/** The stable, non-optional form `NormalizedLessonExports` mirrors. */
+export interface NormalizedDisclosureDefaults {
+  readonly notation: boolean;
+  readonly references: boolean;
+}
+
+/** Validate and canonicalize `CourseConfig.disclosureDefaults`. Absent (or
+ *  an absent sub-field) resolves to closed, the engine's own default. */
+export function normalizeDisclosureDefaults(
+  config: CourseConfig,
+): NormalizedDisclosureDefaults {
+  return {
+    notation: config.disclosureDefaults?.notation === true,
+    references: config.disclosureDefaults?.references === true,
+  };
+}
+
+/** Optional, build-time lesson artifacts exposed to readers. */
+export interface LessonExportsConfig {
+  /** Emit one self-contained, offline-capable HTML file per lesson. */
+  readonly standaloneHtml?: boolean;
+  /** Offer the browser's native print dialog with explico's lesson print layout. */
+  readonly print?: boolean;
+  /**
+   * Published course root used for links that intentionally leave the exported
+   * lesson. Required at export time when such a link is present.
+   */
+  readonly canonicalBaseUrl?: string;
+}
+
+/** The stable, non-optional export settings carried by the manifest. */
+export interface NormalizedLessonExports {
+  readonly standaloneHtml: boolean;
+  readonly print: boolean;
+  readonly canonicalBaseUrl?: string;
+}
+
 export interface CourseConfig {
   readonly title: string;
   readonly description: string;
@@ -103,6 +193,48 @@ export interface CourseConfig {
   readonly about: CourseAbout;
   /** Edits to the shipped named-operator baseline (rule N8). Optional. */
   readonly operators?: CourseOperators;
+  /** Edits to the shipped roman-label baseline (rule N10). Optional. */
+  readonly romanLabels?: CourseRomanLabels;
+  /** Edits to the shipped abbreviation baseline (rule N14). Optional. */
+  readonly abbreviations?: CourseAbbreviations;
+  /** Per-lesson export actions and downloadable artifacts. Disabled when omitted. */
+  readonly lessonExports?: LessonExportsConfig;
+  /** Initial open/closed state for the engine's own built-in collapsible
+   *  sections ("Page notation", "References"). Closed when omitted. */
+  readonly disclosureDefaults?: CourseDisclosureDefaults;
+}
+
+/** Validate and canonicalize the build-facing lesson-export configuration. */
+export function normalizeLessonExports(
+  config: CourseConfig,
+): NormalizedLessonExports {
+  const standaloneHtml = config.lessonExports?.standaloneHtml === true;
+  const print = config.lessonExports?.print === true;
+  const rawBase = config.lessonExports?.canonicalBaseUrl;
+  if (rawBase === undefined) return { standaloneHtml, print };
+
+  let parsed: URL;
+  try {
+    parsed = new URL(rawBase);
+  } catch {
+    throw new Error(
+      `CourseConfig lessonExports.canonicalBaseUrl must be an absolute ` +
+        `http(s) URL; received ${JSON.stringify(rawBase)}.`,
+    );
+  }
+  if (parsed.protocol !== 'https:' && parsed.protocol !== 'http:') {
+    throw new Error(
+      `CourseConfig lessonExports.canonicalBaseUrl must use http(s); ` +
+        `received ${JSON.stringify(rawBase)}.`,
+    );
+  }
+  if (parsed.search || parsed.hash) {
+    throw new Error(
+      'CourseConfig lessonExports.canonicalBaseUrl cannot contain a query or fragment.',
+    );
+  }
+  if (!parsed.pathname.endsWith('/')) parsed.pathname += '/';
+  return { standaloneHtml, print, canonicalBaseUrl: parsed.toString() };
 }
 
 /**