summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2026-09-29 17:57:00 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2026-10-03 12:09:16 -0400
commitdf09967a7f27012afe6e785ce77d5c3fd7432157 (patch)
treee25cb881e3001b11bbcf59eb0bc6eeb65407c898
parentformat 2.1: poem is a container of verse (objects) (diff)
format 2.1: editor's notesmain-considerclaude-markdown-0
Spine now recognises the markup's editor's notes, ~[* ]~ and ~[+ ]~, which it had passed through as text, and writes them as notes of their own numbered series: *1, *2 ... and +1, +2 ..., each through the document, apart from the author's notes. So a note mark now has three forms, and a reader must take all three: digits, the author's notes; symbols alone, the special notes; a symbol and digits, the editor's notes. Section 3.2 says so and gives the pattern; the history row for 2.1, the same unreleased version as the poem's range, records it. (assisted by Claude-Code)
-rw-r--r--ocda-db-format-specification.md84
-rw-r--r--ocda-model.md92
-rw-r--r--ssp-format-specification.md227
3 files changed, 209 insertions, 194 deletions
diff --git a/ocda-db-format-specification.md b/ocda-db-format-specification.md
index 9f58b73..fe4ad3a 100644
--- a/ocda-db-format-specification.md
+++ b/ocda-db-format-specification.md
@@ -107,12 +107,12 @@ The `.ssp` has four preamble blocks, `@source`, `@meta`, `@make` and
`@doc_has`. The database has **one** `metadata` table, and tells them apart
by a **prefix on the key**:
-| `.ssp` block | database key |
-|--------------|--------------|
-| `@meta` | the key as it stands: `title.main`, `creator.author`, ... |
-| `@make` | `make.` + the key: `make.footer`, `make.doc_type` |
-| `@doc_has` | `doc_has.` + the key: `doc_has.images`, `doc_has.tables` |
-| `@source` | `source.` + the key: `source.language`, `source.digest` |
+| `.ssp` block | database key |
+|--------------|-----------------------------------------------------------|
+| `@meta` | the key as it stands: `title.main`, `creator.author`, ... |
+| `@make` | `make.` + the key: `make.footer`, `make.doc_type` |
+| `@doc_has` | `doc_has.` + the key: `doc_has.images`, `doc_has.tables` |
+| `@source` | `source.` + the key: `source.language`, `source.digest` |
**A reader must strip the prefix and restore the grouping**, or a writer
over it has to ask `metadata["make.footer"]` from a database and
@@ -150,12 +150,12 @@ reader of the text form necessarily does.
The **element types**, so that a decoder can be written to accept exactly
what occurs:
-| column | elements |
-|--------|----------|
-| `children`, `ancestors`, `ancestors_collapsed`, `dom_status`, `dom_status_collapsed` | integers |
-| `table_widths` | integers, or floats where the columns divide evenly |
-| `table_aligns` | strings, one of `l` `c` `r` |
-| `heading_ancestors_text` | strings, eight of them, empty where that level is not an ancestor |
+| column | elements |
+|--------------------------------------------------------------------------------------|-------------------------------------------------------------------|
+| `children`, `ancestors`, `ancestors_collapsed`, `dom_status`, `dom_status_collapsed` | integers |
+| `table_widths` | integers, or floats where the columns divide evenly |
+| `table_aligns` | strings, one of `l` `c` `r` |
+| `heading_ancestors_text` | strings, eight of them, empty where that level is not an ancestor |
The `.ssp` writes the first three groups **space separated** and
`heading_ancestors_text` **`|` separated**. The empty slots of the last are
@@ -181,31 +181,31 @@ declaration line, or a database key.
Where the names differ they differ for a reason, the `.ssp` preferring the
short form and the database the explicit one:
-| `.ssp` property | database |
-|-----------------|----------|
-| `.parent` | `parent_ocn` |
+| `.ssp` property | database |
+|--------------------|-----------------------|
+| `.parent` | `parent_ocn` |
| `.last_descendant` | `last_descendant_ocn` |
-| `.dummy` | `dummy_heading` |
-| `.ocn_off` | `object_number_off` |
-| `.part` | `is_of_part` |
-| `.section` | `is_of_section` |
+| `.dummy` | `dummy_heading` |
+| `.ocn_off` | `object_number_off` |
+| `.part` | `is_of_part` |
+| `.section` | `is_of_section` |
Three are **expanded**, the `.ssp` folding what the database spreads:
-| `.ssp` property | database |
-|-----------------|----------|
-| `.indent: <base> <hang>` | `indent_base`, `indent_hang` |
-| `.ocn_range: <first> <last>` | `ocn_range_first`, `ocn_range_last` (2.1: `0` where the object is not a container; a 2.0 database has neither column, and reads as no range) |
-| `.has: links notes_reg notes_star images images_no_dim` | `has_links`, `has_notes_reg`, `has_notes_star`, `has_images`, `has_images_no_dim` |
+| `.ssp` property | database |
+|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| `.indent: <base> <hang>` | `indent_base`, `indent_hang` |
+| `.ocn_range: <first> <last>` | `ocn_range_first`, `ocn_range_last` (2.1: `0` where the object is not a container; a 2.0 database has neither column, and reads as no range) |
+| `.has: links notes_reg notes_star images images_no_dim` | `has_links`, `has_notes_reg`, `has_notes_star`, `has_images`, `has_images_no_dim` |
The four **repeatable** properties become the four child tables:
-| `.ssp` property | database |
-|-----------------|----------|
-| `.image` | `object_images` |
-| `.stow_link` | `object_links` |
-| `.anchor_tag` | `object_anchors` |
-| `.lev4_subtoc` | `object_subtoc` |
+| `.ssp` property | database |
+|-----------------|------------------|
+| `.image` | `object_images` |
+| `.stow_link` | `object_links` |
+| `.anchor_tag` | `object_anchors` |
+| `.lev4_subtoc` | `object_subtoc` |
And four columns come from outside the property list: `ocn`, `is_a` and
`heading_level` from the object declaration line, and `text` from its `|`
@@ -246,13 +246,13 @@ there.
## 5. The `files` table: what it carries, and how
-| role | named by | `compression` | `data` holds |
-|------|----------|---------------|--------------|
-| `image` | its bare filename | `none` | the file as read |
-| `source` | `media/text/<lang>/<file>` | `zstd` | a zstd frame |
-| `conf` | `conf/document_make` | `zstd` | a zstd frame |
-| `manifest` | `pod.manifest` | `zstd` | a zstd frame |
-| `tools` | `tools/po4a/...` | `zstd` | a zstd frame |
+| role | named by | `compression` | `data` holds |
+|------------|----------------------------|---------------|------------------|
+| `image` | its bare filename | `none` | the file as read |
+| `source` | `media/text/<lang>/<file>` | `zstd` | a zstd frame |
+| `conf` | `conf/document_make` | `zstd` | a zstd frame |
+| `manifest` | `pod.manifest` | `zstd` | a zstd frame |
+| `tools` | `tools/po4a/...` | `zstd` | a zstd frame |
The `compression` column carries the literal `none` or `zstd`, so a reader
need not infer it from the role.
@@ -291,11 +291,11 @@ SELECT role, count(*), sum(bytes) FROM files GROUP BY role;
### 6.2 The views
-| view | gives |
-|------|-------|
-| `outline` | the headings: lang, section, seq, ocn, both levels, `last_descendant_ocn`, identifier, text |
-| `citable` | every object with an ocn, ordered by ocn, language named |
-| `document_files` | what the file carries: role, name, bytes, sha256, pixel size |
+| view | gives |
+|------------------|---------------------------------------------------------------------------------------------|
+| `outline` | the headings: lang, section, seq, ocn, both levels, `last_descendant_ocn`, identifier, text |
+| `citable` | every object with an ocn, ordered by ocn, language named |
+| `document_files` | what the file carries: role, name, bytes, sha256, pixel size |
**`outline` and `citable` name the language and order by it first.** A view
over a file that may hold ten languages and does not say which would read as
diff --git a/ocda-model.md b/ocda-model.md
index 84e521a..1c173b1 100644
--- a/ocda-model.md
+++ b/ocda-model.md
@@ -6,9 +6,9 @@ of any file it is written to.
Two serialisations carry this model, and they carry **one version number
between them**, because neither may express what the other cannot:
-| | |
-|---|---|
-| [`ssp-format-specification.md`](ssp-format-specification.md) | the OCDA as text, `.ssp` |
+| | |
+|----------------------------------------------------------------------|--------------------------------|
+| [`ssp-format-specification.md`](ssp-format-specification.md) | the OCDA as text, `.ssp` |
| [`ocda-db-format-specification.md`](ocda-db-format-specification.md) | the OCDA as sqlite, `.ocda.db` |
This document is what they share. It describes objects; they describe
@@ -19,11 +19,11 @@ writing objects down.
The terms are used precisely in this repository and in spine, and the
distinction is worth holding:
-| level | term | names |
-|-------|------|-------|
-| the model | **OCDA** | what a document is once parsed: numbered objects with structure, identity and digests. Independent of any file, any stage, any tool |
-| the stage | **abstraction** | the middle of spine's **markup -> abstraction -> output**: the act of building the model, and the point at which a document may now enter the pipeline |
-| the serialisations | **`.ssp`**, **`.ocda.db`** | the model written down, as text and as sqlite |
+| level | term | names |
+|--------------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
+| the model | **OCDA** | what a document is once parsed: numbered objects with structure, identity and digests. Independent of any file, any stage, any tool |
+| the stage | **abstraction** | the middle of spine's **markup -> abstraction -> output**: the act of building the model, and the point at which a document may now enter the pipeline |
+| the serialisations | **`.ssp`**, **`.ocda.db`** | the model written down, as text and as sqlite |
A thing is named for the level it belongs to. Something true of the model
whatever file it is in takes *ocda*; something about the pipeline stage
@@ -55,33 +55,33 @@ An object is classified twice, and the two answer different questions.
**Kind** (`is_a`) says *what the object is*, one of sixteen. Each kind
belongs to one section, except `heading`, which appears in all nine:
-| kind | section | what it is | count |
-|------|---------|------------|-------|
-| `para` | body | a paragraph, the ordinary unit of a document | 41,885 |
-| `heading` | *all nine* | a heading at one of the eight levels | 3,503 |
-| `toc` | toc | an entry in the generated table of contents | 3,215 |
-| `bookindex` | bookindex | an entry in the generated book index | 3,034 |
-| `endnote` | endnotes | a note, gathered from where it was called | 2,159 |
-| `code` | body | a code block | 1,623 |
-| `bibliography` | bibliography | a bibliography entry | 585 |
-| `comment` | body | markup comment, carried and not rendered | 450 |
-| `verse` | body | one verse of a poem | 151 |
-| `glossary` | glossary | a glossary entry | 56 |
-| `quote` | body | a block quotation | 53 |
-| `poem` | body | a poem: the container of its verses, OCN `0`, cited as their range (section 5) | 48 |
-| `block` | body | a block of grouped text | 45 |
-| `table` | body | a table, with its columns described | 32 |
-| `blurb` | blurb | a blurb entry | 28 |
-| `group` | body | a group block | 16 |
+| kind | section | what it is | count |
+|----------------|--------------|--------------------------------------------------------------------------------|--------|
+| `para` | body | a paragraph, the ordinary unit of a document | 41,885 |
+| `heading` | *all nine* | a heading at one of the eight levels | 3,503 |
+| `toc` | toc | an entry in the generated table of contents | 3,215 |
+| `bookindex` | bookindex | an entry in the generated book index | 3,034 |
+| `endnote` | endnotes | a note, gathered from where it was called | 2,294 |
+| `code` | body | a code block | 1,623 |
+| `bibliography` | bibliography | a bibliography entry | 585 |
+| `comment` | body | markup comment, carried and not rendered | 450 |
+| `verse` | body | one verse of a poem | 151 |
+| `glossary` | glossary | a glossary entry | 56 |
+| `quote` | body | a block quotation | 53 |
+| `poem` | body | a poem: the container of its verses, OCN `0`, cited as their range (section 5) | 48 |
+| `block` | body | a block of grouped text | 45 |
+| `table` | body | a table, with its columns described | 32 |
+| `blurb` | blurb | a blurb entry | 28 |
+| `group` | body | a group block | 16 |
**Type** (`is_of_type`) says *how the object's text behaves*, and takes
only three values:
-| type | means | kinds |
-|------|-------|-------|
-| `para` | flowing text, wrapped as the output sees fit | `para`, `heading`, `toc`, `bookindex`, `endnote`, `bibliography`, `glossary`, `blurb` |
-| `block` | text whose line breaks are significant and must be kept | `code`, `verse`, `quote`, `poem`, `block`, `table`, `group` |
-| `comment` | not rendered | `comment` |
+| type | means | kinds |
+|-----------|---------------------------------------------------------|---------------------------------------------------------------------------------------|
+| `para` | flowing text, wrapped as the output sees fit | `para`, `heading`, `toc`, `bookindex`, `endnote`, `bibliography`, `glossary`, `blurb` |
+| `block` | text whose line breaks are significant and must be kept | `code`, `verse`, `quote`, `poem`, `block`, `table`, `group` |
+| `comment` | not rendered | `comment` |
The mapping from kind to type is fixed: every `code` object is of type
`block`, every `para` object of type `para`. **A renderer that has the type
@@ -136,16 +136,16 @@ wrote it down**; see section 9.
A document has **eight heading levels**, in two groups of four:
-| level | index | what it is |
-|-------|-------|------------|
-| `A` | 0 | the document title. Exactly one per document |
-| `B` | 1 | |
-| `C` | 2 | the title matter below it |
-| `D` | 3 | |
-| `1` | 4 | the top level of the document body |
-| `2` | 5 | |
-| `3` | 6 | below that |
-| `4` | 7 | |
+| level | index | what it is |
+|-------|-------|----------------------------------------------|
+| `A` | 0 | the document title. Exactly one per document |
+| `B` | 1 | |
+| `C` | 2 | the title matter below it |
+| `D` | 3 | |
+| `1` | 4 | the top level of the document body |
+| `2` | 5 | |
+| `3` | 6 | below that |
+| `4` | 7 | |
`A` to `D` are the title levels, `1` to `4` the body levels, and the index
is what the eight-slot arrays of section 5 are indexed by. A heading that
@@ -276,11 +276,11 @@ document.
So, on loading:
-| field | when absent | take |
-|-------|-------------|------|
-| identifier | OCN is non-zero | the OCN as text |
-| identifier | OCN is `0` | whatever the serialisation gave; there is nothing to derive from |
-| anchor | the object has a segment | the segment name |
+| field | when absent | take |
+|------------|--------------------------|------------------------------------------------------------------|
+| identifier | OCN is non-zero | the OCN as text |
+| identifier | OCN is `0` | whatever the serialisation gave; there is nothing to derive from |
+| anchor | the object has a segment | the segment name |
**This is a property of the model, not of either format**, which is why it
is stated here and not only in the two format specifications. It is stated
diff --git a/ssp-format-specification.md b/ssp-format-specification.md
index ed37638..5b8abc3 100644
--- a/ssp-format-specification.md
+++ b/ssp-format-specification.md
@@ -80,28 +80,28 @@ row, so that one bump moves both.
### 2.2 History
-| version | date | what moved |
-|---------|------------|------------|
-| 2.1 | 2026-09-29 | `.ocn_range`, the first and last ocn of what a container holds. A poem is a container of verses and is cited as their range: it now comes before its first verse, carries ocn `0` and no identifier, and states the range, where it had come after its last verse carrying that verse's ocn and identifier, so that one number named two objects. A minor bump: the property is an addition, the poem was never rendered and has no text, the verses are unchanged, and a 2.0 reader reads a 2.1 file. The same run gathers a note in a poem's last verse into the endnotes, which it had not been: one more endnote in the reference collection. |
-| 2.0 | 2026-09-18 | `source.digest` changes meaning: it covers every markup file the document is made of, where it had been the digest of the master file alone. A change of meaning, so the major part. |
-| 1.1 | 2026-09-10 | The `@source` block; the document metadata the output writers read, carried in full (14 `@meta` and 3 `@make` properties added); `.segment_lv4_is`. |
-| 0.1 | | The first form. |
+| version | date | what moved |
+|---------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 2.1 | 2026-09-29 | `.ocn_range`, the first and last ocn of what a container holds. A poem is a container of verses and is cited as their range: it now comes before its first verse, carries ocn `0` and no identifier, and states the range, where it had come after its last verse carrying that verse's ocn and identifier, so that one number named two objects. A minor bump: the property is an addition, the poem was never rendered and has no text, the verses are unchanged, and a 2.0 reader reads a 2.1 file. The same run gathers a note in a poem's last verse into the endnotes, which it had not been: one more endnote in the reference collection. And the editor's notes, `~[* ]~` and `~[+ ]~`, which spine had not recognised and passed through as text, are notes: a third form of note mark, a symbol and a number (`*1`, `+1`), each series numbered through the document; 135 more endnotes, 2,294 in all (section 3.2, "A note begins with its mark"). |
+| 2.0 | 2026-09-18 | `source.digest` changes meaning: it covers every markup file the document is made of, where it had been the digest of the master file alone. A change of meaning, so the major part. |
+| 1.1 | 2026-09-10 | The `@source` block; the document metadata the output writers read, carried in full (14 `@meta` and 3 `@make` properties added); `.segment_lv4_is`. |
+| 0.1 | | The first form. |
## 3. Lexical structure
Six line types, distinguished by their first character. Nothing else is a
valid line.
-| line | form | meaning |
-|------|------|---------|
-| comment | `% ...` | file header only (section 4) |
-| block open | `@name {` | opens a preamble block or a section |
-| block close | `}` | closes it |
-| key | ` key: value` | inside a preamble block, two spaces of indent |
-| object declaration | `[ocn] kind...` | opens an object record (section 6.1) |
-| property | `.name: value` | a property of the object just declared |
-| text | `\| text` | a line of the object's text |
-| blank | | separates records; carries no meaning |
+| line | form | meaning |
+|--------------------|-----------------|-----------------------------------------------|
+| comment | `% ...` | file header only (section 4) |
+| block open | `@name {` | opens a preamble block or a section |
+| block close | `}` | closes it |
+| key | ` key: value` | inside a preamble block, two spaces of indent |
+| object declaration | `[ocn] kind...` | opens an object record (section 6.1) |
+| property | `.name: value` | a property of the object just declared |
+| text | `\| text` | a line of the object's text |
+| blank | | separates records; carries no meaning |
A value runs to the **end of the line**. It is not quoted, and it is not
trimmed beyond the single space after the colon. A value may therefore
@@ -139,31 +139,46 @@ Counts are occurrences in object text across the 36 document reference
collection, which distinguishes what a reader will certainly meet from what
it may not.
-| marker | means | count | where |
-|--------|-------|-------|-------|
-| `░` | non-breaking space | 23,048 | |
-| `┥` `┝` | link text, open and close | 20,290 | |
-| `┤` `├` | link target, open and close | 20,290 | |
-| `⑆` | a page number of the source edition follows | 19,099 | |
-| `┨` `┣` | that page number, open and close | 19,099 | |
-| `■` | monospace | 10,688 | |
-| `【` `】` | an inline note | 2,159 | |
-| `¤` | an internal site link | 2,157 | |
-| `┊` | table cell separator | 695 | `table` objects only |
-| `┙` | line break, inline | 184 | |
-| `☼` | an image, in a link's text slot | 63 | |
-| `┚` | line break, spaced | 50 | `group` objects only |
-| `〖` `〗` | a starred note | 0 | |
-| `‖` | a citation | 0 | |
-| `┘` | line break, plain | 0 | |
-| `┼` `┿` `╂` | page break: line, page, new page | 0 | |
-| `┏` `┆` | table open, table paragraph | 0 | |
-| `␣` | separator | 0 | |
+| marker | means | count | where |
+|-------------|---------------------------------------------|--------|----------------------|
+| `░` | non-breaking space | 23,048 | |
+| `┥` `┝` | link text, open and close | 20,290 | |
+| `┤` `├` | link target, open and close | 20,290 | |
+| `⑆` | a page number of the source edition follows | 19,099 | |
+| `┨` `┣` | that page number, open and close | 19,099 | |
+| `■` | monospace | 10,688 | |
+| `【` `】` | an inline note, its mark first (below) | 2,294 | |
+| `¤` | an internal site link | 2,157 | |
+| `┊` | table cell separator | 695 | `table` objects only |
+| `┙` | line break, inline | 184 | |
+| `☼` | an image, in a link's text slot | 63 | |
+| `┚` | line break, spaced | 50 | `group` objects only |
+| `〖` `〗` | a starred note | 0 | |
+| `‖` | a citation | 0 | |
+| `┘` | line break, plain | 0 | |
+| `┼` `┿` `╂` | page break: line, page, new page | 0 | |
+| `┏` `┆` | table open, table paragraph | 0 | |
+| `␣` | separator | 0 | |
**A count of 0 means the reference collection does not exercise it, not
that it cannot appear.** All of these are defined by the emitter and a
reader must be prepared for them.
+**A note begins with its mark**, then whitespace, then the note: `【12 text】`.
+The mark is one of three forms, and a reader must take all three:
+
+| mark | what | example |
+|------|------|---------|
+| digits | the author's notes, numbered through the document | `【12 ...】` |
+| `*` or `+`, repeated | a special note, marked by the symbols alone | `【** ...】` |
+| `*` or `+`, then digits | an editor's note (2.1): the markup's `~[* ]~` and `~[+ ]~`, each series numbered through the document apart from the author's | `【*3 ...】`, `【+1 ...】` |
+
+So the pattern is `【(\d+|[*+]+[0-9]*)\s`. Before 2.1 the third form did not
+occur: spine did not recognise the editor's-note markup, and it came through
+as text, `~[* ...]~` and all. Each note of every form is gathered into the
+`endnotes` section, where its `.anchor_tag` is `note_` and the mark
+(`note_12`, `note_*3`).
+
Two traps in this table, both found by counting rather than by reading:
**`┚` is defined twice**, as the spaced line break and as the table close.
@@ -232,11 +247,11 @@ are noted below.
### 5.1 `@source` - what this abstraction was made from
-| key | always? | meaning |
-|-----|---------|---------|
-| `language` | yes | the language of *this* file |
-| `languages` | when the pod declares them | every language of the document, space separated |
-| `digest` | yes | sha256 over **every markup file the document is made of**, in a fixed order |
+| key | always? | meaning |
+|-------------|----------------------------|-----------------------------------------------------------------------------|
+| `language` | yes | the language of *this* file |
+| `languages` | when the pod declares them | every language of the document, space separated |
+| `digest` | yes | sha256 over **every markup file the document is made of**, in a fixed order |
The source *filename* is not repeated here; it is on the `% Source:` line.
@@ -251,32 +266,32 @@ Dublin-Core shaped, `group.name`. **43 keys are defined**; a given document
carries only those it has. The 28 the reference collection exercises are
marked; the remainder are defined and simply unused by these documents.
-| group | keys |
-|-------|------|
-| `title.` | `main`*, `subtitle`*, `full`*, `language`*, `edition`* |
-| `creator.` | `author`*, `author_surname`*, `author_surname_fn`*, `author_email`*, `illustrator`*, `translator`* |
-| `date.` | `published`*, `created`*, `issued`*, `available`*, `modified`*, `valid`*, `added_to_site`* |
-| `rights.` | `copyright`*, `license`*, `copyright_text`, `copyright_translation`, `copyright_illustrations`, `copyright_photographs`, `copyright_cover`, `copyright_audio`, `copyright_video` |
-| `classify.` | `topic_register`*, `subject`, `keywords`, `loc`*, `dewey`* |
-| `identifier.` | `isbn`, `oclc` |
-| `notes.` | `summary`*, `abstract`*, `description`* |
-| `original.` | `source`*, `title`, `language`, `language_char` |
-| `language.` | `document_char`*, `document` |
+| group | keys |
+|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `title.` | `main`*, `subtitle`*, `full`*, `language`*, `edition`* |
+| `creator.` | `author`*, `author_surname`*, `author_surname_fn`*, `author_email`*, `illustrator`*, `translator`* |
+| `date.` | `published`*, `created`*, `issued`*, `available`*, `modified`*, `valid`*, `added_to_site`* |
+| `rights.` | `copyright`*, `license`*, `copyright_text`, `copyright_translation`, `copyright_illustrations`, `copyright_photographs`, `copyright_cover`, `copyright_audio`, `copyright_video` |
+| `classify.` | `topic_register`*, `subject`, `keywords`, `loc`*, `dewey`* |
+| `identifier.` | `isbn`, `oclc` |
+| `notes.` | `summary`*, `abstract`*, `description`* |
+| `original.` | `source`*, `title`, `language`, `language_char` |
+| `language.` | `document_char`*, `document` |
`classify.topic_register` is structured within its value: topics separated
by `;`, levels within a topic by `:`, and alternatives at a level by `|`.
### 5.3 `@make` - how the document is to be built
-| key | value | meaning |
-|-----|-------|---------|
-| `doc_type` | `article`, `book` | what kind of document this is |
-| `auto_num_top_at_level` | a level, e.g. `1` | the heading level automatic numbering starts at, **as written in the markup** |
-| `auto_num_top_lv` | that level's index, 0..8 | the same level as a number (section 4 of [`ocda-model.md`](ocda-model.md)); `9` where numbering is off |
-| `auto_num_depth` | e.g. `2` | how many levels down numbering continues |
-| `breaks` | see below | where the output starts a new page, and where it breaks one |
-| `footer` | slots joined with `\|` | the footer, each slot carrying link markup |
-| `home_button_text` | link markup | the home link, as internal markup |
+| key | value | meaning |
+|-------------------------|--------------------------|--------------------------------------------------------------------------------------------------------|
+| `doc_type` | `article`, `book` | what kind of document this is |
+| `auto_num_top_at_level` | a level, e.g. `1` | the heading level automatic numbering starts at, **as written in the markup** |
+| `auto_num_top_lv` | that level's index, 0..8 | the same level as a number (section 4 of [`ocda-model.md`](ocda-model.md)); `9` where numbering is off |
+| `auto_num_depth` | e.g. `2` | how many levels down numbering continues |
+| `breaks` | see below | where the output starts a new page, and where it breaks one |
+| `footer` | slots joined with `\|` | the footer, each slot carrying link markup |
+| `home_button_text` | link markup | the home link, as internal markup |
`auto_num_top_at_level` and `auto_num_top_lv` are **the same value twice**,
as the markup wrote it and as an index: `1` and `4`, since the body levels
@@ -383,51 +398,51 @@ In the table, "emitted when" is the condition under which the property
appears at all. Counts are occurrences across the 36 document reference
set, as a guide to which parts of the format are load bearing.
-| # | property | value | emitted when | count |
-|---|----------|-------|--------------|-------|
-| 1 | `.identifier` | string | a non-heading has an identifier that is not its ocn (**otherwise it is the ocn**: model section 9) | 353 |
-| 2 | `.part` | string | the object belongs to a part (`frontmatter`, `body`, ...) | 56,883 |
-| 3 | `.section` | string | the object's own section differs from the block it sits in | 605 |
-| 4 | `.parent` | int | **every object except** the document root and `toc` entries | 53,632 |
-| 5 | `.last_descendant` | int | non-zero: the last ocn under this heading | 3,202 |
-| 6 | `.ocn_range` | 2 ints | the object is a container: the first and last ocn of what it holds (2.1; a poem, model section 5) | 48 |
-| 7 | `.children` | ints | the heading has child headings | 827 |
-| 8 | `.ancestors` | 8 ints | any is non-zero | 53,596 |
-| 9 | `.ancestors_collapsed` | 8 ints | any is non-zero | 53,596 |
-| 10 | `.dom_status` | 8 ints | any is non-zero | 3,319 |
-| 11 | `.dom_status_collapsed` | 8 ints | any is non-zero | 3,319 |
-| 12 | `.heading_lev_collapsed` | int | it is below 9 | 3,503 |
-| 13 | `.parent_lev` | int | non-zero | 52,849 |
-| 14 | `.dummy` | `true` | the heading was introduced to segment an output | 183 |
-| 15 | `.ocn_off` | `true` | the object has no citation number | 7,543 |
-| 16 | `.is_of_type` | string | always, in practice | 56,883 |
-| 17 | `.attrib` | string | set | 1 |
-| 18 | `.meta_lang` | string | the object carries its own language | 0 |
-| 19 | `.meta_syntax` | string | the object carries its own markup syntax | 0 |
-| 20 | `.sha256` | hex | the object's text digest is non-zero | 51,253 |
-| 21 | `.image` | record | once **per image**, in order of appearance | 63 |
-| 22 | `.indent` | 2 ints | either indent is non-zero: `base hang` | 7,583 |
-| 23 | `.bullet` | `true` | the object is a bullet item | 1,903 |
-| 24 | `.lang` | string | the text attributes carry a language | 0 |
-| 25 | `.has` | flags | any is set | 11,144 |
-| 26 | `.table_cols` | int | the object is a table with columns | 32 |
-| 27 | `.table_widths` | ints | the table has column widths | 32 |
-| 28 | `.table_aligns` | letters | the table has alignments (`l` `c` `r`) | 32 |
-| 29 | `.table_header` | `true` | the table has a header row | 29 |
-| 30 | `.code_linenumbers` | `true` | the code block is numbered | 1 |
-| 31 | `.stow_link` | url | once **per extracted link** | 1,013 |
-| 32 | `.segment` | string | the heading opens a segment | 3,355 |
-| 33 | `.anchor` | string | the anchor differs from the segment name (**otherwise it is the segment name**: model section 9) | 68 |
-| 34 | `.segment_prev` | string | there is a previous segment | 1,022 |
-| 35 | `.segment_next` | string | there is a next segment | 1,022 |
-| 36 | `.heading_lev_anchor` | string | the heading has a level anchor tag | 1,854 |
-| 37 | `.segment_epub` | string | the heading opens an epub segment | 3,355 |
-| 38 | `.segment_html_is` | string | the object is inside an html segment | 47,071 |
-| 39 | `.segment_epub_is` | string | the object is inside an epub segment | 47,072 |
-| 40 | `.segment_lv4_is` | string | **and** it differs from `.segment_html_is` | 342 |
-| 41 | `.heading_ancestors_text` | 8 slots, `\|` joined, escaped | any slot is non-empty | 3,319 |
-| 42 | `.lev4_subtoc` | string | once **per sub-table-of-contents entry** | 1,887 |
-| 43 | `.anchor_tag` | string | once **per anchor tag** | 7,884 |
+| # | property | value | emitted when | count |
+|----|---------------------------|-------------------------------|----------------------------------------------------------------------------------------------------|--------|
+| 1 | `.identifier` | string | a non-heading has an identifier that is not its ocn (**otherwise it is the ocn**: model section 9) | 353 |
+| 2 | `.part` | string | the object belongs to a part (`frontmatter`, `body`, ...) | 57,018 |
+| 3 | `.section` | string | the object's own section differs from the block it sits in | 605 |
+| 4 | `.parent` | int | **every object except** the document root and `toc` entries | 53,767 |
+| 5 | `.last_descendant` | int | non-zero: the last ocn under this heading | 3,202 |
+| 6 | `.ocn_range` | 2 ints | the object is a container: the first and last ocn of what it holds (2.1; a poem, model section 5) | 48 |
+| 7 | `.children` | ints | the heading has child headings | 827 |
+| 8 | `.ancestors` | 8 ints | any is non-zero | 53,731 |
+| 9 | `.ancestors_collapsed` | 8 ints | any is non-zero | 53,731 |
+| 10 | `.dom_status` | 8 ints | any is non-zero | 3,319 |
+| 11 | `.dom_status_collapsed` | 8 ints | any is non-zero | 3,319 |
+| 12 | `.heading_lev_collapsed` | int | it is below 9 | 3,503 |
+| 13 | `.parent_lev` | int | non-zero | 52,984 |
+| 14 | `.dummy` | `true` | the heading was introduced to segment an output | 183 |
+| 15 | `.ocn_off` | `true` | the object has no citation number | 7,543 |
+| 16 | `.is_of_type` | string | always, in practice | 57,018 |
+| 17 | `.attrib` | string | set | 1 |
+| 18 | `.meta_lang` | string | the object carries its own language | 0 |
+| 19 | `.meta_syntax` | string | the object carries its own markup syntax | 0 |
+| 20 | `.sha256` | hex | the object's text digest is non-zero | 51,253 |
+| 21 | `.image` | record | once **per image**, in order of appearance | 63 |
+| 22 | `.indent` | 2 ints | either indent is non-zero: `base hang` | 7,583 |
+| 23 | `.bullet` | `true` | the object is a bullet item | 1,903 |
+| 24 | `.lang` | string | the text attributes carry a language | 0 |
+| 25 | `.has` | flags | any is set | 11,384 |
+| 26 | `.table_cols` | int | the object is a table with columns | 32 |
+| 27 | `.table_widths` | ints | the table has column widths | 32 |
+| 28 | `.table_aligns` | letters | the table has alignments (`l` `c` `r`) | 32 |
+| 29 | `.table_header` | `true` | the table has a header row | 29 |
+| 30 | `.code_linenumbers` | `true` | the code block is numbered | 1 |
+| 31 | `.stow_link` | url | once **per extracted link** | 1,014 |
+| 32 | `.segment` | string | the heading opens a segment | 3,355 |
+| 33 | `.anchor` | string | the anchor differs from the segment name (**otherwise it is the segment name**: model section 9) | 68 |
+| 34 | `.segment_prev` | string | there is a previous segment | 1,022 |
+| 35 | `.segment_next` | string | there is a next segment | 1,022 |
+| 36 | `.heading_lev_anchor` | string | the heading has a level anchor tag | 1,854 |
+| 37 | `.segment_epub` | string | the heading opens an epub segment | 3,355 |
+| 38 | `.segment_html_is` | string | the object is inside an html segment | 47,072 |
+| 39 | `.segment_epub_is` | string | the object is inside an epub segment | 47,072 |
+| 40 | `.segment_lv4_is` | string | **and** it differs from `.segment_html_is` | 342 |
+| 41 | `.heading_ancestors_text` | 8 slots, `\|` joined, escaped | any slot is non-empty | 3,319 |
+| 42 | `.lev4_subtoc` | string | once **per sub-table-of-contents entry** | 1,887 |
+| 43 | `.anchor_tag` | string | once **per anchor tag** | 8,019 |
Three of these need a word here, the first two because the model behind
them is easy to misread (see [`ocda-model.md`](ocda-model.md) sections 5