Spec / open-values-presentation-page-kinds
Open Values Presentation Page Kinds v1.0
The ten kinds of page the shared page layer draws, each with its purpose, its main action, its sections in order, and the opening sentence for each coverage state. Maintainers write it, and the presentation build copies it into the package the app reads.
- Files people or tools write
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-presentation-page-kinds
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 presentation implementation.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names the file format. Always open-values-presentation-page-kinds. | always "open-values-presentation-page-kinds" |
version required | The version of this format the file follows. Always 1.0.0. | always "1.0.0" |
updated required | The date the page kinds were last changed, as YYYY-MM-DD. | string |
pageKinds required | The ten kinds of page the shared presentation layer draws, in a fixed order. | 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-page-kinds-v1.0.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/presentation-page-kinds.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.