OCFL Specification Style Guide

A collection of editorial rules and decisions regarding the OCFL specification.

• Use US spelling (see #52)
• Use serial/Oxford commas.
• Use only the minimal subset of RFC2119 language: MAY, MUST, MUST NOT, SHOULD and SHOULD NOT (see #35)
• Capitalization: "OCFL Object" - always capitalize the O of Object, don't use the word object in other contexts except "object store"
• JSON terminology for "objects" can be confused with OCFL Objects. Use 'block' instead, or, if necessary, qualify it with "JSON object".
• Use spaces inside [ and ] when formatting JSON (see #206)
• When linking to terminology, a term should only be linked to its definition at its first occurrence in a section, where the section is scoped to the third level (X.Y.Z).
• Terminology links should be upper-cased in the text when being referenced.

Specification version numbering

Decided in 2018-09 Oxford meeting:

• URLs will follow x.y numbering, with any patch updates for x.y.z keeping URL
• URL pattern http://ocfl.io/x.y/spec/ and similarly for /implementation-notes/, /context.jsonld etc.
• URL pattern for working version will be http://ocfl.io/draft/spec/ etc.