Skip to content
Format reference1.1.0 · Archived

Translation contract 1.1.0

Translation contract 1.1.0 for CMMF 1.1.0. Authoritative specification text.

This document defines the minimum contract for translating CMMF models into a target CMS schema.

It does not define translator implementation details. It defines what a translator must accept, produce, and explain.

The translator must accept:

  • one CMMF manifest
  • one or more CMMF model files
  • an explicit target platform identifier
  • an optional translation mode
  • optional translator configuration

The translator must produce:

  • target platform schema artefacts
  • a decisions log
  • validation errors and warnings, if any

The decisions log should record non-trivial translation choices, including:

  • how contained ownership was represented
  • how object structures were mapped
  • how unsupported validations were handled
  • how unsupported richTextConfig capabilities were handled
  • any inferred defaults or fallbacks
  • any platform limitations or lossy mappings

Suggested modes for future translators:

  • strict: preserve intent as literally as possible
  • optimised: adapt output for target-platform best fit

The following may vary by translator and target platform:

  • whether contained relationships become embedded objects or separate types
  • how editorial metadata is represented
  • how richTextConfig capabilities map onto target editor features
  • how governance metadata is preserved or omitted
  • how non-authoritative translation hints influence output

A translator must not:

  • mutate the meaning of the source model silently
  • ignore required constraints without reporting them
  • silently widen richTextConfig allowlists when the target editor cannot enforce them
  • drop relationship semantics without a logged decision