summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2026-09-29 14:02:30 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2026-10-12 21:48:46 -0400
commit7532a04beb6f51665011cf3117d2b29c651a3442 (patch)
tree0c7a9fb53724ed3648399c5994156a71df915a9a /README.md
parentderived values that the model left unstated (diff)
format 2.1: on poems and editor's notesHEADmainclaude-check-main
- 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)
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 4111ced..400bced 100644
--- a/README.md
+++ b/README.md
@@ -30,15 +30,16 @@ A specification, not a program. The repository ships:
Both carry, in their opening comment lines, the command that
regenerates them, so they can be diffed against a run rather than
-taken on trust. Both are output of **spine 0.25.0, format 2.0**.
+taken on trust. Both are output of **spine, format 2.1** (neither holds a
+poem, so from 2.0 to 2.1 each changed by its version line alone).
## Version
-The format is at **2.0**, and says so on the first line of every
+The format is at **2.1**, and says so on the first line of every
file:
```
-% SiSU Document Abstraction v2.0
+% SiSU Document Abstraction v2.1
```
The minor part is raised when a property is added, the major part
@@ -83,7 +84,8 @@ Line types (full grammar in
- Developers writing readers / converters for spine's abstraction
(readers written from this specification alone:
- sisudoc-ssp-reader, sisudoc-ocda-db-reader).
+ sisudoc-ssp-reader, sisudoc-ocda-db-reader, now frozen with current readers
+ offered and maintained within sisudoc-ocda-lib).
- Anyone studying spine's internal document model without reading
the D source.
- LLM / search / indexing tooling that consumes structured