Spec / open-values-slate
Open Values Slate v0.1
A group's plan for one facts file: the options it would use, the ones it would move away from, and the sourced reason for each, worked out from the group's values. The page at /slate/ makes it.
- Files people or tools write
- Status: draft
- Version: 0.1
- Format name in the file:
open-values-slate
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
No writer is listed. Read by slate/index.html, app/engine.js buildSlate.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Always "open-values-slate". Tells a reader that this file is a group's plan. | always "open-values-slate" |
version required | The version of the slate format this file follows, 0.1. | string |
lens | The id of the facts file the plan was built from. | string |
lensTitle | The facts file's title, from its meta. | string |
lensHash required | A fingerprint of that facts file, so a reader can tell whether the plan was made from the file they have. | string |
by | Whose values the plan uses: the name or source written in the values file that was loaded. | string |
values required | The group's weight for each shared value, from 0 to 5, copied from the values file the plan was made with. | map of number |
applied | The shared values weighted 4 or more that this facts file has a criterion for, so they changed the plan. | any |
dissent | What the group split on, carried from its collective file. | list |
endorse required | The options the group would use: up to three that score 60 or more, best first. | list |
divest required | The options the group would move away from: up to three that score 25 or less on a value the group weighted 4 or more, lowest overall score first. | list |
ranked required | Every option the facts file could score with these values, best first. | list |
A reader MUST ignore fields it does not know, so a file can carry more than this list and still be read. A writer MUST NOT change what a listed field means.
The schema
Its address is https://openvaluesstandard.org/schema/slate-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/slate.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.