{ "$id": "https://coursebank.dev/schema/course.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "description": "Course identity, policy, and the registries that item and assessment files reference by id: objectives, targets, lectures, references, stimuli, terms, equations, values, and misconceptions.", "properties": { "course": { "additionalProperties": false, "properties": { "code": { "description": "Course code, e.g. BIOSC 1540.", "minLength": 1, "type": "string" }, "institution": { "type": "string" }, "instructors": { "description": "Instructor names.", "items": { "type": "string" }, "type": "array" }, "slug": { "description": "Short identifier used in file names and administration ids. Derived from the code if omitted.", "type": "string" }, "term": { "description": "Term, e.g., 2026s.", "minLength": 1, "type": "string" }, "title": { "description": "Course title.", "minLength": 1, "type": "string" } }, "required": [ "code", "title", "term" ], "type": "object" }, "equations": { "additionalProperties": { "additionalProperties": false, "description": "One relation students meet in this course.", "properties": { "assumes": { "description": "Conditions that must hold for the relation to apply, one sentence each. Student-facing.", "items": { "type": "string" }, "type": "array" }, "fails_when": { "description": "Cases where the relation breaks or misleads, one sentence each. Student-facing. A level 4 item often hands students a wrong result and asks which assumption failed.", "items": { "type": "string" }, "type": "array" }, "implications": { "description": "What the relation says that a question can test without evaluating it. These are the raw material for level 2 and 3 targets on a relation, and the rendered 'what it tells you' list.", "items": { "additionalProperties": false, "properties": { "form": { "description": "direction: which way the output moves when one input rises. limit: what the relation gives at a boundary. scale: whether a stated difference is large or negligible on the relation's own scale. dominant_term: which term governs an observation. held_fixed: the reference state or normalizer. misuse: a result the relation cannot support.", "enum": [ "direction", "limit", "scale", "dominant_term", "held_fixed", "misuse" ], "type": "string" }, "statement": { "description": "The implication as one student-facing sentence. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "minLength": 1, "type": "string" } }, "required": [ "form", "statement" ], "type": "object" }, "type": "array" }, "name": { "description": "The name students would use: the global alignment recurrence, the Henderson-Hasselbalch relation.", "minLength": 1, "type": "string" }, "notes_private": { "description": "Instructor-facing. Never rendered on a student page or exported where a student can see it.", "type": "string" }, "recall": { "description": "Students are expected to know this relation from memory. Whether an exam may print it is course policy (`policy.exam_conditions.equations`).", "type": "boolean" }, "says": { "description": "What the relation claims, in words, as a student should be able to state it with the symbols covered. Student-facing. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "minLength": 1, "type": "string" }, "source": { "additionalProperties": false, "description": "Where the course's own source states it.", "properties": { "locator": { "description": "Where inside the work: §6.1, pp. 4-9, eq. 3.12.", "type": "string" }, "ref": { "description": "Citation key into `references`.", "minLength": 1, "type": "string" } }, "required": [ "ref" ], "type": "object" }, "status": { "description": "proposed marks an entry a pipeline or a collaborator added for the instructor to approve; approve it by deleting the field or setting approved. Checks treat proposed entries like approved ones, so a new entry is checked from the day it is written. Absent means approved.", "enum": [ "proposed", "approved" ], "type": "string" }, "symbols": { "description": "Every symbol in `tex`, in order of first appearance. The validator requires `term` or `meaning` on each.", "items": { "additionalProperties": false, "properties": { "meaning": { "description": "What the symbol stands for, when it has no term.", "type": "string" }, "symbol": { "description": "The symbol as it appears in `tex`.", "minLength": 1, "type": "string" }, "term": { "description": "Term id, when the quantity has a glossary entry; its definition and units come from there.", "type": "string" }, "units": { "description": "Units, when the symbol has no term or the term gives none.", "type": "string" } }, "required": [ "symbol" ], "type": "object" }, "type": "array" }, "tags": { "description": "Free-form tags.", "items": { "type": "string" }, "type": "array" }, "tex": { "description": "The relation in LaTeX, without surrounding dollar signs. Rendered as display math.", "minLength": 1, "type": "string" } }, "required": [ "name", "tex", "says" ], "type": "object" }, "description": "Relations by id, `eq-...`. Defined once, conventionally in the objective file whose targets first need it.", "propertyNames": { "pattern": "^eq-[a-z0-9]+(-[a-z0-9]+)*$" }, "type": "object" }, "learning_objectives": { "additionalProperties": { "additionalProperties": false, "properties": { "assessed": { "description": "Set false for an objective you teach but do not test; coverage reporting will stop flagging it as a gap. This exempts its targets too.", "type": "boolean" }, "description": { "description": "Two to four sentences, student-facing: what this objective is about, why it matters, and what it builds on or leads to. Rendered under the objective on the lecture page. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "type": "string" }, "lectures": { "description": "Lecture ids that cover this.", "items": { "type": "string" }, "type": "array" }, "level_ceiling": { "description": "Cognitive level. 1 = Remember (recalling terms, facts, and definitions); 2 = Understand (explaining ideas in your own words); 3 = Apply (using a procedure in a new situation); 4 = Analyze (taking a situation apart and relating the pieces); 5 = Evaluate/Create (judging alternatives or building something new)", "maximum": 5, "minimum": 1, "type": "integer" }, "order": { "description": "Position in teaching order, low first. Derived since 2.0 from the position of this objective in a lecture's `teaches` list; an authored value still wins, and `coursebank migrate order` removes them.", "minimum": 1, "type": "integer" }, "prerequisites": { "description": "Objective ids that must come first. Cycles are rejected.", "items": { "type": "string" }, "type": "array" }, "tags": { "description": "Free-form tags.", "items": { "type": "string" }, "type": "array" }, "text": { "description": "The objective as a student would read it. Start with a verb.", "minLength": 1, "type": "string" }, "unit": { "type": "string" } }, "required": [ "text" ], "type": "object" }, "description": "Learning objectives by id, conventionally `lo-...`. The tier a syllabus lists and a report classifies as met. Objectives only: the performances they are met by go in `learning_targets`.", "type": "object" }, "learning_targets": { "additionalProperties": { "additionalProperties": false, "properties": { "assessed": { "description": "Set false for something you teach but do not test. An unassessed objective exempts its targets regardless.", "type": "boolean" }, "authoring": { "additionalProperties": false, "description": "Notes for whoever writes items, slides, or the brief from this target. Instructor-facing: never rendered on a student page or exported where a student can see it.", "properties": { "ceiling_item": { "description": "The most demanding fair item at the ceiling, in one sentence: the evidence for the ceiling.", "type": "string" }, "constraints": { "description": "Conditions an item's stem must meet to stay fair, which the validator cannot see: 'keep sequences to four bases, or supply a partly filled matrix'.", "items": { "type": "string" }, "type": "array" }, "examples": { "description": "Named cases that teach this target in the lecture or the readings, kept out of the target text so the target transfers to a case students have not seen.", "items": { "type": "string" }, "type": "array" }, "number_work": { "description": "The arithmetic an item needs, the operation and roughly how long it takes. Omit when there is none.", "type": "string" }, "relation_form": { "description": "When the target tests a relation without evaluating it, which form it uses.", "enum": [ "direction", "limit", "scale", "dominant_term", "held_fixed", "misuse" ], "type": "string" }, "supplied": { "description": "What an item on this target hands the student: the data, the scheme, a value.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "equations": { "description": "Equation ids this target turns on.", "items": { "type": "string" }, "type": "array" }, "explanation": { "description": "The canonical account a student who has met this target could give, in two to four sentences: the rule or mechanism, what changes the outcome, and when it holds. Student-facing. Not a worked example. The lecture brief expands it; slides and items are checked against it. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "type": "string" }, "lectures": { "description": "Lecture ids that cover this.", "items": { "type": "string" }, "type": "array" }, "level_ceiling": { "description": "Cognitive level. 1 = Remember (recalling terms, facts, and definitions); 2 = Understand (explaining ideas in your own words); 3 = Apply (using a procedure in a new situation); 4 = Analyze (taking a situation apart and relating the pieces); 5 = Evaluate/Create (judging alternatives or building something new)", "maximum": 5, "minimum": 1, "type": "integer" }, "misconceptions": { "description": "Misconception ids an item on this target is most likely to draw on. Distractors are built from them, and the lecture names them.", "items": { "type": "string" }, "type": "array" }, "objective": { "description": "The objective this target belongs to. Required: a target with no objective would be measured and never reported.", "type": "string" }, "order": { "description": "Ignored since 2.0. An objective's targets are a set of question templates, not steps in a sequence — they are not taught in order and an exam samples from them — so a position asserts an order that does not exist. Where one target depends on another, say so with `prerequisites`. `coursebank migrate order` removes this.", "minimum": 1, "type": "integer" }, "prerequisites": { "description": "Target or objective ids that must come first. Cycles are rejected.", "items": { "type": "string" }, "type": "array" }, "tags": { "description": "Free-form tags.", "items": { "type": "string" }, "type": "array" }, "terms": { "description": "Term ids a student needs to meet this target. A term is new on the first lecture (in teaching order) whose targets list it, and listed as earlier vocabulary on later ones.", "items": { "type": "string" }, "type": "array" }, "text": { "description": "The target as a student would read it. Start with a verb.", "minLength": 1, "type": "string" }, "values": { "description": "Value ids this target uses.", "items": { "type": "string" }, "type": "array" } }, "required": [ "text", "objective" ], "type": "object" }, "description": "Learning targets by id. Each names the objective it belongs to. This is the tier items are tagged to and readings are cited against; results roll up to the objective. Ids must not start with `lo`, so that an id in an item or a report says which tier it belongs to without a lookup — `t-...` is the convention.", "type": "object" }, "lectures": { "additionalProperties": { "additionalProperties": false, "properties": { "date": { "description": "Date delivered.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "description": { "description": "The lecture in two to four sentences, student-facing: what it covers and the arc its objectives follow. The lecture page opens with it. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "type": "string" }, "materials": { "description": "Links the lecture page lists beside the readings: slides, the brief, notebooks, the recording. `slides_url` is the older single-link form and still loads.", "items": { "additionalProperties": false, "properties": { "kind": { "enum": [ "slides", "brief", "notes", "notebook", "recording", "homework", "other" ], "type": "string" }, "title": { "description": "Link text. Defaults to the kind.", "type": "string" }, "url": { "description": "Where it lives.", "minLength": 1, "type": "string" } }, "required": [ "kind", "url" ], "type": "object" }, "type": "array" }, "readings": { "description": "Readings assigned with this lecture, in the order you assign them. A plain string is the pre-schema form and still loads.", "items": { "oneOf": [ { "description": "The pre-schema form: a citation, unparsed.", "type": "string" }, { "additionalProperties": false, "properties": { "focus": { "description": "What to take from it. This is the sentence a student report quotes. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "minLength": 1, "type": "string" }, "locator": { "description": "Where inside the work: §6.1, pp. 212-219, ch. 3.", "minLength": 1, "type": "string" }, "minutes": { "description": "Estimated reading time, for the lecture page's workload line.", "minimum": 1, "type": "integer" }, "path": { "description": "Joined to the reference's base_url to reach this location.", "type": "string" }, "ref": { "description": "Citation key into `references`.", "minLength": 1, "type": "string" }, "role": { "description": "supplemental means offered but not separately assessed.", "enum": [ "assigned", "supplemental" ], "type": "string" }, "skip": { "description": "What to gloss, and why it is out of scope. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "minLength": 1, "type": "string" }, "summary": { "description": "What the section contains. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "minLength": 1, "type": "string" }, "targets": { "description": "Target ids this reading serves. A student who misses one of these is pointed here, so the list is what makes study guidance specific. Cite targets rather than objectives: a section of a book backs a specific performance, and a reading list resolved from an objective would send a student the same six sections whichever part of it they missed.", "items": { "type": "string" }, "type": "array" }, "text": { "description": "A pre-schema citation string, held unparsed.", "minLength": 1, "type": "string" }, "url": { "description": "Full URL, when base_url does not cover the location.", "type": "string" } }, "required": [ "ref" ], "type": "object" } ] }, "type": "array" }, "slides_url": { "type": "string" }, "teaches": { "description": "The objectives this session develops. Each named objective gains this lecture in its `lectures` list when the course is loaded, so the pair is declared once, here, while planning the lecture.", "items": { "type": "string" }, "type": "array" }, "title": { "description": "Lecture title.", "minLength": 1, "type": "string" }, "unit": { "description": "Unit id.", "type": "string" } }, "required": [ "title" ], "type": "object" }, "description": "Lectures by id. Items cite these so reports can tell a student where to go back to.", "type": "object" }, "misconceptions": { "additionalProperties": { "additionalProperties": false, "description": "One named mistake. Slides name it, items build distractors from it, and reports group misses by it.", "properties": { "belief": { "description": "The wrong idea as a student holds it, in the student's words: 'a lower total energy always means a better structure.' Student-facing: the lecture page lists it under common mistakes. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "minLength": 1, "type": "string" }, "correction": { "description": "Why it fails and what is true instead, in one to three sentences. Student-facing. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "minLength": 1, "type": "string" }, "error_type": { "description": "What kind of mistake it is, in the bank's terms. recall_confusion — confused with a neighboring fact; terminology_swap — swapped similar terms; misconception — specific wrong model; incomplete_understanding — partial grasp of the idea; overgeneralization — applied a rule outside its scope; plausible_irrelevant — true but not what was asked; dropped_step — skipped a step; reversed_relationship — reversed the direction; wrong_procedure — used the wrong procedure; sign_or_magnitude_error — sign or magnitude slip; ignores_interacting_condition — ignored an interacting condition; correct_but_incomplete — correct but not best; common_shortcut — took a familiar shortcut", "enum": [ "recall_confusion", "terminology_swap", "misconception", "incomplete_understanding", "overgeneralization", "plausible_irrelevant", "dropped_step", "reversed_relationship", "wrong_procedure", "sign_or_magnitude_error", "ignores_interacting_condition", "correct_but_incomplete", "common_shortcut" ], "type": "string" }, "evidence": { "description": "Where the misconception has been seen, strongest first.", "items": { "additionalProperties": false, "properties": { "detail": { "description": "What was seen: 'Exam 2 Q23, 22% chose it.'", "type": "string" }, "kind": { "description": "Where it was seen. textbook: an assigned text states or implies it, so the correction must name the framing it replaces rather than contradict the text silently. persona: a simulated student, the weakest evidence.", "enum": [ "exam", "homework", "poll", "instructor", "literature", "textbook", "persona" ], "type": "string" }, "locator": { "description": "Where in that work.", "type": "string" }, "ref": { "description": "Citation key, for literature or textbook evidence.", "type": "string" } }, "required": [ "kind" ], "type": "object" }, "type": "array" }, "notes_private": { "description": "Instructor-facing. Never rendered on a student page or exported where a student can see it.", "type": "string" }, "status": { "description": "proposed marks an entry a pipeline or a collaborator added for the instructor to approve; approve it by deleting the field or setting approved. Checks treat proposed entries like approved ones, so a new entry is checked from the day it is written. Absent means approved.", "enum": [ "proposed", "approved" ], "type": "string" }, "tags": { "description": "Free-form tags.", "items": { "type": "string" }, "type": "array" } }, "required": [ "belief", "correction" ], "type": "object" }, "description": "Named mistakes by id, `mis-...`. Defined once; targets list the ones their items draw on, and bank options may name the one they encode.", "propertyNames": { "pattern": "^mis-[a-z0-9]+(-[a-z0-9]+)*$" }, "type": "object" }, "policy": { "additionalProperties": false, "description": "Course-wide defaults and rules that validation enforces.", "properties": { "allow_partial_credit": { "description": "Whether any option may carry partial credit. When false, validation rejects items that do.", "type": "boolean" }, "blueprints": { "additionalProperties": { "additionalProperties": false, "properties": { "bonus_counts": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "level_counts": { "additionalProperties": { "minimum": 0, "type": "integer" }, "description": "Scored items at each level, keyed by level number.", "type": "object" }, "minutes": { "exclusiveMinimum": 0.0, "type": "number" } }, "required": [ "level_counts" ], "type": "object" }, "description": "Named default blueprints (module, final), as published to students. An assessment's own `blueprint` wins.", "type": "object" }, "bonus_levels": { "description": "Levels a bonus item may be drawn from.", "items": { "description": "Cognitive level. 1 = Remember (recalling terms, facts, and definitions); 2 = Understand (explaining ideas in your own words); 3 = Apply (using a procedure in a new situation); 4 = Analyze (taking a situation apart and relating the pieces); 5 = Evaluate/Create (judging alternatives or building something new)", "maximum": 5, "minimum": 1, "type": "integer" }, "type": "array" }, "exam_conditions": { "additionalProperties": false, "description": "How exams are sat, as students were told. Pipelines and the linter read these instead of assuming one course's rules.", "properties": { "calculator": { "description": "false: no item may need arithmetic beyond a few seconds, and `target_text_forbid` usually bans words that promise a calculation.", "type": "boolean" }, "closed_book": { "type": "boolean" }, "equations": { "description": "Whether a relation an item turns on may appear: never (students bring the relation), on a supplied sheet, or in the stem.", "enum": [ "never_printed", "sheet", "in_stem" ], "type": "string" }, "formats": { "description": "Item formats exams use now. Ceilings are still set by the most demanding fair item in any format.", "items": { "enum": [ "single_best_answer", "multiple_response", "true_false", "open_response" ], "type": "string" }, "type": "array" }, "seconds_per_item": { "description": "The time budget an item is written to.", "exclusiveMinimum": 0.0, "type": "number" } }, "type": "object" }, "grade_scale": { "description": "Letter-grade bands. Only the lower bound of each is recorded; a band runs up to the next one. Set this and a class report bins scores by letter rather than by ten-point interval.", "items": { "additionalProperties": false, "properties": { "attainment": { "description": "The attainment word attached to the band.", "type": "string" }, "gpa": { "description": "Grade points the band carries.", "minimum": 0, "type": "number" }, "group": { "description": "Color group for reports; defaults to the letter's first character.", "type": "string" }, "letter": { "description": "The letter as it appears on a transcript.", "type": "string" }, "min": { "description": "Lowest percentage earning this letter, inclusive.", "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "letter", "min" ], "type": "object" }, "type": "array" }, "levels": { "additionalProperties": { "additionalProperties": false, "properties": { "description": { "description": "One line, as published.", "type": "string" }, "name": { "description": "Definitions, Concepts, Application ...", "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "description": "The course's own names and one-line descriptions for levels 1 to 5, as students were told them. Lecture pages label ceilings with these; absent, the generic Bloom names are used.", "propertyNames": { "pattern": "^[1-5]$" }, "type": "object" }, "mastery_threshold": { "description": "Rate at which an objective counts as met. 0.75 is a common choice.", "maximum": 1.0, "minimum": 0.0, "type": "number" }, "min_items_for_mastery": { "description": "Below this many items on an objective, reports say 'not enough evidence' rather than classifying.", "minimum": 1, "type": "integer" }, "options_per_item": { "description": "Expected option count; the linter flags items that differ.", "minimum": 2, "type": "integer" }, "partial_credit_floor_level": { "description": "Cognitive level. 1 = Remember (recalling terms, facts, and definitions); 2 = Understand (explaining ideas in your own words); 3 = Apply (using a procedure in a new situation); 4 = Analyze (taking a situation apart and relating the pieces); 5 = Evaluate/Create (judging alternatives or building something new)", "maximum": 5, "minimum": 1, "type": "integer" }, "points_per_item": { "description": "Default points for an item that does not set its own.", "exclusiveMinimum": 0.0, "type": "number" }, "target_text_forbid": { "description": "Regular expressions that must not match objective or target text, with the reason in a comment beside them (for example '\\\\bcalculat' when exams are calculator-free). The linter reports every match.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "references": { "additionalProperties": { "additionalProperties": false, "properties": { "arxiv": { "description": "Bare arXiv id: 2301.00001.", "type": "string" }, "authors": { "description": "Authors as `Family, Given`, in printed order.", "items": { "type": "string" }, "type": "array" }, "base_url": { "description": "Prefix a reading's `path` is joined to, so the citation key appears once instead of once per reading.", "type": "string" }, "container": { "description": "Journal, edited volume, or series.", "type": "string" }, "doi": { "description": "Bare DOI: 10.1038/nature12373. For a manuscript this is usually the only link worth storing, since a reading list resolves it to doi.org.", "pattern": "^(doi:|https?://(dx\\.)?doi\\.org/)?10\\.", "type": "string" }, "edition": { "description": "Edition as printed: 7th.", "type": "string" }, "isbn": { "type": "string" }, "issue": { "type": "string" }, "kind": { "description": "Kind of work, following BibTeX entry types.", "enum": [ "book", "chapter", "article", "preprint", "thesis", "website", "software", "dataset", "video", "other" ], "type": "string" }, "label": { "description": "Short form a reading list shows, such as KKW. One work per label.", "minLength": 1, "type": "string" }, "note": { "description": "Access notes: reserve shelf, license.", "type": "string" }, "pages": { "description": "Pages of the work, not of a reading.", "type": "string" }, "pmcid": { "description": "PubMed Central id, which hosts the full text: PMC3084216.", "type": "string" }, "pmid": { "description": "PubMed id, which hosts a record about the work: 21471563.", "pattern": "^[0-9]+$", "type": "string" }, "publisher": { "type": "string" }, "role": { "description": "required for a course text; supplemental for background.", "enum": [ "required", "supplemental" ], "type": "string" }, "title": { "description": "Full title.", "minLength": 1, "type": "string" }, "url": { "description": "Canonical URL for the whole work.", "type": "string" }, "volume": { "type": "string" }, "year": { "description": "Year of publication.", "type": "integer" } }, "required": [ "title" ], "type": "object" }, "description": "Works the course cites, by citation key. Readings point in here, so an edition change is one edit.", "type": "object" }, "schema_version": { "description": "Format version; currently 2.1.", "type": [ "string", "number" ] }, "stimuli": { "additionalProperties": { "additionalProperties": false, "properties": { "asset": { "description": "Path to an image.", "type": "string" }, "body": { "description": "The stimulus text, in coursebank markup.", "minLength": 1, "type": "string" }, "caption": { "type": "string" } }, "required": [ "body" ], "type": "object" }, "description": "Shared passages, figures, or data that several items refer to.", "type": "object" }, "terms": { "additionalProperties": { "additionalProperties": false, "description": "One term students meet in this course.", "properties": { "definition": { "description": "One plain sentence, student-facing, that defines the term without using it. Rendered in the lecture page's glossary and the course glossary. May reference other entries in braces, {term-...}, {eq-...}, {val-...}, {mis-...}, {t-...} or {lo-...}; the validator checks each resolves and the renderer replaces it (a term with its linked name, an equation inline, a value with its `say`, a target with its number).", "minLength": 1, "type": "string" }, "exam_wording": { "description": "Coined terms only: the plain wording items write instead of the label. A coined label is a teaching aid, not tested vocabulary, so the linter flags it in an item stem or option.", "type": "string" }, "kind": { "description": "standard: the textbooks use this name for this idea (the default). renamed: a standard idea under the course's own name or notation; students can look it up only if told the textbook name. coined: a label or metaphor the course invented; no textbook uses it.", "enum": [ "standard", "renamed", "coined" ], "type": "string" }, "notes_private": { "description": "Instructor-facing. Never rendered on a student page or exported where a student can see it.", "type": "string" }, "status": { "description": "proposed marks an entry a pipeline or a collaborator added for the instructor to approve; approve it by deleting the field or setting approved. Checks treat proposed entries like approved ones, so a new entry is checked from the day it is written. Absent means approved.", "enum": [ "proposed", "approved" ], "type": "string" }, "symbol": { "description": "The notation, when the term names a quantity, in coursebank markup: $K_M$. Equations refer to the quantity by term id, so the symbol is written once, here.", "type": "string" }, "tags": { "description": "Free-form tags.", "items": { "type": "string" }, "type": "array" }, "term": { "description": "The word or phrase as this course writes it, as a student reads it on the lecture page.", "minLength": 1, "type": "string" }, "textbook": { "description": "What the assigned texts call it, the first-listed text first. The linter flags a renamed or coined term without one, since a student needs a name a search will find.", "items": { "additionalProperties": false, "properties": { "locator": { "description": "Where that text uses it.", "type": "string" }, "ref": { "description": "Citation key into `references`; omit for a plain-English equivalent.", "type": "string" }, "term": { "description": "The name an assigned text uses.", "minLength": 1, "type": "string" } }, "required": [ "term" ], "type": "object" }, "type": "array" }, "units": { "description": "Units of the quantity the term names, if any.", "type": "string" }, "variants": { "description": "Other surface forms that count as a use of the term: plurals, abbreviations. Matching is case-insensitive and whole-word on `term` and every variant.", "items": { "type": "string" }, "type": "array" } }, "required": [ "term", "definition" ], "type": "object" }, "description": "Terms by id, `term-...`. Defined once anywhere in the course, conventionally in the objective file whose targets first need it. Targets list the terms they need; a lecture page derives its new and earlier terms from those lists.", "propertyNames": { "pattern": "^term-[a-z0-9]+(-[a-z0-9]+)*$" }, "type": "object" }, "units": { "description": "Course units, in teaching order. That order drives report layout.", "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "id": { "description": "Unit id.", "minLength": 1, "type": "string" }, "title": { "description": "Unit title.", "minLength": 1, "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "type": "array" }, "values": { "additionalProperties": { "additionalProperties": false, "description": "One number students are taught. The validator requires `value` or `range`.", "properties": { "conflicts": { "description": "Regular expressions for variants that must not appear in any student-facing text or item, such as '5\\\\.7\\\\s*kJ'. Write one for every variant that has actually turned up.", "items": { "type": "string" }, "type": "array" }, "exact": { "description": "The unrounded value, for explanations and solutions.", "type": "number" }, "name": { "description": "The quantity, specifically: free energy per ten-fold concentration ratio at 37 °C.", "minLength": 1, "type": "string" }, "notes_private": { "description": "Instructor-facing. Never rendered on a student page or exported where a student can see it.", "type": "string" }, "range": { "description": "Low and high, when the course teaches a range rather than one value.", "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "recall": { "description": "Students are expected to know it. An exam never prints it, and no option or neighbouring item may give it away.", "type": "boolean" }, "say": { "description": "The wording every material uses for it: 'about 6 kJ/mol'. Prose that writes {val-...} renders this.", "minLength": 1, "type": "string" }, "source": { "additionalProperties": false, "description": "Where the course's own source states it.", "properties": { "locator": { "description": "Where inside the work: §6.1, pp. 4-9, eq. 3.12.", "type": "string" }, "ref": { "description": "Citation key into `references`.", "minLength": 1, "type": "string" } }, "required": [ "ref" ], "type": "object" }, "status": { "description": "proposed marks an entry a pipeline or a collaborator added for the instructor to approve; approve it by deleting the field or setting approved. Checks treat proposed entries like approved ones, so a new entry is checked from the day it is written. Absent means approved.", "enum": [ "proposed", "approved" ], "type": "string" }, "tags": { "description": "Free-form tags.", "items": { "type": "string" }, "type": "array" }, "term": { "description": "Term id of the quantity, when it has a glossary entry.", "type": "string" }, "units": { "description": "Units, as printed.", "type": "string" }, "value": { "description": "The value as taught (rounded as students learn it).", "type": "number" } }, "required": [ "name", "say" ], "type": "object" }, "description": "Taught numbers by id, `val-...`. Defined once; every material states a value in its `say` wording.", "propertyNames": { "pattern": "^val-[a-z0-9]+(-[a-z0-9]+)*$" }, "type": "object" } }, "required": [ "course" ], "title": "coursebank course file", "type": "object" }