TypedMark Typed Markdown note systems
Essentials

Quick Reference

Audience: collection authors and tool authors looking up an existing rule.

See also:

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
Core Profile The minimal authoring profile for a conforming typed collection Foundations
Governed artifact typedmark.md, a note-type schema, a property set, an automation rule, a saved view, a template, or history.md — Markdown files with governed frontmatter or body surfaces 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; outside managed-note schema validation, though any expansion markers still use the content-expansion contract 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
Field conversion A directional, typed conversion from one field definition to another Field compatibility and conversion
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
Automation rule A declarative event or schedule trigger with an ordered, atomic action list Collection Model
Propagation Deterministic multi-wave automation execution that commits only at a valid fixed point Managed Notes and Properties
Portable query A plain-JSON, read-only descriptor for filtering managed notes and projecting deterministic result rows Portable Queries
Dataset A governed reusable query with stable row identity and a common projected column contract across note types Datasets
Saved view A governed presentation over an embedded portable query or referenced dataset, using a table, list, cards, or board layout Saved Views
Template region Marker-delimited static Markdown with a per-note baseline receipt for portable three-way drift detection Template Drift Tracking
Content expansion Marker-delimited plain Markdown derived from a declared source, with automatic, manual, once, and ejectable modes Content Expansion

How do I…#

I want to… Use Defined in
start with the smallest conforming setup Core Profile defaults in typedmark.md and note-type schemas Conformance
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
require tags collection-wide, by folder, or by note type mandatory_tags in typedmark.md, folder_scopes, or a note-type schema Mandatory tags
react to note changes or a schedule an automation artifact under <metadata_directory>/automations/ Automation rules
let automation changes trigger further rules safely propagation mode with automation_defaults.max_propagation_waves Dependency propagation
select, filter, sort, group, or limit managed notes portably a portable query descriptor with where, select, order_by, group_by, and limit Portable Queries
reuse one multi-type result in several presentations a dataset artifact under <metadata_directory>/datasets/ and saved views that reference it Datasets
save and share a table, list, cards, or board view a saved-view artifact under <metadata_directory>/views/ Saved Views
build a readable Markdown dashboard from datasets or saved views one or more dataset- or view-backed content expansions in an ordinary note Content Expansion
detect and reconcile static template changes without overwriting note edits typedmark:template-region markers plus template_regions baseline receipts Template Drift Tracking
keep a Markdown region synchronized with a field, relationship, or query result a typedmark:expansion marker with mode: auto or manual Content Expansion
share fields across many note types property sets and default_property_sets Collection Model
combine differently typed fields safely field compatibility and conversion rules Field compatibility and conversion
apply shared structure by note path folder_scopes 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/