diff options
| -rw-r--r-- | README.md | 17 | ||||
| -rw-r--r-- | dlang/README.md | 18 | ||||
| -rw-r--r-- | dlang/dub.json | 2 | ||||
| -rw-r--r-- | dlang/flake.nix | 2 | ||||
| -rw-r--r-- | gleam/flake.nix | 2 | ||||
| -rw-r--r-- | gleam/gleam.toml | 2 |
6 files changed, 25 insertions, 18 deletions
@@ -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 diff --git a/dlang/README.md b/dlang/README.md index bb0aefd..181d27f 100644 --- a/dlang/README.md +++ b/dlang/README.md @@ -1,7 +1,7 @@ # ssp-reader, in D Reader for the **`.ssp` document-abstraction text format** emitted -by [sisudoc-spine](https://git.sisudoc.org/projects/sisudoc-spine). +by [sisudoc-spine](https://git.sisudoc.org/sisudoc-spine). Reads a `.ssp` file (spine's PEG-parsable serialisation of its internal document abstraction) and renders it into a chosen output: @@ -44,7 +44,7 @@ Spine's processing pipeline has three stages: `ssp-reader` picks up the abstraction at the end of stage 2 (the `.ssp` file) and runs alternative stage-3 renderings on top of it. The `.ssp` format itself is documented in -[`sisudoc-abstraction-format`](https://git.sisudoc.org/tools/sisudoc-abstraction-format). +[`sisudoc-abstraction-format`](https://git.sisudoc.org/sisudoc-abstraction-format). ## Quickstart @@ -127,7 +127,7 @@ the HTML, in the plain text, and as an embedding chunk in the JSONL. Fixed, and the reason the report exists. That is deliberate and is what makes the reader usable as a check on the -[format specification](https://git.sisudoc.org/specs/sisudoc-abstraction-format): +[format specification](https://git.sisudoc.org/sisudoc-abstraction-format): a reader that drops what it does not know is conforming, but one that cannot say what it dropped cannot tell you whether the specification it was written from was complete. Silence and understanding look alike otherwise. @@ -135,7 +135,7 @@ written from was complete. Silence and understanding look alike otherwise. ## Documentation - The `.ssp` format itself: see - [sisudoc-abstraction-format](https://git.sisudoc.org/tools/sisudoc-abstraction-format). + [sisudoc-abstraction-format](https://git.sisudoc.org/sisudoc-abstraction-format). - Source: [`src/`](src/) - one module per output format (`output_tree.d`, `output_html.d`, `output_llm_breadcrumbs.d`, `output_llm_jsonl.d`, `output_images.d`, `verify_images.d`), plus @@ -144,19 +144,19 @@ written from was complete. Silence and understanding look alike otherwise. ## License AGPL-3.0-or-later. See [`dub.json`](dub.json) and the parent -[sisudoc-spine](https://git.sisudoc.org/projects/sisudoc-spine) +[sisudoc-spine](https://git.sisudoc.org/sisudoc-spine) project for full licence text. ## Repository -- **Canonical URL:** https://git.sisudoc.org/tools/sisudoc-ssp-reader +- **Canonical URL:** https://git.sisudoc.org/sisudoc-ssp-reader - **Clone:** `git clone --depth=1 git://git.sisudoc.org/tools/sisudoc-ssp-reader` ## Related projects -- [sisudoc-spine](https://git.sisudoc.org/projects/sisudoc-spine) - +- [sisudoc-spine](https://git.sisudoc.org/sisudoc-spine) - produces the `.ssp` files this tool consumes. -- [sisudoc-abstraction-format](https://git.sisudoc.org/tools/sisudoc-abstraction-format) - +- [sisudoc-abstraction-format](https://git.sisudoc.org/sisudoc-abstraction-format) - specification of the `.ssp` text format. -- [tree-sitter-sisu](https://git.sisudoc.org/tools/tree-sitter-sisu) - +- [tree-sitter-sisu](https://git.sisudoc.org/tree-sitter-sisu) - tree-sitter grammar for the upstream `.sst` / `.ssm` markup. diff --git a/dlang/dub.json b/dlang/dub.json index 51f7132..544b737 100644 --- a/dlang/dub.json +++ b/dlang/dub.json @@ -4,7 +4,7 @@ ], "copyright": "Copyright (C) 2026 Ralph Amissah", "name": "ssp-reader", - "version": "2.0.0", + "version": "2.1.0", "description": "reader for SiSU Document Abstraction (.ssp) files", "homepage": "https://sisudoc.org", "license": "AGPL-3.0+", diff --git a/dlang/flake.nix b/dlang/flake.nix index 554b8e0..d039297 100644 --- a/dlang/flake.nix +++ b/dlang/flake.nix @@ -17,7 +17,7 @@ */ mkReader = { compiler, compilerBin }: pkgs.stdenv.mkDerivation { pname = name; - version = "2.0.0"; + version = "2.1.0"; src = self; nativeBuildInputs = [ pkgs.dub compiler ]; buildPhase = '' diff --git a/gleam/flake.nix b/gleam/flake.nix index 57c92e3..9c096a0 100644 --- a/gleam/flake.nix +++ b/gleam/flake.nix @@ -30,7 +30,7 @@ */ ${name} = buildGleamApplication { pname = name; - version = "2.0.0"; + version = "2.1.0"; src = ./.; nativeBuildInputs = [ pkgs.makeWrapper ]; buildPhase = '' diff --git a/gleam/gleam.toml b/gleam/gleam.toml index 8a56dbb..b437879 100644 --- a/gleam/gleam.toml +++ b/gleam/gleam.toml @@ -1,5 +1,5 @@ name = "ssp_reader" -version = "2.0.0" +version = "2.1.0" # Fill out these fields if you intend to generate HTML documentation or publish # your project to the Hex package manager. |
