Appendices
Appendix A: YAML Frontmatter Quick Reference
Section titled “Appendix A: YAML Frontmatter Quick Reference”---# Requiredid: uuid-v4type: semantic|episodic|proceduralcreated: ISO-8601-datetime
# Recommendedmodified: ISO-8601-datetimeontology: id: ontology-identifier # Matches ontology.id in definition version: "1.0.0" # Semantic version (optional) uri: https://example.com/ont # Ontology URL (optional)namespace: hierarchical/pathtitle: "Human Title"tags: [tag1, tag2]
# Optionalaliases: ["Alt Name 1", "Alt Name 2"]
entities: - "@type": EntityReference entity: { "@id": urn:mif:entity:<type>:<slug> } entityType: Person|Organization|Technology|Concept|File # optional name: string # optional role: string # optionalrelationships: - type: kebab-case-token # optional ns: prefix (§8.5) target: bundle-relative-path | urn:mif:<uuid> strength: 0.0-1.0 # optional metadata: {} # optionalproperties: key: string|number|boolean|null # scalar literals onlydocuments: - "@type": DocumentReference # required url: uri # url or id: at least one is required id: string # stable identifier when no resolvable url documentType: string # optional hash: { algorithm: sha256, value: hex-digest } # optional # also optional: contentType, byteLength, version, retrievedAt, title
temporal: validFrom: ISO-8601-datetime validUntil: ISO-8601-datetime | null recordedAt: ISO-8601-datetime ttl: ISO-8601-duration decay: model: none|linear|exponential|step halfLife: ISO-8601-duration strength: 0.0-1.0 accessCount: integer lastAccessed: ISO-8601-datetime
provenance: sourceType: user_explicit|user_implicit|agent_inferred|external_import|system_generated sourceRef: uri agent: string confidence: 0.0-1.0 trustLevel: verified|user_stated|high_confidence|moderate_confidence|low_confidence|uncertain # Optional W3C-PROV-aligned layer (see §12.3): wasGeneratedBy, wasAttributedTo, wasDerivedFrom
embedding: model: string modelVersion: string dimensions: integer sourceText: string
extensions: provider_name: custom_field: value
# Optional (Level 3)citations: - "@type": Citation citationType: string citationRole: string title: string url: uri # optional: author, date, accessed, relevance, note (Appendix D)summary: string # max 500 characterscompressedAt: ISO-8601-datetime---Appendix B: Relationship Types Quick Reference
Section titled “Appendix B: Relationship Types Quick Reference”Relationships appear in a ## Relationships body section as
- <type> [Text](<target>), mirroring the authoritative frontmatter
relationships[], where <target> is a bundle-relative path or a urn:mif:
identifier (Relationship Syntax).
| Body Markdown Syntax | JSON-LD type |
Description |
|---|---|---|
- relates-to [X](<target>) |
relates-to |
General relationship |
- derived-from [X](<target>) |
derived-from |
Created from source |
- supersedes [X](<target>) |
supersedes |
Replaces older |
- conflicts-with [X](<target>) |
conflicts-with |
Contradicts |
- part-of [X](<target>) |
part-of |
Component of |
- implements [X](<target>) |
implements |
Realizes |
- uses [X](<target>) |
uses |
Utilizes |
- created [X](<target>) |
created |
Authored by |
- mentioned-in [X](<target>) |
mentioned-in |
Referenced in |
Appendix C: Entity Reference Syntax
Section titled “Appendix C: Entity Reference Syntax”Entity references are declared in the frontmatter entities[] array as EntityReference objects:
| Field | Required | Meaning |
|---|---|---|
@type |
REQUIRED | Always EntityReference |
entity.@id |
REQUIRED | Entity URN (urn:mif:entity:<type>:<slug>) |
entityType |
OPTIONAL | Person, Organization, Technology, Concept, File, or a custom ontology type |
name |
OPTIONAL | Display name |
role |
OPTIONAL | Role in the concept (e.g. author, mentions, uses) |
entities: - "@type": EntityReference entity: { "@id": urn:mif:entity:person:jane-doe } entityType: Person name: Jane Doe role: mentionsAppendix D: Citations Quick Reference
Section titled “Appendix D: Citations Quick Reference”Citation Types
Section titled “Citation Types”| Type | Description |
|---|---|
article |
Journal article, blog post |
book |
Published book |
paper |
Conference/research paper |
website |
General website |
documentation |
Technical documentation |
repository |
Code repository |
video |
Video content |
podcast |
Podcast episode |
specification |
Technical specification |
dataset |
Data source |
tool |
Software tool or service |
other |
Miscellaneous source |
Citation Roles
Section titled “Citation Roles”| Role | Description |
|---|---|
supports |
Provides supporting evidence |
refutes |
Contradicts or disputes |
background |
General context/reference |
methodology |
Method or approach source |
contradicts |
Conflicts with claims |
extends |
Builds upon cited work |
derived |
Direct derivation source |
source |
Primary source material |
example |
Illustrative example |
review |
Critical review/analysis |
Frontmatter Syntax
Section titled “Frontmatter Syntax”citations: - "@type": Citation # REQUIRED citationType: article # REQUIRED title: "Citation Title" # REQUIRED url: https://example.com # REQUIRED citationRole: supports # REQUIRED author: "Author Name" # OPTIONAL (string, EntityReference, or array of EntityReference) date: 2024-06-15 # OPTIONAL accessed: 2026-01-20 # OPTIONAL relevance: 0.95 # OPTIONAL (0-1) note: "Annotation" # OPTIONALBody Section Syntax
Section titled “Body Section Syntax”## Citations
- [Title](url) by Author Name (date) - **Type**: article - **Role**: supports - **Relevance**: 0.95 - Long-form annotation here.