<feed xmlns='http://www.w3.org/2005/Atom'>
<title>sisudoc-abstraction-format/org/ocda_specification.org, branch claude-markdown-0</title>
<subtitle>SiSU Spine: specs</subtitle>
<link rel='alternate' type='text/html' href='https://git.sisudoc.org/sisudoc-abstraction-format/'/>
<entry>
<title>sisudoc-abstraction-format 2.0: ocda-model &amp; .ssp</title>
<updated>2026-10-03T16:07:15+00:00</updated>
<author>
<name>Ralph Amissah</name>
<email>ralph.amissah@gmail.com</email>
</author>
<published>2026-04-19T00:28:29+00:00</published>
<link rel='alternate' type='text/html' href='https://git.sisudoc.org/sisudoc-abstraction-format/commit/?id=0bf25dac62f2f8351367bc55ff9b373e380f7cf0'/>
<id>0bf25dac62f2f8351367bc55ff9b373e380f7cf0</id>
<content type='text'>
In the age of maleable, replacable, improvable, text, we here continue
to seek to being able to represent set text in a fixed, determinate way.

this is an effort using an LLM to extract the document abstraction
specifications for the program spine (Anthropic's Claude Code is used):

- within the program spine the document abstraction can be captured in
  a .ssp document abstraction serialization file, which is a peg
  parsable serialisation (from which other document abstractions can be
  derived, such as the sqlite ocda-db abstraction)
  https://git.sisudoc.org/sisudoc-spine/
  git clone --depth=1 git://git.sisudoc.org/software/sisudoc-spine

- here in the specification: capturing, describing, stating the
  specification of the abstraction as captured by the .ssp document
  serialization, with enough detail and precision to enable the
  independent reading and writing of the abstraction.
  https://git.sisudoc.org/sisudoc-abstraction-format/
  git clone --depth=1 git://git.sisudoc.org/specs/sisudoc-abstraction-format

- in the tools/ namespace attempts are made to successfuly, perfectly
  re-read and write from the abstraction using the specification alone
  (without use of any other prior or outside knowledge of the .ssp
  serialization format)

sisudoc-abstraction-format 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.

Should there be a difference the emitter is normative and the
specification is wrong; and it states 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.

Add a top-level README.md identifying the repository as a
specification (not a program), summarising what .ssp is (a
human-readable, PEG-parsable serialisation of spine's in-memory
document abstraction), listing the line-type grammar at a glance,
and pointing readers at format-specification.md for the full
reference and at the two example .ssp files shipped alongside.

Canonical URLs use the new git.sisudoc.org/tools/ namespace,
matching the parallel moves in tree-sitter-sisu and ssp-reader
and the local rename of sisudoc-spine-utils/ to
sisudoc-spine-tools/. Cross-references to ssp-reader and
tree-sitter-sisu follow the same convention.

(assisted by Claude-Code)
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
In the age of maleable, replacable, improvable, text, we here continue
to seek to being able to represent set text in a fixed, determinate way.

this is an effort using an LLM to extract the document abstraction
specifications for the program spine (Anthropic's Claude Code is used):

- within the program spine the document abstraction can be captured in
  a .ssp document abstraction serialization file, which is a peg
  parsable serialisation (from which other document abstractions can be
  derived, such as the sqlite ocda-db abstraction)
  https://git.sisudoc.org/sisudoc-spine/
  git clone --depth=1 git://git.sisudoc.org/software/sisudoc-spine

- here in the specification: capturing, describing, stating the
  specification of the abstraction as captured by the .ssp document
  serialization, with enough detail and precision to enable the
  independent reading and writing of the abstraction.
  https://git.sisudoc.org/sisudoc-abstraction-format/
  git clone --depth=1 git://git.sisudoc.org/specs/sisudoc-abstraction-format

- in the tools/ namespace attempts are made to successfuly, perfectly
  re-read and write from the abstraction using the specification alone
  (without use of any other prior or outside knowledge of the .ssp
  serialization format)

sisudoc-abstraction-format 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.

Should there be a difference the emitter is normative and the
specification is wrong; and it states 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.

Add a top-level README.md identifying the repository as a
specification (not a program), summarising what .ssp is (a
human-readable, PEG-parsable serialisation of spine's in-memory
document abstraction), listing the line-type grammar at a glance,
and pointing readers at format-specification.md for the full
reference and at the two example .ssp files shipped alongside.

Canonical URLs use the new git.sisudoc.org/tools/ namespace,
matching the parallel moves in tree-sitter-sisu and ssp-reader
and the local rename of sisudoc-spine-utils/ to
sisudoc-spine-tools/. Cross-references to ssp-reader and
tree-sitter-sisu follow the same convention.

(assisted by Claude-Code)
</pre>
</div>
</content>
</entry>
</feed>
