46 lines
2.7 KiB
Markdown
46 lines
2.7 KiB
Markdown
# The scienting specifications
|
|
|
|
This is the specification of the scienting formats: exactly what each file holds and how every value in it is computed.
|
|
For what the formats are for, start with the [guides](../docs/README.md); this text assumes you know why and tells you how.
|
|
Schemas, SQL, the JSON-LD context, the registries, the vectors and the fixtures are normative too, and the chapters say which.
|
|
Where a chapter and a vector disagree, the disagreement is a bug; please report it.
|
|
|
|
## Reading paths
|
|
|
|
| If you are writing | Read |
|
|
| --- | --- |
|
|
| Anything at all | 0, 1, 3, 4 and 5: conventions, nodes, identity and the content values. |
|
|
| A reader of packages | Then 2, 6, 7 and 12: the model, anchors, geometry and the package. |
|
|
| A converter | Then 9, 10 and 11: figures and tables, references, and corrections with the gate. |
|
|
| A store or a server | Then 8, 13 and 14: receipts, the database form, and rights. |
|
|
| A tool for annotation, teaching or data | Then 15 to 21. |
|
|
| A validator | Chapter 22, with [registry/rules.json](../registry/rules.json). |
|
|
|
|
## Chapters
|
|
|
|
| Chapter | Subject |
|
|
| --- | --- |
|
|
| [00](00-introduction.md) | Scope, conformance, versions and status |
|
|
| [01](01-conventions.md) | Canonical JSON, numbers, hashes, normalization, offsets, times, IDs, keys and files |
|
|
| [02](02-model.md) | Works, versions, witnesses and documents; `document.json` and `witnesses.json` |
|
|
| [03](03-nodes.md) | Nodes, their kinds and children, content, attributes and inline runs |
|
|
| [04](04-identity.md) | Minting IDs, permanence, retirement, aliases and record IDs |
|
|
| [05](05-hashes.md) | The five content values, the projections, alignment, suspects and keyed hashes |
|
|
| [06](06-anchors.md) | Addresses, anchors and the five resolutions, with drift |
|
|
| [07](07-geometry.md) | Page fingerprints, stamp rules, pages and locations |
|
|
| [08](08-fidelity.md) | Fidelity levels, receipts, the roster, revocations, spot-checks and error bounds |
|
|
| [09](09-figures-tables-equations.md) | Figures, panels, tables, cells and equations |
|
|
| [10](10-references.md) | References and citations |
|
|
| [11](11-corrections.md) | Corrections and the gate |
|
|
| [12](12-package.md) | The package |
|
|
| [13](13-database.md) | The database form and the bundle |
|
|
| [14](14-rights.md) | Rights records, policies, stages and backends |
|
|
| [15](15-datasets.md) | Datasets |
|
|
| [16](16-digitization.md) | Digitization records |
|
|
| [17](17-views.md) | Views |
|
|
| [18](18-layers.md) | Layers and annotations |
|
|
| [19](19-exercises.md) | Exercises, submissions and grades |
|
|
| [20](20-projects.md) | Projects |
|
|
| [21](21-drafts.md) | Drafts: snapshots and sentence-ID sidecars |
|
|
| [22](22-conformance.md) | Conformance, the suite and the rule catalog |
|