summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2026-10-13 16:54:02 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2026-10-13 16:54:02 -0400
commitb95546cdb4995cf7fe598823f5d3264d53c274a8 (patch)
tree3c0d9b357aecdf113d176731c515fcc5cf75b5fe /README.md
parentformat 2.1: .ocn_range is one of the properties (diff)
frozen: superseded by ocda-read in sisudoc-ocda-libHEADmain
This reader is no longer maintained. Its modes are carried by ocda-read, the reader of sisudoc-ocda-lib, which is built on the library's model and so reads a .ssp, a .ocda.db and a pod alike. On every .ssp of the markup document samples it gives the D reader's output byte for byte after the first line (Read: where this says Parsed:) in --tree, --html, --llm-text, --llm-jsonl, --images, --verify and --validate; its summary differs only in the closing hint. The repository is kept as the record of what it showed: two readers, in D and in Gleam, written from the specification and from nothing else, agreeing; and a validator that found two rules the specification had left unstated. Its commits are matched to the points the specification reached, format 2.0 and format 2.1. The README says so at its head, and says "every document-language" where it gave a count; the ruby/ row goes, that reader not now to be written. The version is 2.1.0, the format this reader was brought to; it was 2.0.0. (assisted by Claude-Code)
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index 34a2dc6..c494abc 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
# sisudoc-ssp-reader
+> **Frozen, and superseded.** This reader is not maintained. Its work is
+> done by `ocda-read` in
+> [sisudoc-ocda-lib](https://git.sisudoc.org/sisudoc-ocda-lib), which reads
+> the `.ssp`, the `.ocda.db` and a pod alike, in D and in Gleam. This
+> repository is kept as the record of the readers written from the
+> specification alone, at the points the specification reached: format 2.0
+> and format 2.1.
+
Readers for the **`.ssp`** document abstraction, the object-centric
document abstraction written as text, which `sisudoc-spine` emits and
reads.
@@ -10,18 +18,17 @@ reads.
|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| [`dlang/`](dlang/) | D. Outline, HTML scroll, breadcrumbed text, JSONL chunks for embedding pipelines, an image manifest, image verification, and `--validate` |
| [`gleam/`](gleam/) | Gleam. Summary, outline, and what it did not understand |
-| `ruby/` | to come |
## Why more than one
-These are not three tools that happen to share a name. They are **the same
+These are not two tools that happen to share a name. They are **the same
specification implemented more than once**, and the interesting thing about
them is that they agree.
Each was written from the format specification, `sisudoc-abstraction-format`,
-rather than from spine's emitter or from each other. Run over the 36
-document reference collection, **the D and Gleam readers agree on the
-section counts of all 36**.
+rather than from spine's emitter or from each other. Run over the markup
+document samples, **the D and Gleam readers agree on the section counts of
+every document-language**.
That is the point of the exercise. A specification that one implementation
follows is a description of that implementation; a specification that two