Glossary¶
One term per concept, one concept per term. These are the project's canonical nouns. Docs, code identifiers, commit messages, and conversation use these words and no synonyms for them. Coin a new term only with a new glossary entry in the same change.
What a source yields¶
- Work
- The book itself, across every edition of it. Named by the first half of a
source_id, such asescoffier. Not "title" or "book". - Edition
- A named revision of a work, as the work's own printing history states it.
New and Revised Edition, January 1909. Not "version" or "release". - Impression
- One printing of an edition, from the same setting and with no revision.
January 1920. Not "edition" and not "reprint". - Witness
- One text of one edition that this project can read: a transcription or a scan. Each source is a witness. A witness is evidence of the work rather than the work. Not "copy" or "version".
- Fidelity
- How a witness was obtained, and therefore how far its surface forms may
be trusted. Two values:
transcription, proofread by hand, andocr, machine-read from a scan. Stated, never inferred. Not "quality" or "confidence". - Source
- One document the extractor reads, identified by a
source_idsuch asescoffier-1909. One source is one witness. Not "book", "text", or "file". - Corpus
- The tracked collection of source material under
corpus/. One corpus holds many sources. Not "dataset" or "data". - Entry
- A numbered division of a source, in the source's own numbering. Escoffier numbers 3,094 of them. Not "section" or "record".
- Preparation
- One entry that describes something to make. The unit this project extracts. Not "recipe", which is a consumer-facing document Escoffier does not write. Not "dish", which is what a preparation is served on.
- Catalogue
- Every preparation read from one source, plus the mothers that source names. Not "database", "index", or "collection".
Terms and concepts¶
- Term
- One surface form in one language, with the language tagged. Not "name", "label", or "string".
- Surface form
- A term exactly as the source writes it. Never translated, never normalised beyond folding for identity. Not "spelling" or "variant".
- Concept
- The language-independent identity a term denotes, carried as a
ConceptId.espagnoleandsalsa españolaare two terms and one concept. Not "entity", "node", or "key". - Folding
- Reducing a surface form to a concept id by stripping diacritics, case, and punctuation. Resolves orthographic variation only. Not "normalising" (too broad) and not "matching" (folding decides nothing about meaning).
- Gloss
- An English rendering of a term, recorded beside it and never in place of it. A gloss is not a term and never substitutes for one.
Derivation¶
- Mother
- A preparation the source itself names as foundational. Escoffier names five. A mother may state a parent of its own. Not "base sauce" in prose (use "mother"), not "root" or "parent sauce".
- Derivation
- The relation from a preparation to the candidate its opening paragraph states. Not "relationship", "edge", or "link".
- Candidate
- One name a stated parent may use: any name of a catalogued preparation, or a mother. Not "option" or "match".
- Statement
- A candidate's name written as a whole run of words inside one sentence of the opening paragraph. Only a statement records a derivation. Not "mention" or "reference".
- Subject
- What an entry's own name denotes. A run of words inside the entry's own name states the subject, never a parent. A mother is never a subject. Not "topic".
- Shadow
- A statement lying entirely inside a longer statement that reaches a different preparation. A shadowed name is part of the longer statement and is not read on its own. Not "overlap".
- Chain
- The derivations walked from a preparation through its parents. A chain terminates, because no preparation is its own ancestor. Not "lineage" or "path".
- Resolved
- A preparation whose derivation the parser found. Its
parentis set. - Unresolved
- A preparation whose opening paragraph states no candidate, or states more
than one. Its
parentisNone. This states an absence of evidence and never evidence of absence. Not "missing", "unknown", or "no parent" — each of those reads as a fact about the preparation rather than about what the source said. - Ambiguous
- An opening paragraph that states two or more candidates. The source stated both and chose neither, so the preparation is unresolved. Not "conflicting" or "uncertain", which describe the parser rather than the text.
Procedure¶
- Procedure
- The operations one entry states, in the order it states them, each in the witness's own words. Recorded beside a preparation and never in place of its parent. Not "recipe", "method", or "steps".
- Operation
- One action a procedure states, named by its verb as a term, with the inputs, instrument, criterion, duration, and constraints the same clause states. Not "step", "action", or "instruction".
- Wording
- The words of the witness an element of a procedure was read from, exactly as written, with whitespace collapsed. An element's wording lies inside its operation's wording, and the entity refuses one that does not. Not "statement", which is a candidate's name inside one sentence, and not "quote" or "text".
- Input
- One thing an operation takes, as a term, with its quantity where the words give one. The preparation in progress is not an input. Not "component" or "material".
- Parameter
- Words that state a quantity, a duration, or a degree, with the number
they give and the unit they name. The number is
Nonewhen the words give none. That is unresolved in the sense of ADR-0002, and no code fills it. Not "amount", "value", or "measure". - Criterion
- A parameter that states what an operation is carried to:
by a good quarter,the melting of the cheese. Not "target", "goal", or "endpoint". - Constraint
- A condition the source sets on an operation, in its words:
away from the fire. Not "condition" or "rule". - Instrument
- The tool an operation names, as a term:
small whisk. Not "tool", "equipment", or "utensil". - Recorder
- Who recorded a procedure.
handin this release. A rule reader or a model names itself here, so no procedure is shown without saying who read it. Not "author", "source", or "reader". - Unrecorded
- A preparation for which no procedure has been recorded. States that no recorder has read one, never that the source states no procedure. Not "unresolved", which says what the source declined to state, and not "missing".
Extraction¶
- Extraction
- Reading structure out of a source. Not "parsing" (parsing is the mechanism), not "ingestion" (nothing is being consumed).
- Provenance
- The
SourceRefevery preparation carries: source, entry number, and line. Not "citation" or "reference". - Sauce chapter
- A chapter the source itself titles as sauces. Escoffier has three. An entry inside one qualifies on the chapter. An entry outside one qualifies only when its own heading says "sauce". Not "section" or "sauce section".
Comparison¶
- Difference
- One row of a comparison between two witnesses: a concept, what each witness holds, and the cause. Not "delta", "change", or "diff row".
- Cause
- Why two witnesses differ on one concept. Six values, and a row may carry
more than one.
unmatchedmeans one witness holds the concept and the diff found no counterpart in the other.addedandremovedmean the concept is in one book and not in the other. That is a stronger claim, available only between two witnesses of equal fidelity.retitledmeans one heading is the other plus whole words.parent-changedmeans a preparation records a different derivation in each witness.ocr-suspectedmeans a scanned witness explains the row as well as a revision does. Not "reason", "kind", or "type". - Blind spot
- Entries one witness yielded and the other did not. It measures what a
reader could not see, so it is what an
unmatchedrow cannot look past. Not "coverage" or "recall", which name a score rather than a gap.
Interchange¶
- Interchange
- The representation that carries catalogues between this project and any
program that does not share its object model. JSON Lines, one record per
line, written by
saucier exportand read bysaucier import. It is a serialization and never a store. Not "export format", "dump", or "database". - Record
- One line of the interchange: a JSON object carrying an envelope and one catalogue or one preparation. A record is a unit of the interchange, and an entry is a division of a source. Not "row" or "line".
- Envelope
- The three fields every record carries.
schemanames the version of the interchange that shaped it.typesays which kind of record it is.idis its source-local address. Not "header" or "metadata".
Names this project does not use¶
shortorder- The rejected project name. It promised speed where this project promises composition. It appears in no file.
- "config"
- Use the specific noun:
Paths, a rule set, a gate. "Config" names nothing.