Zum Hauptinhalt springen

Open Manuscript Initiative Specification Registry

Document metadata

FieldValue
Document typeGovernance registry
StatusDraft
Version0.1.0
Normative languageEnglish
Registry namespaceOMI-SPEC
Applies toNormative OMI specifications and reserved specification identifiers

1. Purpose

This document is the authoritative registry of Open Manuscript Initiative specification identifiers.

It defines:

  • the permanent identifier assigned to each OMI specification;
  • the official specification title;
  • the canonical source path;
  • the lifecycle status and current version;
  • the architectural category;
  • normative dependencies;
  • legacy and provisional identifiers that must be migrated;
  • the rules for allocating, reserving, deprecating, superseding, and preserving identifiers.

The registry exists because earlier OMI documents were created under several provisional numbering schemes. Some identifiers were assigned to more than one document. A stable standards suite cannot retain ambiguous identifiers.

Once an identifier is registered by this document, it MUST NOT be reassigned to another specification.

2. Authority

The identifiers listed in the Canonical specification registry section are the official OMI specification identifiers.

When another OMI document conflicts with this registry regarding an identifier, title, canonical path, or lifecycle state, this registry governs until the conflicting document is corrected through the normal review process.

This registry does not make every listed specification stable. It assigns identity independently from maturity. A specification may be Reserved, Exploratory, Draft, Review Candidate, Implementation Candidate, Stable, Deprecated, or Superseded.

3. Identifier syntax

A registered OMI specification identifier has the form:

OMI-SPEC-NNN

where NNN is a three-digit decimal number.

Examples:

OMI-SPEC-000
OMI-SPEC-120
OMI-SPEC-221
OMI-SPEC-350

The numerical component is an identifier, not a version number and not a priority rank.

A specification version is declared separately:

OMI-SPEC-210, version 0.2.0

4. Numbering architecture

OMI uses category-based number ranges.

RangeCategory
000–099Foundational principles and cross-suite constitutional specifications
100–199Core semantic, identity, document, annotation, validation, and collaboration models
200–299Scholarly workflow, bibliography, citation, review, rendering, and publishing models
300–399Platform, extensibility, API, packaging, exchange, import/export, and conformance specifications
400–899Reserved for future OMI specification families
900–999Reserved for future experimental allocation policy; not available for unilateral use

Numbers are intentionally not required to be consecutive. Related specifications may use adjacent numbers or a local subseries.

Example:

  • OMI-SPEC-220 defines bibliographic records;
  • OMI-SPEC-221 defines manuscript reference libraries and registry interaction.

5. Registry states

A registry entry has one of the following allocation states.

Reserved

The identifier and title are allocated, but the canonical specification document has not yet been created or accepted as a Draft.

A Reserved identifier MUST NOT be assigned to a different subject.

Active

A canonical specification document exists and participates in the OMI lifecycle.

The lifecycle status is recorded separately.

Deprecated

The specification remains valid for existing implementations but is not recommended for new work.

Superseded

A named successor formally replaces the specification.

Withdrawn

Development ended before the specification became Stable. The identifier remains permanently unavailable for reuse.

6. Canonical specification registry

6.1 Foundations and core semantic models

IdentifierOfficial titleAllocationLifecycleVersionCanonical path
OMI-SPEC-000Core PrinciplesActiveDraft0.1.0docs/foundations/core-principles.md
OMI-SPEC-100Document ModelActiveDraft0.1.0docs/specifications/document-model.md
OMI-SPEC-110Anchor ModelActiveDraft0.1.0docs/specifications/anchor-model.md
OMI-SPEC-120Scholarly Object ModelActiveDraft0.1.0docs/specifications/core/scholarly-object-model.md
OMI-SPEC-130Annotation ModelActiveDraft0.2.0docs/specifications/annotation-model.md
OMI-SPEC-140Metadata ModelActiveDraft0.1.0docs/specifications/metadata-model.md
OMI-SPEC-150Identity and Contributor ModelReserveddocs/specifications/identity-contributor-model.md
OMI-SPEC-160Versioning and Change ModelReserveddocs/specifications/versioning-change-model.md
OMI-SPEC-170Translation ModelReserveddocs/specifications/translation-model.md
OMI-SPEC-180Validation ModelReserveddocs/specifications/validation-model.md
OMI-SPEC-190Collaboration and Permission ModelReserveddocs/specifications/collaboration-permission-model.md

6.2 Scholarly workflow, references, and publishing

IdentifierOfficial titleAllocationLifecycleVersionCanonical path
OMI-SPEC-200Review ModelActiveDraft0.1.0docs/specifications/review-model.md
OMI-SPEC-210Citation ModelActiveDraft0.2.0docs/specifications/citation-model.md
OMI-SPEC-220Bibliographic Record ModelActiveDraft0.1.0docs/specifications/bibliographic-record-model.md
OMI-SPEC-221Reference Library and Registry ArchitectureActiveDraft0.1.0docs/specifications/reference-library-registry.md
OMI-SPEC-230Publishing ModelActiveDraft0.1.0docs/specifications/publishing-model.md
OMI-SPEC-240Rendering and Publication Profile ModelReserveddocs/specifications/rendering-publication-profile-model.md

6.3 Platform, exchange, and conformance

IdentifierOfficial titleAllocationLifecycleVersionCanonical path
OMI-SPEC-300Plugin ArchitectureActiveDraft0.1.0docs/specifications/plugin-architecture.md
OMI-SPEC-310Platform APIActiveDraft0.1.0docs/specifications/api.md
OMI-SPEC-320File FormatActiveDraft0.1.0docs/specifications/file-format.md
OMI-SPEC-330Container ArchitectureActiveDraft0.1.0docs/specifications/container-architecture.md
OMI-SPEC-340Import and Export ModelReserveddocs/specifications/import-export-model.md
OMI-SPEC-350Capability and Conformance ModelReserveddocs/specifications/capability-conformance-model.md

7. Dependency registry

The dependency list records direct normative dependencies expected for the canonical specification architecture. A Draft may refine these dependencies before reaching Review Candidate.

IdentifierDirect dependencies
OMI-SPEC-000None
OMI-SPEC-100OMI-SPEC-000, OMI-SPEC-120
OMI-SPEC-110OMI-SPEC-000, OMI-SPEC-100, OMI-SPEC-120
OMI-SPEC-120OMI-SPEC-000
OMI-SPEC-130OMI-SPEC-100, OMI-SPEC-110, OMI-SPEC-120
OMI-SPEC-140OMI-SPEC-000, OMI-SPEC-120
OMI-SPEC-150OMI-SPEC-120, OMI-SPEC-140
OMI-SPEC-160OMI-SPEC-100, OMI-SPEC-120, OMI-SPEC-140, OMI-SPEC-150
OMI-SPEC-170OMI-SPEC-100, OMI-SPEC-110, OMI-SPEC-120, OMI-SPEC-140, OMI-SPEC-150, OMI-SPEC-160
OMI-SPEC-180OMI-SPEC-000, OMI-SPEC-100, OMI-SPEC-110, OMI-SPEC-120, OMI-SPEC-130, OMI-SPEC-140
OMI-SPEC-190OMI-SPEC-100, OMI-SPEC-120, OMI-SPEC-150, OMI-SPEC-160
OMI-SPEC-200OMI-SPEC-110, OMI-SPEC-130, OMI-SPEC-150, OMI-SPEC-160, OMI-SPEC-190
OMI-SPEC-210OMI-SPEC-110, OMI-SPEC-120, OMI-SPEC-220, OMI-SPEC-221
OMI-SPEC-220OMI-SPEC-120, OMI-SPEC-140, OMI-SPEC-150
OMI-SPEC-221OMI-SPEC-140, OMI-SPEC-210, OMI-SPEC-220
OMI-SPEC-230OMI-SPEC-100, OMI-SPEC-140, OMI-SPEC-180, OMI-SPEC-210, OMI-SPEC-240, OMI-SPEC-320
OMI-SPEC-240OMI-SPEC-100, OMI-SPEC-140, OMI-SPEC-210
OMI-SPEC-300OMI-SPEC-000, OMI-SPEC-350
OMI-SPEC-310OMI-SPEC-100, OMI-SPEC-150, OMI-SPEC-190, OMI-SPEC-350
OMI-SPEC-320OMI-SPEC-100, OMI-SPEC-120, OMI-SPEC-140, OMI-SPEC-160, OMI-SPEC-180
OMI-SPEC-330OMI-SPEC-320
OMI-SPEC-340OMI-SPEC-100, OMI-SPEC-140, OMI-SPEC-180, OMI-SPEC-220, OMI-SPEC-320
OMI-SPEC-350OMI-SPEC-000, OMI-SPEC-300, OMI-SPEC-310, OMI-SPEC-320, OMI-SPEC-340

Dependencies MUST NOT be inferred solely from this table when implementing a particular released version. The exact versioned specification and suite manifest govern released conformance.

8. Legacy identifier migration

8.1 Reason for migration

Before this registry, OMI documentation used two incompatible numbering approaches:

  1. a short sequential series such as OMI-SPEC-001 through OMI-SPEC-012;
  2. a category-based series such as OMI-SPEC-100, OMI-SPEC-110, and OMI-SPEC-120.

The short sequence contains collisions:

  • OMI-SPEC-003 was used by both the Anchor Model and Annotation Model;
  • OMI-SPEC-006 was used by both the Review Model and Bibliographic Record Model;
  • OMI-SPEC-007 was used by both the Publishing Model and Reference Library and Registry Architecture.

A colliding identifier cannot be permanent because it does not identify one unambiguous specification.

The category-based series is therefore adopted as the canonical registry system. It already appears in the OMI Architecture Map and in the canonical core Scholarly Object Model.

8.2 Legacy alias table

The following identifiers are historical or provisional aliases. They MUST NOT be used for new normative references.

Legacy or provisional identifierHistorical useCanonical identifierMigration action
OMI-SPEC-001Document ModelOMI-SPEC-100Replace identifier; preserve old URL where practical
OMI-SPEC-002Referenced informally as Anchor ModelOMI-SPEC-110Replace dependency references
OMI-SPEC-003Anchor ModelOMI-SPEC-110Replace identifier
OMI-SPEC-003Annotation ModelOMI-SPEC-130Replace identifier
OMI-SPEC-004Metadata ModelOMI-SPEC-140Replace identifier
OMI-SPEC-005Citation ModelOMI-SPEC-210Replace identifier
OMI-SPEC-006Review ModelOMI-SPEC-200Replace identifier
OMI-SPEC-006Bibliographic Record ModelOMI-SPEC-220Replace identifier
OMI-SPEC-007Publishing ModelOMI-SPEC-230Replace identifier
OMI-SPEC-007Reference Library and Registry ArchitectureOMI-SPEC-221Replace identifier
OMI-SPEC-008Plugin ArchitectureOMI-SPEC-300Replace identifier
OMI-SPEC-009Earlier Scholarly Object ModelOMI-SPEC-120Consolidate content into canonical document
OMI-SPEC-010Platform APIOMI-SPEC-310Replace identifier
OMI-SPEC-011File FormatOMI-SPEC-320Replace identifier
OMI-SPEC-012Container ArchitectureOMI-SPEC-330Replace identifier

The legacy numbers were never protected by an adopted registry. They are therefore not registered permanent identifiers and MUST NOT be reassigned within the short sequence.

8.3 Migration requirements

The documentation-refactoring phase MUST:

  • update the visible identifier in every active specification;
  • update dependency declarations and cross-references;
  • consolidate the duplicate Scholarly Object Model documents under OMI-SPEC-120;
  • retain redirects or migration notices for replaced public paths where feasible;
  • avoid presenting a legacy identifier as an alternative permanent identifier;
  • record the migration in each affected document's change history;
  • update schemas, examples, manifests, and conformance claims when they begin using registered identifiers.

9. Canonical Scholarly Object Model

OMI-SPEC-120 is assigned to the Scholarly Object Model at:

docs/specifications/core/scholarly-object-model.md

The separate document at:

docs/specifications/scholarly-object-model.md

is a legacy duplicate associated with the provisional identifier OMI-SPEC-009.

Its useful content must be reviewed and merged into the canonical OMI-SPEC-120 document. After consolidation, the legacy path should become a redirect or an explicit moved/superseded notice rather than a second normative specification.

10. Canonical path rules

A canonical path identifies the maintained source document in the repository.

Changing a canonical path does not change the registered identifier. A path change MUST include, where technically feasible:

  • an HTTP redirect from the former published route;
  • a repository migration notice;
  • updated internal links;
  • updated registry metadata;
  • preservation of version history.

A file path MUST NOT be treated as the specification's permanent identity.

11. Title rules

A registered title is the official human-readable name of the specification.

A compatible editorial title change MAY occur without changing the identifier when the scope and normative subject remain the same.

A proposal that changes the subject so substantially that existing references would become misleading requires a new identifier.

Historical titles SHOULD be recorded as aliases when they have appeared in public releases or external citations.

12. Version and lifecycle fields

Each Active specification MUST declare both:

  • a semantic version;
  • a lifecycle status.

Examples:

OMI-SPEC-210
Version: 0.2.0
Status: Draft

Version and lifecycle status are independent. The registry MUST NOT infer one from the other.

The status values are governed by the Specification Lifecycle document. Version increments are governed by the Versioning Policy.

13. Reserved specifications

A Reserved entry communicates architectural intent but does not create normative requirements.

A Reserved specification becomes Active only after:

  1. a canonical document is created;
  2. its scope matches the registered title or an approved registry amendment changes the title;
  3. required metadata is present;
  4. the document reaches at least Draft status;
  5. the registry entry is updated through review.

Implementations MUST NOT claim conformance to a Reserved specification.

14. Allocation procedure

A proposal for a new identifier MUST include:

  • proposed title;
  • problem statement and scope;
  • proposed number range and identifier;
  • relationship to existing specifications;
  • expected normative dependencies;
  • reason the subject requires a separate specification;
  • proposed editor or maintainer;
  • initial lifecycle status;
  • expected schema, profile, registry, or test artefacts.

Allocation SHOULD occur only when the scope is sufficiently distinct to remain stable.

An identifier MAY be reserved before the full Draft exists when early allocation prevents collisions or coordinates parallel work.

15. Prohibition on unilateral allocation

Authors MUST NOT create a new normative OMI-SPEC-NNN identifier merely by adding it to a document title or filename.

A new identifier becomes official only when it is entered in this registry through the accepted contribution and review process.

Unregistered numbers appearing in branches, issues, examples, or experimental documents have no permanent status.

16. Identifier permanence

After registration, an identifier MUST remain associated with the same conceptual specification lineage.

The identifier MUST NOT change because of:

  • a title correction;
  • a file move;
  • a sidebar reorganisation;
  • translation;
  • a minor or patch version;
  • a new editor;
  • deprecation;
  • supersession;
  • withdrawal.

A withdrawn or superseded identifier remains reserved permanently.

17. Splitting and merging specifications

17.1 Split

When one specification is divided into independently versioned specifications:

  • the original identifier remains with the principal continuing lineage or becomes Superseded;
  • each newly independent specification receives a new identifier;
  • the registry records the relationship;
  • migration guidance identifies which requirements moved.

17.2 Merge

When several specifications are merged:

  • one identifier MAY continue if its conceptual lineage clearly dominates;
  • other identifiers become Superseded;
  • a new identifier SHOULD be allocated when no existing identifier accurately represents the merged scope;
  • superseded identifiers MUST NOT be reused.

18. Deprecation and supersession records

A Deprecated or Superseded registry entry MUST state:

  • affected versions;
  • effective date or release;
  • successor identifier, when one exists;
  • migration guidance;
  • support and archival status.

The canonical page MUST remain accessible or resolve to an archival landing page.

19. Schema, profile, and registry relationships

An OMI specification identifier identifies a prose specification. It does not automatically identify:

  • a JSON Schema;
  • a publication profile;
  • a controlled vocabulary registry;
  • an example corpus;
  • a conformance test suite;
  • a software implementation.

These artefacts require their own identifiers or versioned names under the applicable OMI governance rules.

A registry entry SHOULD link to such artefacts when they exist.

20. Implementation status

The registry records specification identity and maturity, not implementation conformance.

Until an evidence-based implementation matrix is adopted, the implementation status of all entries is Not assessed unless a separate reviewed record states otherwise.

The existence of similarly named code in Open Manuscript Studio is not sufficient evidence of specification conformance.

21. Official translations

Official translations use the same registered identifier as the English source.

Example:

OMI-SPEC-210 — Citation Model
English source version: 0.2.0
Hungarian translation revision: hu-1

A translation MUST NOT receive a different OMI-SPEC number.

Translation metadata must identify the exact normative source version and synchronization status.

22. References to registered specifications

A normative reference SHOULD use both identifier and title at first occurrence:

OMI-SPEC-210, Citation Model

Subsequent references MAY use the identifier alone when unambiguous.

A reference to a specific conformance target MUST include the version:

OMI-SPEC-210 version 0.2.0

References MUST NOT use a legacy alias after the affected document has been migrated.

23. Machine-readable registry

A future machine-readable registry SHOULD be generated from or validated against this document.

A record is expected to contain fields equivalent to:

identifier: OMI-SPEC-210
title: Citation Model
allocation: active
status: draft
version: 0.2.0
canonicalPath: docs/specifications/citation-model.md
category: scholarly-references
dependsOn:
- OMI-SPEC-110
- OMI-SPEC-120
- OMI-SPEC-220
- OMI-SPEC-221
legacyAliases:
- OMI-SPEC-005
implementationStatus: not-assessed

The machine-readable form MUST NOT silently diverge from the reviewed registry. Automated validation should eventually check:

  • identifier uniqueness;
  • canonical-path uniqueness;
  • dependency existence;
  • absence of dependency cycles where cycles are prohibited;
  • valid lifecycle values;
  • valid semantic versions;
  • legacy-alias collisions;
  • consistency with specification front matter.

24. Governance documents outside the OMI-SPEC namespace

The following documents govern the specification suite but do not themselves receive OMI-SPEC identifiers:

DocumentCanonical path
Open Manuscript Initiative Charterdocs/governance/charter.md
Roadmap to OMI 1.0docs/governance/roadmap-to-omi-1.0.md
OMI Architecture Auditdocs/governance/architecture-audit.md
Specification Lifecycledocs/governance/specification-lifecycle.md
Versioning Policydocs/governance/versioning-policy.md
Specification Style Guidedocs/governance/style-guide.md
Terminology and Definitionsdocs/governance/terminology.md
Specification Registrydocs/governance/specification-registry.md

These governance documents may contain normative project requirements without becoming implementer-facing data-model specifications.

25. Initial migration sequence

After adoption of this registry, the recommended migration order is:

  1. update all active specification titles and metadata to registered identifiers;
  2. consolidate the two Scholarly Object Model documents under OMI-SPEC-120;
  3. update dependency declarations and internal references;
  4. reorganise the Docusaurus sidebar around the registered architecture;
  5. create the Reserved core specifications in dependency order;
  6. introduce machine-readable registry validation;
  7. publish an implementation-status matrix;
  8. bind schemas, examples, and conformance tests to exact specification versions.

26. Change control

Changes to this registry are classified as follows.

Patch change

  • correcting a path typo;
  • correcting non-normative wording;
  • synchronising an already approved status or version;
  • repairing a broken link.

Minor change

  • reserving a new identifier;
  • activating a Reserved entry;
  • adding a documented alias;
  • adding optional registry metadata;
  • recording a compatible title refinement.

Major change

  • changing the allocation architecture;
  • reassigning a registered identifier;
  • altering identifier permanence rules;
  • making an incompatible change to the meaning of registry records.

Reassignment of an already registered identifier is prohibited even through a major registry version. A conceptual replacement requires a new identifier and a supersession record.

27. Adoption effects

Adoption of this registry has the following immediate effects:

  • the category-based three-digit identifiers become canonical;
  • the short sequential identifiers become legacy provisional aliases;
  • identifier collisions are resolved without reusing ambiguous numbers;
  • docs/specifications/core/scholarly-object-model.md becomes the canonical source of OMI-SPEC-120;
  • planned specifications receive protected Reserved identifiers;
  • future specification creation must consult and update this registry.

The adoption does not by itself change the lifecycle status of any specification to Stable and does not constitute an implementation conformance claim.

28. Summary

The OMI Specification Registry provides one durable identity system for the complete standards suite.

It preserves the category-based architecture already used by the OMI Architecture Map, resolves conflicting provisional identifiers, reserves identifiers for missing models, protects identifiers from reuse, and establishes the basis for reliable cross-references, schemas, releases, translations, and conformance claims.