Μετάβαση στο κύριο περιεχόμενο

OMI-SPEC-120 — Scholarly Object Model

Document metadata​

FieldValue
IdentifierOMI-SPEC-120
TitleScholarly Object Model
Version0.3.0
StatusDraft
Document typeNormative Draft with informative examples
Normative languageEnglish
EditorsOMI maintainers
Last updated2026-10-31
ReplacesEarlier pre-stable text in the same specification lineage
Replaced byNone
Depends onOMI-SPEC-000@0.2.0
Used bySee the Specification Registry; exact released dependency versions govern
SchemasCore snapshot review projection, not a complete manuscript schema
Profilesurn:omi:profile:core-snapshot-review:0.1.0 (unapproved Draft review profile)
Implementation statusFresh core evidence review
Issue trackerSpecification issues

1. Abstract​

This specification defines identifiable content, structural, relationship, agent, asset, workflow and external-resource objects. A manuscript is an ordered containment structure plus an explicit relationship graph. Atomicity is declared per layer; a renderer or editor implementation does not define normative meaning.

2. Status of this document​

This remains Draft 0.3.0. This rewrite introduces stable requirement IDs and an explicitly bounded executable review profile. It is not a promotion to Review Candidate, Implementation Candidate or Stable. Existing producers declaring an older revision do not automatically implement this revision. Earlier text remains available in version control; no prior release is relabelled.

3. Conformance​

Implementations identify their exact version, role and profile. Producer, consumer, editor, transformer and validator behavior are separate roles. A passing core snapshot test is partial evidence for the inspected invariants, not a suite-wide conformance claim. BCP 14 capitalized requirement terms apply; REQ-OBJ-NNN IDs are permanent references for this lineage.

4. Scope​

This specification defines identifiable content, structural, relationship, agent, asset, workflow and external-resource objects. A manuscript is an ordered containment structure plus an explicit relationship graph. Atomicity is declared per layer; a renderer or editor implementation does not define normative meaning. Cross-specification authorization, full file-format processing, rendering equivalence and scholarly correctness are not established by this document's local schema or fixtures.

5. Terminology​

A subject/object is an addressable semantic entity. Containment is structural membership, relationship is a declared semantic connection, projection is an audience/format-specific derived representation, and profile is a versioned scope with explicit preconditions and exclusions. An assertion is not independent verification. Canonical identifies the controlling representation or publication; it does not mean approved or Stable.

6. Design principles​

Portability, non-destructive authoring, precise identity, explicit meaning, accessibility, privacy and conservative evidence govern all roles. Implementations may preserve incomplete authoring state; publication policies impose their own declared gates.

7. Model overview​

Content includes paragraphs, quotations, lists, equations and transcriptions; structural objects include sections, appendices and bibliography containers. Relationship objects cover citations, annotations, derivations and translations. Agents include people, organizations and software; assets include media, datasets and supplementary files. Workflow objects carry review/decision semantics with their own visibility rules; external resources retain persistent identifiers. Composite objects may contain embedded atomic values without inventing an identifier for each character.

8. Data model​

REQ-OBJ-001: Each addressable scholarly object MUST have a nonblank identifier and an unambiguous semantic type. A serialization MAY derive the type from a declared typed collection instead of repeating a type property.

REQ-OBJ-002: Identifiers MUST be unique among live addressable objects in the declared manuscript/package scope.

REQ-OBJ-003: An identifier MUST be treated as an opaque, case-sensitive Unicode string unless its explicitly declared identifier scheme specifies otherwise.

REQ-OBJ-004: Ordinary edits, moves and rendering changes MUST preserve identity where semantic continuity remains.

REQ-OBJ-005: Historical revision snapshots MUST have explicit scopes; reuse of the same identity in successive snapshots MUST NOT be mistaken for a duplicate live object.

REQ-OBJ-006: Containment MUST be explicit, ordered where meaningful and acyclic. A contained object MUST NOT have contradictory structural parents.

REQ-OBJ-007: A relationship MUST distinguish its semantic predicate and source/target roles under a declared model. It MAY be serialized as a relationship object or explicitly mapped reference property.

REQ-OBJ-008: An unresolved reference MUST be reported; processors MUST NOT silently redirect it to an unrelated existing object.

REQ-OBJ-009: Deletion MUST remove, resolve or explicitly invalidate dependent relationships atomically according to the declared profile.

REQ-OBJ-010: Split, merge or replacement operations that change semantic identity MUST disclose their identity mapping and provenance where retained history requires it.

REQ-OBJ-011: The model layer MUST declare which entities are independently addressable and which are embedded values; individual text characters need not each acquire an object identifier.

REQ-OBJ-012: Unknown object types MUST be retained opaquely or reported as unsupported; consumers MUST NOT invent an equivalent known meaning.

REQ-OBJ-013: Extensions MUST use an identified namespace and MUST NOT redefine the meaning of a core property silently.

REQ-OBJ-014: Provenance assertions MUST distinguish asserted attribution from independently verified identity or authenticity.

REQ-OBJ-015: An asset reference MUST distinguish resource identity/location from executable processing; validation MUST NOT fetch or execute an asset merely because it is referenced.

REQ-OBJ-016: Active objects, deletion evidence and historical objects MUST remain distinguishable; a tombstone MUST NOT silently resurrect an unrelated live object.

REQ-OBJ-017: Validators MUST declare inspected scope and report incomplete evidence or exhausted resource limits without claiming complete validity.

REQ-OBJ-018: A validation failure MUST NOT silently modify the object graph or impose an unexplained editor lock.

9. Processing model​

Identify the input/version/profile; preserve source; inspect structure under bounded policy; report diagnostics and coverage; allow explicit author correction; produce a separately identified output if requested. Validation is observational and never implicit repair. The published review projection checks one current snapshot; revision ledgers and historical identities are outside its live-object uniqueness scope.

10. Validation and error handling​

The core review profile pins the structural schema, pure semantic validator, resource limits, fixtures and requirement coverage. Results distinguish valid-within-scope, invalid and indeterminate. Invalid evidence takes precedence over incomplete inspection; truncation and resource limits cannot imply zero errors. Schema success is not equivalent to semantic success or full conformance. Codes are language-neutral; JSON-pointer locations avoid embedding manuscript excerpts in diagnostics.

11. Extensibility​

Declared extension namespaces and type vocabularies may add semantics. Unknown data is not silently reinterpreted. The projection permits opaque additional properties; this is retention policy, not proof that extensions are understood or safe to execute. The serialization owning a property defines its compatibility behavior.

12. Versioning and compatibility​

Specification, serialization, schema, profile, validator and implementation versions are distinct. This pre-stable rewrite may change requirements incompatibly; old declared versions remain historical contracts. No producer envelope is silently rewritten. New profile adoption needs explicit version negotiation, migration tests and recorded loss/identity effects. Normative dependencies are pinned above; a later release must re-evaluate them.

13. Interoperability​

Shared examples cover valid and invalid structure, Unicode, language, identity and timestamp behavior. A Studio-vendored copy of the same validator is shared code, not an independent implementation. Additional implementers must demonstrate equivalent declared behavior before stronger interoperability evidence is recorded. Cross-model dependency contradictions remain review blockers.

14. Security, privacy and integrity considerations​

Treat inputs, metadata, extensions and assets as untrusted. Bound bytes, depth, node count and diagnostics in each processing layer. Validation performs no network dereference, code execution, authentication or privilege grant. Local file digests show byte integrity, not authorship or permission. Confidential information requires separately enforced audience policy; no public fixture contains a private user manuscript.

15. Accessibility considerations​

Preserve logical reading order, heading meaning, accessible labels/alternative text, language distinctions and note navigation where supported. The core snapshot validator does not assess complete accessibility, assistive technology behavior or page layout. Missing evidence remains an explicit exclusion.

16. Internationalisation considerations​

Unicode scalar values and language identifiers retain their meaning across UI languages. The review profile uses modern BCP 47 tags accepted by ECMAScript Intl plus private-use tags; unsupported grandfathered syntax needs a future declared language profile. No casing or Unicode normalization is applied to object IDs. Canonical English requirements prevail over informative summaries.

17. Examples​

A minimal review projection, not a complete OMI-SPEC-320 manuscript:

{"id":"m-1","title":"Sample","locale":"hu","createdAt":"2026-10-31T00:00:00Z","updatedAt":"2026-10-31T00:00:00Z","sections":[{"id":"s-1","title":"Section","blocks":[{"id":"b-1","type":"paragraph","content":"Unicode: árvíztűrő 中文"}]}]}

Fixture manifest lists exact expected diagnostic codes and partial requirement mappings.

18. Normative references​

19. Informative references​

Document Model, Metadata Model, OMI-SPEC-320 File Format, OMI-SPEC-180 Validation, OMI-SPEC-350 Capability and Conformance.

20. Implementation status​

The profile schema, pure validator and versioned fixtures provide partial executable evidence. The readiness inventory maps all requirements to partial or untested evidence and names exclusions. Existing Studio behavior is assessed against a pinned commit; no complete implementation or conformance claim is implied. No independent evaluator has approved the profile or this Draft promotion.

21. Unresolved issues​

Full requirement coverage; independently developed interoperability evidence; public review and disposition of comments; approved role/profile classes; all specialized object semantics; complete privacy/accessibility tests; vocabulary governance; and migration from previous Draft contracts. These are explicit gates rather than completed work.

22. Change history​

VersionDateChange
0.3.02026-10-31Canonical-template rewrite, 18 stable requirement IDs, bounded core snapshot schema/fixtures/validator, explicit scope and evidence gaps. Remains Draft.

23. Acknowledgements​

Prepared for OMI maintainer and community review. Existing model concepts and historical versions remain attributed to their repository history.