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
+3
-3
@@ -1,6 +1,6 @@
|
||||
# FAQ
|
||||
|
||||
This page answers questions about paperspec, a set of file formats that give every sentence and table cell of a scientific paper a permanent address.
|
||||
This page answers questions about PaperSpec, a set of file formats that give every sentence and table cell of a scientific paper a permanent address.
|
||||
Newcomers, implementers of a reader, writer, converter or checker, and experts who know JATS (Journal Article Tag Suite), TEI (Text Encoding Initiative) or W3C Web Annotations can all use it.
|
||||
Each answer gives the plain statement first, then the precise one, then the chapter that defines it.
|
||||
The repository is <https://git.scient.ing/papers/paperspec>, and the formats are at version 0.1.0.
|
||||
@@ -88,13 +88,13 @@ Whether a team may share notes on a paper this way is a question for its own cou
|
||||
|
||||
They overlap in subject, not in job.
|
||||
|
||||
JATS, the [Journal Article Tag Suite](https://www.niso.org/publications/z3996-2024-jats) (ANSI/NISO Z39.96-2024), is an XML format for publishers and archives to exchange journal content. paperspec does not replace it.
|
||||
JATS, the [Journal Article Tag Suite](https://www.niso.org/publications/z3996-2024-jats) (ANSI/NISO Z39.96-2024), is an XML format for publishers and archives to exchange journal content. PaperSpec does not replace it.
|
||||
A JATS file is one kind of witness (a source file), an input from which a document is established.
|
||||
None of the 312 elements in the [JATS 1.4 Archiving tag library](https://jats.nlm.nih.gov/archiving/tag-library/1.4/) marks a sentence; its smallest text unit is the paragraph, `<p>`.
|
||||
|
||||
TEI, the Text Encoding Initiative, has a sentence-like [`<s>` element](https://tei-c.org/release/doc/tei-p5-doc/en/html/ref-s.html) and keeps both readings of a corrected passage with [`<corr>` and `<sic>`](https://tei-c.org/release/doc/tei-p5-doc/en/html/ref-corr.html).
|
||||
The encoder assigns its `xml:id`, and the guidelines [recommend it for durability](https://tei-c.org/release/doc/tei-p5-doc/en/html/SA.html).
|
||||
paperspec mints and retires IDs by rule, keeps corrections as separate records with evidence, and hashes each node.
|
||||
PaperSpec mints and retires IDs by rule, keeps corrections as separate records with evidence, and hashes each node.
|
||||
|
||||
Keep JATS for publisher and archive exchange and TEI for general scholarly text encoding.
|
||||
A TEI file is a witness of kind `xml` ([spec/02 §2.3](../spec/02-model.md)).
|
||||
|
||||
Reference in new issue
Block a user