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
@@ -41,7 +41,7 @@ An implementation states, for each format, which versions it reads and writes.
|
||||
Every format has an identifier of the form `scienting-<name>/<major>`, such as `scienting-doc/1`.
|
||||
The identifier tells a reader which rules apply to a file.
|
||||
The prefix `scienting-` is the namespace of the formats.
|
||||
The namespace is not the name of this repository, paperspec, and formats are named after what they hold.
|
||||
The namespace is not the name of this repository, PaperSpec, and formats are named after what they hold.
|
||||
|
||||
A file or record that can travel on its own carries its identifier in a `format` property.
|
||||
The anchor in `fixtures/records/anchor-leaf.json` begins `{"doc":"hale2026harmonic-damb","format":"scienting-anchor/1", ...`.
|
||||
|
||||
+1
-1
@@ -150,5 +150,5 @@ A consumer MAY rely on these properties of a source that carries `form`:
|
||||
A producer writes `form` only on a source it has spelled in that form.
|
||||
A correction that changes such a source writes the new source in the form too, since the gate does not implement the form and cannot check it.
|
||||
A validator that implements the form reports a source with `form` that is not its own canonical spelling as `doc.math.form`.
|
||||
One that does not can still report a `scienting-math/1` source that holds `\tag`, `\label`, `\nonumber`, `\notag`, a style command such as `\displaystyle`, `\dfrac` or `\tfrac`, which the form never holds ([9.4](09-figures-tables-equations.md#94-the-math-form)); the reference validator does that, and checks every source with papermath when it is installed.
|
||||
One that does not can still report a `scienting-math/1` source that holds `\tag`, `\label`, `\nonumber`, `\notag`, a style command such as `\displaystyle`, `\dfrac` or `\tfrac`, which the form never holds ([9.4](09-figures-tables-equations.md#94-the-math-form)); the reference validator does that, and checks every source with PaperMath when it is installed.
|
||||
`form` enters no content value, so adding it to a source already in the form changes no hash, ID or anchor, while respelling a source in the form changes them as any edit of the source does ([5.2](05-hashes.md#52-own-content)).
|
||||
@@ -41,7 +41,7 @@ MathML is derived by a pinned tool and recorded, with the tool's name and versio
|
||||
|
||||
`scienting-math/1` is the standard form of a formula in a paper: one canonical TeX spelling, a tree read from it, a key for each symbol, and the issues a reader should look at.
|
||||
A converter writes a package's equations and math runs in it, a reader renders and searches it, and a claim store reads a paper's equations and its own claims through it, so the two can be matched.
|
||||
papermath is its reference implementation, and what papermath computes is what the form says; this section states what the specification relies on.
|
||||
PaperMath is its reference implementation, and what PaperMath computes is what the form says; this section states what the specification relies on.
|
||||
The identifier names a spelling of formulas, not a file format, so [registry/formats.json](../registry/formats.json) does not list it; its readings travel in a package's `derived/math.jsonl`.
|
||||
The form reads TeX only.
|
||||
|
||||
@@ -94,7 +94,7 @@ A later minor version of the form may add a kind, and a consumer that meets a ki
|
||||
**A symbol** is a base, which is a letter, a Greek letter, or a font or accent command on a group (`\mathbf{F}`, `\hat{H}`), with any subscript, any superscript that names rather than raises (`R^{*}`, `A^{\dagger}`, `E^{\text{LJ}}`), and primes.
|
||||
A text group alone is a symbol too, unless it holds several words, is a condition in `cases`, or is the set under a big operator.
|
||||
A symbol's key is its canonical TeX with `\mathrm` spelled `\text`, `\ast` spelled `*`, `\prime` spelled `'`, and no space inside text: `K_r` and `K_{r}` have the key `K_{r}`, and `r_{\mathrm{eq}}` has the key `r_{\text{eq}}`.
|
||||
The key is the one a paperclaim claim store gives a symbol, so a symbol in a paper and the same symbol in a claim have one key, and a `symbol` annotation names its symbol by it ([18.4](18-layers.md#184-bodies)).
|
||||
The key is the one a PaperClaim claim store gives a symbol, so a symbol in a paper and the same symbol in a claim have one key, and a `symbol` annotation names its symbol by it ([18.4](18-layers.md#184-bodies)).
|
||||
|
||||
**Issues** never stop the reading; each is `{code, message, at}`, with `at` the canonical TeX it is about.
|
||||
|
||||
@@ -113,4 +113,4 @@ A later minor version may add a code.
|
||||
`run` is the index of the math run among the node's runs, or null for an equation or equation line, as in `derived/mathml.jsonl`; `symbols` lists the keys in the order the formula first writes them; `label` is the label the tool lifted from a `\tag`, omitted when the source has none, as a canonical source never does.
|
||||
The schema is `math.schema.json`.
|
||||
A validator checks what it can without implementing the form: that each line names a formula of the package (`doc.derived.node`), and that the formula is TeX, `complete` is true exactly when the tree has no `opaque` node, and `symbols` holds each `sym` key of the tree once (`doc.derived.math`).
|
||||
`fixtures/packages/hale2026harmonic-damb/derived/math.jsonl` holds papermath's reading of the example's equation, of a math run that is one symbol, and of the run `_2` of "H₂O", which the tree cannot read alone.
|
||||
`fixtures/packages/hale2026harmonic-damb/derived/math.jsonl` holds PaperMath's reading of the example's equation, of a math run that is one symbol, and of the run `_2` of "H₂O", which the tree cannot read alone.
|
||||
+2
-2
@@ -62,7 +62,7 @@ Replies are annotations that target annotations, so discussions are threads anch
|
||||
|
||||
A textual body has a `value`, and optionally a `format` (`text/plain` or `text/markdown`) and a `language`.
|
||||
|
||||
The `source` of a `claim-link` or `symbol` body is a claim in a paperclaim claim store, written as paperclaim writes a reference: `claim:` and the claim's tag, eight Crockford base32 capitals (the digits and the letters without I, L, O and U), as in `claim:272XTX7C`, or `claim:<host>/<tag>` for a claim in another store, `<host>` being a domain name.
|
||||
The `source` of a `claim-link` or `symbol` body is a claim in a PaperClaim claim store, written as PaperClaim writes a reference: `claim:` and the claim's tag, eight Crockford base32 capitals (the digits and the letters without I, L, O and U), as in `claim:272XTX7C`, or `claim:<host>/<tag>` for a claim in another store, `<host>` being a domain name.
|
||||
A tag never changes, while a claim's slug, such as `amber/k-bond`, may be renamed, so a slug is never a reference.
|
||||
The optional `pin` fixes the claim as the annotator read it: the same reference, `@`, and the first six lowercase hex digits of the claim's statement hash, as in `claim:272XTX7C@02f47b`.
|
||||
`common.schema.json` defines both, as `claimRef` and `claimPin`.
|
||||
@@ -90,7 +90,7 @@ The store's `annotations` table keeps the category beside the body's kind ([13.4
|
||||
Nothing a model writes is ever stored as source text.
|
||||
A model may propose a `description`, and like any annotation it stays `proposed` until a person confirms it; an accessible export uses confirmed descriptions only, and a figure with none has no description.
|
||||
Other text a model writes about a span, such as a summary, is a `generated` annotation, which names its `generator`.
|
||||
`fixtures/records/layer/` holds a layer with one annotation of each common kind, each comment, caveat and question with its category, a claim link and a symbol that reference a paperclaim claim and pin it, and the receipt that confirms some of them.
|
||||
`fixtures/records/layer/` holds a layer with one annotation of each common kind, each comment, caveat and question with its category, a claim link and a symbol that reference a PaperClaim claim and pin it, and the receipt that confirms some of them.
|
||||
|
||||
## 18.5 Traced citations
|
||||
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
# The paperspec specification
|
||||
# The PaperSpec specification
|
||||
|
||||
This specification states exactly what each paperspec file holds and how every value in it is computed.
|
||||
This specification states exactly what each PaperSpec file holds and how every value in it is computed.
|
||||
The schemas, SQL, JSON-LD context, registries, vectors and fixtures are normative too, and each chapter says which of them it relies on.
|
||||
A chapter and a vector that disagree signal a bug, so please report it in the repository, <https://git.scient.ing/papers/paperspec>.
|
||||
|
||||
|
||||
Reference in new issue
Block a user