|
- editor's notes:
Updated here, spine now apart from author's notes recognises existing
markup's editor's notes, ~[* ]~ and ~[+ ]~, and writes them as notes
of their own numbered series: *1, *2 ... and +1, +2 ... document.
- a poem is a container of its verse:
.ocn_range, the first and last ocn of what a container holds, as one
.ssp property and two .ocda.db columns. A poem is the one container:
its verses are the citable units rather than the poem. A poem now
comes before its first verse, carries ocn 0 and no identifier, and
states the range, where it came after its last verse carrying that
verse's ocn and identifier.
So the model can now say that a non-zero ocn is unique within a
document, and does, keeping the older rule for artefacts written
before 2.1. A minor bump: an addition, a poem was never rendered and
has no text, the verses are unchanged, and a 2.0 reader reads a 2.1
file.
The property-count table is recounted over the regenerated reference
set, the method first checked against the old set, which it reproduces.
The one new endnote, a note in a poem's last verse now gathered,
accounts for the other moved counts; the poems' segment names account
for .segment_html_is and .segment_epub_is.
(assisted by Claude-Code)
|
|
In an age of malleable, replaceable, improvable text, we continue to
seek to represent set text in a fixed, determinate way.
This is an effort, using an LLM (Anthropic's Claude Code), to extract
and state the specification of the document abstraction of the
program spine:
- spine can write its document abstraction as a .ssp file, a
PEG-parsable serialisation from which other forms of it, such as
the sqlite .ocda.db, can be derived
https://git.sisudoc.org/sisudoc-spine
git clone --depth=1 git://git.sisudoc.org/software/sisudoc-spine
- this repository states the specification of that abstraction, as
the .ssp writes it, in enough detail and with enough precision for
the abstraction to be read and written independently
git clone --depth=1 git://git.sisudoc.org/specs/sisudoc-abstraction-format
- the claim is tested separately: with readers and writers built from
the specification alone, with no other knowledge of the format, that
read and write the abstraction exactly
The specification is derived from the spine emitter,
sisudoc/ocda/abstraction/ssp.d, whose sspObjectRecord is the single
definition of what an object looks like, and checked against the
document markup sample set. Where the two differ the emitter is
normative and the specification is wrong; the specification says so.
Three documents, so the model is described once rather than in each
format specification:
ocda-model.md the model: what an object is, the
citation number, structure,
sections, segments, digests. The
part both serialisations share
ssp-format-specification.md the model written as text
ocda-db-format-specification.md the model written as sqlite, to
come
The naming follows the three levels: ocda names the model,
abstraction names the pipeline stage, and .ssp and .ocda.db name the
two serialisations. A thing is named for the level it belongs to,
which is why this file is ssp-format-specification.md and not
ocda-format-specification.md: it specifies one serialisation, not the
model.
The specification states the version and the policy that governs it,
and separates conformance into what a reader must do, should do, and
what a writer must do. The single "should" is that a reader should
report what it ignored: without it, silence cannot be told from
understanding.
Both worked examples regenerated from spine 0.25.0. The excerpt
carries one complete object embedding an image, so the .image record
and the image marker in the object text can be read against each
other.
The name .ssp is recorded: it belongs to the .sst, .ssm, .ssi family
and stands loosely for sisu peg or sisu parsable, .ssa for sisu
abstraction having been thought taken by other projects.
README.md identifies the repository as a specification, not a
program, summarises what a .ssp is, gives its line types at a glance,
and points to ssp-format-specification.md and the two examples.
org/ocda_specification.org is the literate source the documents are
tangled from.
2026-09-22
(assisted by Claude-Code)
|