Spec / open-values-presentation-strings
Open Values Presentation Strings v1.0
The words the shared page layer shows to readers: names for the main things a person works with, coverage messages, button labels and error messages. 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-strings
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-strings. | always "open-values-presentation-strings" |
version required | The version of this format the file follows. Always 1.0.0. | always "1.0.0" |
updated required | The date the strings were last changed, as YYYY-MM-DD. The presentation package uses it as its built date. | string |
locale required | The language of the strings, as a language code. The build currently accepts only en. | string |
signedVocabulary required | The names for the main things a person works with, such as My rules and The baseline, approved by the founder in the 2026-07-15 plain-words review. The build fails if any of them change. | see stringMap |
search required | Words for the search box and for the page shown when a search or address finds nothing. | see stringMap |
objectTypes required | The display name for each kind of thing a page can be about, such as Decision, Source or Company, keyed by type. | see stringMap |
coverage required | The five evidence states an answer can be in, each with a label, a sentence and an action. The labels are fixed and the build fails if they change. | object |
fieldStates required | Short messages shown in place of a missing or empty field, such as when a source was not supplied or ownership is unknown, keyed by state. | see stringMap |
evidenceKinds required | The labels for the three kinds of evidence: measured, certified, and assessed from public evidence. The build fails if they change. | see stringMap |
appliedValues required | Copy for the panel that explains why an answer ranks first. | object |
actions required | Button and link labels used across pages, such as Save this choice or Read source, keyed by action. Words in braces are filled in when the page is drawn. | see stringMap |
errors required | Error messages, keyed by error, such as an invalid address or a file that could not be imported. Words in braces are filled in when the message is shown. | see stringMap |
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-strings-v1.0.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/presentation-strings.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.