docs: the tools' names in TitleCase
Prose names are PaperSpec, PaperDesk, PaperClaim and so on; commands, packages and paths stay lowercase. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014zNf4shD4zaCKLucZWPYL9
This commit is contained in:
24 files changed
+111
-111
No files matched your search
+2
-2
@@ -1,6 +1,6 @@
|
||||
# Schemas
|
||||
|
||||
This folder holds the JSON (JavaScript Object Notation) Schemas (draft 2020-12) for every file and record that the paperspec formats (paperspec is the specification this repository holds) define: 43 schema files.
|
||||
This folder holds the JSON (JavaScript Object Notation) Schemas (draft 2020-12) for every file and record that the PaperSpec formats (PaperSpec is the specification this repository holds) define: 43 schema files.
|
||||
A JSON Schema is a file, itself written in JSON, that states what a valid JSON file looks like.
|
||||
Newcomers can read it as a form: it lists the fields a record must have and what kind of value each field takes.
|
||||
Implementers will find the loading recipe and the traps under "Validating" and "Writing schemas".
|
||||
@@ -38,7 +38,7 @@ The rest belong to `candidate` formats or to no format of their own.
|
||||
|
||||
The bundle has no JSON Schema: its registry entry points to `sql/bundle-sqlite.sql`.
|
||||
Of the 43 schemas, 12 have no format of their own because each describes a line or part of a larger file: `common`, `node`, `runs`, `witnesses`, `provenance`, `location`, `reference`, `id-entry`, `mathml`, `math`, `annotation` and `value-anchor`.
|
||||
A line of `derived/math.jsonl` carries `form`, the math form `scienting-math/1` it reads the formula in; that names a spelling of TeX, which papermath implements ([spec/09 §9.4](../spec/09-figures-tables-equations.md#94-the-math-form)), not a file format, so the registry does not list it.
|
||||
A line of `derived/math.jsonl` carries `form`, the math form `scienting-math/1` it reads the formula in; that names a spelling of TeX, which PaperMath implements ([spec/09 §9.4](../spec/09-figures-tables-equations.md#94-the-math-form)), not a file format, so the registry does not list it.
|
||||
Of the schemas that do have one, 27 require a `format` property; `spot-check.schema.json` describes the input a VRF proof is made over rather than a file.
|
||||
The others (`page`, `draft-ids`, `view` and `log-entry`) describe a line of a file, a Vega-Lite specification (a JSON description of a chart) or an item of a tree, and the record itself does not need to carry the identifier.
|
||||
|
||||
|
||||
Reference in new issue
Block a user