◇ Open Values Standardfor builders

Spec / open-values-presentation-source-index

Open Values Presentation Source Index v1.0

Records for the sources that have their own page on the site, each with its publisher, dates, scope, limits and the catalogue facts that cite it. Maintainers write it, and the presentation build checks that every listed fact really cites the source's address.

Draft. It may still change before it is called stable. A file someone writes by hand or with a tool, and keeps.

Who writes it and who reads it

Written by pipeline/build_presentation.js. Read by P5 source pages, presentation acceptance audit.

Fields

FieldWhat it meansType
format requiredNames the file format. Always open-values-presentation-source-index.always "open-values-presentation-source-index"
version requiredThe version of this format the file follows. Always 1.0.0.always "1.0.0"
updated requiredThe date the index was last changed, as YYYY-MM-DD.string
scope requiredA sentence saying which sources the index covers and what happens to sources outside it.string
records requiredOne record per source that has its own source page.list

This format allows no fields beyond the list above. A writer MUST NOT add any.

The schema

Its address is https://openvaluesstandard.org/schema/presentation-source-index-v1.0.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/presentation-source-index.schema.json.

The key words MUST, MUST NOT, SHOULD, SHOULD NOT and MAY are used as described in RFC 2119 and RFC 8174 when, and only when, they appear in capitals.

Whether this format fits your app is your call. The spec says what a file MUST hold. Which formats you read and write, and what your app does with them, is yours to decide.