diff options
| author | Ralph Amissah <ralph.amissah@gmail.com> | 2026-09-24 11:40:02 -0400 |
|---|---|---|
| committer | Ralph Amissah <ralph.amissah@gmail.com> | 2026-09-24 11:40:02 -0400 |
| commit | 5556b2e14d3c3df5d74e669f7d542b0e526cd216 (patch) | |
| tree | 6f7a98f366220a3eb29ee9dcff6eaad7f92dade6 /README.md | |
| parent | format 2.0: the version gate (diff) | |
dealing with six properties including .is_of_type
--report-unknown, added in the previous commit, found a defect on its
first run (rather than a gap): .is_of_type was among the properties
being ignored, and it is the property that says whether an object is
rendered at all.
An object of type "comment" is markup commentary. The abstraction
carries it so that nothing of the source is lost, and no output puts
it in the document. This reader was putting it in three of four:
a comment appeared in the HTML scroll, in the breadcrumbed plain
text, and as an embedding chunk in the JSONL, where it would be
indexed as though the author had written it into the document.
Spine's own HTML for the same document has none.
The decision now lives in one place, SspObject.renders(), and the
three outputs ask it.
Five more properties parsed while here: .section, which is an
object's own section when it differs from the block it sits in;
.identifier, which a non-heading carries when it has one that is not
its ocn, and which now fills the same field a heading fills from its
declaration line; .segment_html_is; .table_aligns, which completes
the table set beside cols, widths and header; and .stow_link, which
is repeatable and accumulates.
That leaves twelve properties ignored across the markup document
samples, down from eighteen, and each for a reason now written
into the README: level bookkeeping this reader does not need, naming
for segmented HTML and EPUB output it does not produce, and .attrib
at one occurrence in all the samples.
(assisted by Claude-Code)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -97,6 +97,24 @@ read and NOT understood: ... ``` +### What it ignores, and why + +Twelve properties are ignored across the reference collection, and each is +ignored for a reason rather than by oversight: + +| ignored | why | +|---------|-----| +| `.ancestors_collapsed`, `.parent_lev`, `.heading_lev_collapsed`, `.dom_status`, `.dom_status_collapsed` | level bookkeeping; this reader works from `.ancestors` and the heading level | +| `.segment_epub`, `.segment_epub_is`, `.segment_lv4_is`, `.heading_lev_anchor`, `.anchor_tag`, `.lev4_subtoc` | naming for segmented HTML and EPUB output, which this reader does not produce | +| `.attrib` | one occurrence in the whole collection, and no output uses it | + +The list was longer. `--report-unknown` found that `.is_of_type` was +ignored, and **that was a defect**: objects of type `comment` are markup +commentary, carried by the abstraction and not put into output, and three +of the four outputs were rendering them. A markup comment was appearing in +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/doc-abstraction-format): a reader that drops what it does not know is conforming, but one that |
