Concepts

Each core framework term has a one-line definition, an analogy where one helps, and a link to the page that covers it in full. The concept pages link here when they first use a term.

The content model

These are the types that flow through the pipeline and make up the content model.

Term	Definition	Analogy	Covered in
Part	The streaming unit. Every document is read as a stream of Parts: layers starting and ending, blocks, data, media.	An event in an event stream	Content Model
Layer	A structural grouping: a document, a section, or embedded content. Layers nest: HTML inside a JSON string becomes a child Layer with its own format.	A node in the document tree	Content Model
Block	A unit of content: its Editions, each a flat sequence of Runs, and any stand-off Overlays. Segments are an Overlay on the Block's Runs, and the Block stays whole.	A paragraph or a message	Content Model
Run	The inline unit inside a Block: a discriminated union of Text and inline codes (placeholders, paired open/close codes, sub-flows, plural and select structures). Inline markup lives in Runs, never in the text itself.	A text node or a tag in an HTML fragment	Inline Formatting
Edition	One rendition of a Block's content, keyed by an EditionKey: the edition the document is written in, and one per translation, tone or channel. Editions are peers. The others derive from the Edition in the project's source language, or in the document's own language outside a project.	One language version of a page	Content Model
EditionKey	The key that identifies an Edition: a locale plus optional tone or channel, such as fr, fr;tone=formal or en;channel=short.	The address of one rendition	Content Model
Overlay	Stand-off annotation anchored to a range of Run indices: segmentation, terms, entities, check findings, alignment. The source stays as it is.	A margin note pinned to a span of text	Content Model
Anchor	Where an Overlay or a Finding attaches: a path into the Block's Runs with a start and end offset, or a key. The annotation survives edits to the text around it and can be re-resolved after the Runs change.		Content Model
Resource	The payload a Part carries: a Block, Data, or Media.	The Part is the envelope; the Resource is the letter	Content Model
Data	Structure that is never translated but must survive the round trip, such as keys, attributes and layout.		Content Model
Media	Binary content, such as an image or an audio or video clip, carried through the pipeline.		Content Model

Vocabularies and inline codes

Term	Definition	Covered in
Vocabulary	The typed catalogue of inline-code meanings (formatting, links, code spans, placeholders) that a Run's type draws from, with rules for what may be deleted, cloned or reordered.	Vocabularies
Semantic type	The meaning attached to an inline code, for example "bold", "hyperlink" or "variable", the same in every format.	Vocabularies

Processing

Term	Definition	Analogy	Covered in
Format (reader / writer)	The paired components that parse a byte stream into Parts and write Parts back out byte-for-byte.	A codec	Formats
Tool	A single processing step that reads Parts and writes Parts. Tools compose.	A stage in a shell pipeline	Tools
Flow	A named composition of tools.	A saved pipeline definition	Flows
Pipeline / Executor	The concurrent engine that runs a flow's tools as goroutines connected by channels.		Pipeline
Round trip	Reading a document into the content model and writing it back out so that untouched content is byte-for-byte identical. Format tests check this property for every format.		Formats

Stores and context

Term	Definition	Covered in
Content memory	A store of already settled content: source segments paired with the targets produced for them, matched exactly or fuzzily to reuse past work.	Content memory
Terms store	A store of approved terminology that keeps term renderings consistent.	Terminology
Voice profile	The tone, style measures and pattern rules content is checked and produced against (core/profile). Word rules are terms.	Voice
Point (coordinates)	Where a piece of content sits in a project's context space, on axes such as brand and product. A voice profile, a terms store and gates are bound at a point, and all content at that point follows them.	Projects

Checks

Term	Definition	Covered in
Check	A test that runs over content and emits findings, the content analogue of a unit test.	Checks
Finding	A single issue a check reports, anchored to where it occurs and marked as failing the check or as report-only. Findings travel with the content as overlays.	Checks

Project vocabulary

The recipe (kapi.yaml) and its model are framework code (core/project), as are the context, gate and unit-state packages beside it; the verbs that drive a project (up, status, apply) are kapi commands. Ad-hoc and project modes, bindings, and the .kpz/.kbf.json formats are defined under Projects.

Related

• Architecture: how these pieces fit together.
• Content Model: the types above in full.
• Go quickstart: the concepts in a few lines of Go.