explico 0.8.0 → 0.11.1

package/dist/reference/remark-notation.d.mts

@@ -4,15 +4,21 @@
  * Every number on a page comes from two places that MUST agree: the page's own
  * counters (`numbering`) and the manifest tables a cross-page `[[slug#eq-key]]`
  * is resolved against (`equations` / `tables` / `figures` / `diagrams` /
- * `checks`).
+ * `checks` / `examples`).
  * Deriving every input from the same manifest in one step stops a course config from
  * supplying one without the other — the omission that produced page-local
  * `(2.2)` and cross-page `(4.5)` for the same equation.
  *
  * `numbering` maps a lesson slug to
- * `{ part, equations, tables, figures, diagrams, checks }`: the part's ordinal
- * (the number before the dot) and, per numbered kind, how many earlier lessons
- * of that part already used.
+ * `{ part, chapter, prefix, equations, tables, figures, diagrams, checks,
+ * examples }`:
+ * the part and chapter ordinals, the float-number prefix (`‹part›.‹chapter›`,
+ * or the part alone under `numbering.floats: "part"`), and, per numbered kind,
+ * how many precede the lesson in that scope. `sections` maps a lesson slug to
+ * its top-level headings (`manifest.lessons[].headings`), and
+ * `sectionNumbering` is the course's `{ show, depth }`. `checkTitles` and
+ * `exampleTitles` map a lesson slug to its checks' and example sets' titles,
+ * which a reference prints when the course hides section numbers.
  */
 export function numberingFromManifest(manifest: any): {
     equations?: undefined;
@@ -20,6 +26,11 @@ export function numberingFromManifest(manifest: any): {
     figures?: undefined;
     diagrams?: undefined;
     checks?: undefined;
+    examples?: undefined;
+    checkTitles?: undefined;
+    exampleTitles?: undefined;
+    sections?: undefined;
+    sectionNumbering?: undefined;
     numbering?: undefined;
 } | {
     equations: any;
@@ -27,6 +38,17 @@ export function numberingFromManifest(manifest: any): {
     figures: any;
     diagrams: any;
     checks: any;
+    examples: any;
+    checkTitles: {
+        [k: string]: any;
+    };
+    exampleTitles: {
+        [k: string]: any;
+    };
+    sections: {
+        [k: string]: any;
+    };
+    sectionNumbering: any;
     numbering: {
         [k: string]: any;
     };
@@ -70,7 +92,12 @@ export function createRemarkNotationOptions(manifest: object, overrides?: object
  *   figures?: Record<string, Record<string, string>>,
  *   diagrams?: Record<string, Record<string, string>>,
  *   checks?: Record<string, Record<string, string>>,
- *   numbering?: Record<string, { part: number, equations: number, tables: number, figures: number, diagrams: number, checks: number }>,
+ *   examples?: Record<string, Record<string, string>>,
+ *   checkTitles?: Record<string, Record<string, string>>,
+ *   exampleTitles?: Record<string, Record<string, string>>,
+ *   sections?: Record<string, readonly { slug: string, text: string, level: number, number?: string }[]>,
+ *   sectionNumbering?: { show: boolean, depth: number },
+ *   numbering?: Record<string, { part: number, chapter?: number, prefix?: string, equations: number, tables: number, figures: number, diagrams: number, checks: number, examples?: number }>,
  *   chapters?: Record<string, number>,
  * }} [options]
  *
@@ -79,16 +106,23 @@ export function createRemarkNotationOptions(manifest: object, overrides?: object
  * They stay available individually for hand-built trees, and an explicitly
  * supplied one still wins over the manifest.
  *
- * `numbering` maps a lesson slug to its **part** (the number before the dot)
- * and, per kind of float, how many the earlier lessons of that part already
- * used. Every display equation / `<Table>` / `<Figure>` / `<Diagram>` on the page is then
- * numbered `‹part›.‹offset + n›`, with `##` and `###` headings ignored; with no
- * entry the legacy `##`-section scheme applies. It must agree with
+ * `numbering` maps a lesson slug to its **part** and **chapter**, its float
+ * `prefix` (`‹part›.‹chapter›`, or the part alone under `numbering.floats:
+ * "part"`) and, per kind of float, how many precede the lesson in that scope.
+ * Every display equation / `<Table>` / `<Figure>` / `<Diagram>` /
+ * `<CompactExamples>` on the page is then numbered `‹prefix›.‹offset + n›`,
+ * with `##` and `###` headings ignored;
+ * with no entry the legacy `##`-section scheme applies. It must agree with
  * `manifest.lessons[]`, which is what feeds `equations`/`tables`/`figures`/`diagrams`
  * above — supplying the tables without `numbering` numbers the same equation
  * twice, and `assertManifestNumberParity` turns that into a build error rather
  * than a page whose references disagree with their targets.
  *
+ * `sections` maps a lesson slug to its top-level headings, and
+ * `sectionNumbering` is the course's `{ show, depth }`: a page's own headings
+ * take the anchors and outline numbers listed there (`stampSectionHeadings`),
+ * and `[[sec-…]]` prints `§ 1.1.2` from the same list.
+ *
  * `chapters` is the superseded per-lesson form (slug → the lesson's course
  * ordinal, no running offset). Still read when `numbering` has no entry, so a
  * config written against the old option keeps building.
@@ -113,13 +147,29 @@ export default function remarkNotation(options?: {
     figures?: Record<string, Record<string, string>>;
     diagrams?: Record<string, Record<string, string>>;
     checks?: Record<string, Record<string, string>>;
+    examples?: Record<string, Record<string, string>>;
+    checkTitles?: Record<string, Record<string, string>>;
+    exampleTitles?: Record<string, Record<string, string>>;
+    sections?: Record<string, readonly {
+        slug: string;
+        text: string;
+        level: number;
+        number?: string;
+    }[]>;
+    sectionNumbering?: {
+        show: boolean;
+        depth: number;
+    };
     numbering?: Record<string, {
         part: number;
+        chapter?: number;
+        prefix?: string;
         equations: number;
         tables: number;
         figures: number;
         diagrams: number;
         checks: number;
+        examples?: number;
     }>;
     chapters?: Record<string, number>;
 }): (tree: any, file: any) => void;