Spec / open-values-learning-work
Open Values learning work, version 0.1
Editable creative work and practice notes saved by a learner, which reopen the same activity. It claims no assessment, identity or credential. Writer and reader: sites/futurism-institute/public/js/kosplora-work-file.mjs in the websites repository. Readers also reject files over 128 KiB (UTF-8, optional leading byte order mark).
- Files people or tools write
- Status: draft
- Version: 0.1
- Format name in the file:
open-values-learning-work
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 Futurism Institute sites: sites/futurism-institute/public/js/kosplora-work-file.mjs. Read by Futurism Institute sites: sites/futurism-institute/public/js/kosplora-work-file.mjs.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Always "open-values-learning-work". Tells a reader which Open Values format this is. | always "open-values-learning-work" |
version required | The version of the format this file follows, "0.1". | always "0.1" |
activity required | Which Kosplora activity wrote the file and can reopen it: place-rhythm, the place and rhythm workshop, or message-practice, the message exercise. | one of "place-rhythm", "message-practice" |
activityVersion required | The version of that activity's draft, 1. | always 1 |
data required | The learner's whole draft for that activity. Its fields depend on the activity. | object |
This format allows no fields beyond the list above. A writer MUST NOT add any.
A file that passes
A place and rhythm draft with every field the activity writes.
{
"format": "open-values-learning-work",
"version": "0.1",
"activity": "place-rhythm",
"activityVersion": 1,
"data": {
"name": "Low tide meeting",
"setting": "coast",
"gathering": "Neighbours meet on the sea wall at low tide.",
"reason": "",
"next": "",
"tempo": 72,
"low": [
true,
false,
false,
false,
true,
false,
false,
false
],
"high": [
false,
false,
true,
false,
false,
false,
true,
false
]
}
}
A file that must be rejected
A learning-work file has exactly five top-level fields, and a tempo from 48 to 144; this one adds a score and sets the tempo to 200.
{
"format": "open-values-learning-work",
"version": "0.1",
"activity": "place-rhythm",
"activityVersion": 1,
"data": {
"name": "Low tide meeting",
"setting": "coast",
"gathering": "",
"reason": "",
"next": "",
"tempo": 200,
"low": [
true,
false,
false,
false,
true,
false,
false,
false
],
"high": [
false,
false,
true,
false,
false,
false,
true,
false
]
},
"score": 9
}
The schema
Its address is https://openvaluesstandard.org/schema/learning-work-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/learning-work.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.