Reviewed-on: #1
This commit is contained in:
57 files changed
+11446
No files matched your search
+26
@@ -107,6 +107,7 @@ A `candidate` format is complete, with vectors and fixtures, and ready to implem
|
||||
A `provisional` one is complete and expected to change as implementations gain experience.
|
||||
The provisional formats are dataset, digitization, view, project, bundle, snapshot, draft-ids, exercise, submission, grade, checklist, log-entry and checkpoint.
|
||||
|
||||
<<<<<<< HEAD
|
||||
The repository holds a reference checker (`paperspec check`), 25 vector files, five valid packages, one of them also as a zip, and 31 deliberately broken packages ([spec/00 §0.4](../spec/00-introduction.md#04-status), [spec/22](../spec/22-conformance.md)).
|
||||
|
||||
## What does it not do?
|
||||
@@ -130,3 +131,28 @@ See [CONTRIBUTING.md](../CONTRIBUTING.md).
|
||||
`paperspec check` recomputes and checks every one, and `paperspec load` loads packages into SQLite.
|
||||
The oracle's modules in `src/paperspec/` compute every expected value, so that none is typed by hand.
|
||||
The other repositories of the project install them as the Python package `paperspec`; independent implementations follow the specification ([tools/README.md](../tools/README.md)).
|
||||
||||||| parent of 4fa326d (First implementation (#1))
|
||||
=======
|
||||
The repository holds a reference checker (`tools/check.py`), 25 vector files, five valid packages, one of them also as a zip, and 31 deliberately broken packages ([spec/00 §0.4](../spec/00-introduction.md#04-status), [spec/22](../spec/22-conformance.md)).
|
||||
|
||||
## What does it not do?
|
||||
|
||||
It is built for a team-scale corpus of hundreds of documents, not hundreds of millions of papers.
|
||||
It does not replace publisher interchange formats; it reads JATS as a witness.
|
||||
It does not fix what a converter reads wrongly.
|
||||
It records the reading and raises disagreements as suspects, and a correction is checkable.
|
||||
It is not a search engine, a citation index or a recommendation feed ([docs/overview.md](overview.md)).
|
||||
|
||||
## How do I add a node kind or a run kind?
|
||||
|
||||
A node kind is a type of document part, such as `sentence`; a run kind is a type of inline content within a sentence, such as `math`.
|
||||
Propose either with the vector or fixture that shows it.
|
||||
A new kind is a minor version ([spec/00 §0.3](../spec/00-introduction.md#03-format-identifiers-and-versions)).
|
||||
See [CONTRIBUTING.md](../CONTRIBUTING.md).
|
||||
|
||||
## What are the files in `tools/` for?
|
||||
|
||||
`build.py` builds the fixtures and vectors. `check.py` recomputes and checks every one, and `load.py` loads packages into SQLite.
|
||||
The `oracle/` modules compute every expected value, so that none is typed by hand.
|
||||
They are not a library; implementations follow the specification ([tools/README.md](../tools/README.md)).
|
||||
>>>>>>> 4fa326d (First implementation (#1))
|
||||
Reference in new issue
Block a user