Quick Reference
This page is non-normative. It maps terms and tasks to the sections that govern them.
Glossary#
| Term | Meaning | Defined in |
|---|---|---|
| Collection | A rooted set of Markdown notes plus the TypedMark artifacts that structure them | Foundations |
| Governed artifact | typedmark.md, a note-type schema, a property set, or history.md — Markdown files whose frontmatter is the contract |
Foundations |
| Note type | A named structural class notes are associated with; abstract or concrete | Foundations |
| Managed note | A note associated with exactly one concrete note type and governed by its schema | Managed Notes and Properties |
| Untyped note | A collection note with no known note type; allowed, but unvalidated | Foundations |
| Asset | A non-Markdown collection file referenced by notes | Foundations |
| Property set | A named reusable bundle of frontmatter, relationships, and headings |
Collection Model |
| Effective note-type schema | The result of composing a concrete schema, its abstract ancestors, and property sets | Note Type Schemas |
| Field definition | The typed contract for one frontmatter property | Field Definition Reference |
| Canonical materialization | Every declared field physically present in stored frontmatter, null when empty |
Managed Notes and Properties |
| Relationship instance | A resolved note-to-note link counted against declared targets | Relationships, Headings, and Templates |
| System | A collection that declares version and scaffold, making it publishable and composable |
Systems, Composition, and Evolution |
| Composition | Building one self-contained collection from ordered source systems | Systems, Composition, and Evolution |
| Marketplace catalog | The marketplace.json index of known systems |
Systems, Composition, and Evolution |
| Vocabulary | A named, reusable value set referenced by allowed_values_from |
Collection Model |
How do I…#
| I want to… | Use | Defined in |
|---|---|---|
| require a field to always hold a value | optional: false with nullable: false |
Field optionality |
| require a field only in some states | conditions with require / require_null |
Conditional constraints |
| restrict a field to fixed values | allowed_values, or allowed_values_from with a vocabulary |
Field Definition Reference |
| make link fields point at real notes | validate_exists: true |
Field Definition Reference |
| restrict which note types a link targets | targets on the link field |
Field Definition Reference |
| auto-fill creation dates or ids | generated: now, uuid, ulid, {sequence: …} |
Field Definition Reference |
| stop a value from changing | immutable: true |
Field Definition Reference |
| keep a value unique | unique: true (per type) or unique: collection |
Field Definition Reference |
| say "every meeting belongs to a project" | relationship_kind: belongs_to field + relationship cardinality |
Relationships |
| file notes by date, quarter, or week | storage patterns with {field:format} or {now:format} |
Storage rules |
| add an optional name suffix like " (Meeting)" | note_name_suffix with required: false |
Storage rules |
| map notes to types by tag or folder | note_type_mappings with kind: tag or kind: folder |
Note-type mappings |
| share fields across many note types | property sets and default_property_sets |
Collection Model |
| tolerate unknown fields on one type only | per-type unknown_field severity |
Note Type Schemas |
| require exactly one Home note | kind: singleton with count: {min: 1} |
Schema kinds |
| enforce the H1 matches the title | headings.require_h1_title: true |
Heading rules |
| soft-delete or archive a note | core fields deleted / archived |
Core-defined fields |
| give a note alternative link names | core field aliases |
Core-defined fields |
| publish my setup for others | declare version and scaffold; list it in a marketplace |
Systems |
| validate artifacts in my editor or CI | the published JSON Schemas | schema/ |