diff options
Diffstat (limited to 'org')
| -rw-r--r-- | org/COPYRIGHT | 48 | ||||
| -rw-r--r-- | org/ocda_specification.org | 337 | ||||
| -rw-r--r-- | org/sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org | 260 |
3 files changed, 545 insertions, 100 deletions
diff --git a/org/COPYRIGHT b/org/COPYRIGHT new file mode 100644 index 0000000..ee0bc25 --- /dev/null +++ b/org/COPYRIGHT @@ -0,0 +1,48 @@ +- Name: spine - SiSU Spine, Doc Reform + - Description: documents, structuring, processing, publishing, search + - static content generator + + - Author: Ralph Amissah + [ralph.amissah@gmail.com] + + - Copyright: (C) 2015 - 2026 Ralph Amissah + + - code under src/* src/sisudoc/* + - License: AGPL 3 or later: + + Spine, Doc Reform (SiSU), a framework for document structuring, publishing and + search + + Copyright (C) Ralph Amissah + + This program is free software: you can redistribute it and/or modify it + under the terms of the GNU AFERO General Public License as published by + the Free Software Foundation, either version 3 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License along + with this program. If not, see [https://www.gnu.org/licenses/]. + + If you have Internet connection, the latest version of the AGPL should be + available at these locations: + [https://www.fsf.org/licensing/licenses/agpl.html] + [https://www.gnu.org/licenses/agpl.html] + + - Spine, Doc Reform (related to SiSU) uses standard: + - docReform markup syntax (based on SiSU markup) + - standard SiSU markup syntax with modified headers and minor + modifications + - docReform object numbering (based on SiSU object citation numbering) + - standard SiSU document object numbering + + - Homepages: + [https://www.sisudoc.org] + +- Spine, Doc Reform (SiSU) markup samples + Individual document content Copyright (Author) [as stated in document header] + Individual document content License (Author) [as stated in document header] diff --git a/org/ocda_specification.org b/org/ocda_specification.org index c1737b1..10fd6a4 100644 --- a/org/ocda_specification.org +++ b/org/ocda_specification.org @@ -51,15 +51,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 @@ -104,7 +105,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 @@ -164,7 +166,7 @@ project. for the .sst / .ssm markup spine reads before writing a .ssp. #+END_SRC -** .gitignore :gitignore: +** git .gitignore :gitignore: #+HEADER: :tangle "../.gitignore" #+BEGIN_SRC gitignore @@ -176,6 +178,7 @@ project. !*.ssp !org/ !**/*.org +!**/COPYRIGHT #+END_SRC ** ocda-model.md @@ -239,24 +242,24 @@ 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,158 | -| `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, holding verses | 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: @@ -291,9 +294,12 @@ otherwise: document reference collection. - **`0` is therefore not an identity.** Objects sharing `0` are not the same object, and `0` must never be used as a key. -- **An OCN is not unique within a document even when non-zero.** A poem and - its verses share one; `through_the_looking_glass` has 21 such cases. Key - on position within a section when one row is wanted. +- **A non-zero OCN is unique within a document**, from format 2.1: checked + over the reference collection, no non-zero OCN occurs twice in any of the + 36 document-languages. **Before 2.1 it was not**: a poem carried the OCN of + its last verse, so the same number named two objects (48 such pairs in the + collection, 21 in `through_the_looking_glass`). A reader of an older + artefact keys on position within a section when one row is wanted. ### 3.1 The identifier @@ -365,6 +371,16 @@ be flat and the model be walked in either direction. - **`last_descendant`** - the last OCN under a heading, which makes a subtree a **range** rather than a traversal: everything from the heading's OCN to its last descendant is inside it. +- **`ocn_range`** - for a **container**, the first and last OCN of what it + holds (2.1). A poem is the one container: its verses are the citable + units, one object each, and the poem is not; it carries OCN `0` and no + identifier, **comes immediately before its first verse**, and is cited as + the range of them (`173-180`). So a writer that meets a poem knows what + follows and where it ends, and can wrap the verses in one pass. The poem + has no text of its own. `0 0`, or absent, where the object is not a + container. + **Before 2.1** the poem came *after* its last verse, carried that verse's + OCN and identifier, and stated no range. ## 6. Sections @@ -447,11 +463,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 @@ -483,7 +499,7 @@ been written down first. # The `.ssp` format ,**The object-centric document abstraction, written as text. Format version -2.0**, as spine 0.25.0 emits and reads it. +2.1**, as spine emits and reads it after 0.25.1. This document specifies *one serialisation*. The model it serialises is specified in [`ocda-model.md`](ocda-model.md), which the sqlite @@ -545,7 +561,7 @@ by reading a `.ssp` back, so it can hold nothing this format cannot express. The version is declared **in band**, on the first line of every file: ``` -% SiSU Document Abstraction v2.0 +% SiSU Document Abstraction v2.1 ``` and by the sibling sqlite serialisation in its `schema.version` metadata @@ -562,11 +578,12 @@ row, so that one bump moves both. ### 2.2 History -| version | date | what moved | -|---------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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 @@ -628,7 +645,7 @@ it may not. | `⑆` | 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 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 | | @@ -645,6 +662,21 @@ it may 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. @@ -675,7 +707,7 @@ are part of the format. In order, and this order is fixed: ``` -% SiSU Document Abstraction v2.0 +% SiSU Document Abstraction v2.1 % Source: <markup filename> @source { ... } @@ -867,47 +899,48 @@ 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,882 | +| 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,631 | +| 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 | `.children` | ints | the heading has child headings | 827 | -| 7 | `.ancestors` | 8 ints | any is non-zero | 53,595 | -| 8 | `.ancestors_collapsed` | 8 ints | any is non-zero | 53,595 | -| 9 | `.dom_status` | 8 ints | any is non-zero | 3,319 | -| 10 | `.dom_status_collapsed` | 8 ints | any is non-zero | 3,319 | -| 11 | `.heading_lev_collapsed` | int | it is below 9 | 3,503 | -| 12 | `.parent_lev` | int | non-zero | 52,848 | -| 13 | `.dummy` | `true` | the heading was introduced to segment an output | 183 | -| 14 | `.ocn_off` | `true` | the object has no citation number | 7,543 | -| 15 | `.is_of_type` | string | always, in practice | 56,882 | -| 16 | `.attrib` | string | set | 1 | -| 17 | `.meta_lang` | string | the object carries its own language | 0 | -| 18 | `.meta_syntax` | string | the object carries its own markup syntax | 0 | -| 19 | `.sha256` | hex | the object's text digest is non-zero | 51,253 | -| 20 | `.image` | record | once **per image**, in order of appearance | 63 | -| 21 | `.indent` | 2 ints | either indent is non-zero: `base hang` | 7,583 | -| 22 | `.bullet` | `true` | the object is a bullet item | 1,903 | -| 23 | `.lang` | string | the text attributes carry a language | 0 | -| 24 | `.has` | flags | any is set | 11,143 | -| 25 | `.table_cols` | int | the object is a table with columns | 32 | -| 26 | `.table_widths` | ints | the table has column widths | 32 | -| 27 | `.table_aligns` | letters | the table has alignments (`l` `c` `r`) | 32 | -| 28 | `.table_header` | `true` | the table has a header row | 29 | -| 29 | `.code_linenumbers` | `true` | the code block is numbered | 1 | -| 30 | `.stow_link` | url | once **per extracted link** | 1,013 | -| 31 | `.segment` | string | the heading opens a segment | 3,355 | -| 32 | `.anchor` | string | the anchor differs from the segment name (**otherwise it is the segment name**: model section 9) | 68 | -| 33 | `.segment_prev` | string | there is a previous segment | 1,022 | -| 34 | `.segment_next` | string | there is a next segment | 1,022 | -| 35 | `.heading_lev_anchor` | string | the heading has a level anchor tag | 1,854 | -| 36 | `.segment_epub` | string | the heading opens an epub segment | 3,355 | -| 37 | `.segment_html_is` | string | the object is inside an html segment | 47,024 | -| 38 | `.segment_epub_is` | string | the object is inside an epub segment | 47,024 | -| 39 | `.segment_lv4_is` | string | **and** it differs from `.segment_html_is` | 342 | -| 40 | `.heading_ancestors_text` | 8 slots, `\|` joined, escaped | any slot is non-empty | 3,319 | -| 41 | `.lev4_subtoc` | string | once **per sub-table-of-contents entry** | 1,887 | -| 42 | `.anchor_tag` | string | once **per anchor tag** | 7,883 | +| 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 @@ -1067,7 +1100,7 @@ Each carries, in its opening comments, the command that regenerates it. # The `.ocda.db` format ,**The object-centric document abstraction, written as sqlite. Format -version 2.0**, as spine 0.25.0 emits and reads it. +version 2.1**, as spine emits and reads it after 0.25.1. This document specifies *one serialisation*. The model it serialises is specified in [`ocda-model.md`](ocda-model.md), which the text serialisation @@ -1115,7 +1148,7 @@ Declared in band, in the `metadata` table: SELECT key, value FROM metadata WHERE doc_id IS NULL; -- build.spine_version | 0.25.0 -- schema.name | sisu-abstraction-db --- schema.version | 2.0 +-- schema.version | 2.1 ``` The rule is the model's, and identical to the `.ssp`: the minor part is @@ -1173,12 +1206,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 @@ -1216,12 +1249,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 @@ -1256,12 +1289,13 @@ short form and the database the explicit one: | `.part` | `is_of_part` | | `.section` | `is_of_section` | -Two are **expanded**, the `.ssp` folding what the database spreads: +Three are **expanded**, the `.ssp` folding what the database spreads: -| `.ssp` property | database | -|---------------------------------------------------------|-----------------------------------------------------------------------------------| -| `.indent: <base> <hang>` | `indent_base`, `indent_hang` | -| `.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: @@ -1276,8 +1310,9 @@ And four columns come from outside the property list: `ocn`, `is_a` and `heading_level` from the object declaration line, and `text` from its `|` lines. `id`, `doc_id` and `seq` are the database's own keys; `seq` is the object's position within its section, and `(doc_id, section, seq)` is what -identifies an object when `ocn` will not (see -[`ocda-model.md`](ocda-model.md) section 3). +identifies an object when `ocn` will not: `0`, or, before 2.1, a poem +sharing its last verse's number (see [`ocda-model.md`](ocda-model.md) +section 3). ### 4.1 Where the two are not symmetric @@ -1465,3 +1500,105 @@ understand, for the reason given in A writer **must** keep `bytes` and `sha256` those of the original file whatever `compression` says, and **must not** compress `objects.text`. #+END_SRC + +* COPYRIGHT & LICENSE +** notices +*** project (project root) ./ + +#+HEADER: :tangle "../COPYRIGHT" +#+HEADER: :noweb yes +#+BEGIN_SRC org +- Name: spine - SiSU Spine, Doc Reform + <<sisudoc_spine_copyright>> + + <<sisudoc_spine_license_agpl3>> + + <<sisudoc_spine_summary>> + +<<sisudoc_spine_markup_samples>> +#+END_SRC + +*** code org ./org + +- .org literate programming: + - copyright asserted + - omitted + - license + - dependency information + +#+HEADER: :tangle "../org/COPYRIGHT" +#+HEADER: :noweb yes +#+BEGIN_SRC text +- Name: spine - SiSU Spine, Doc Reform + <<sisudoc_spine_copyright>> + + <<sisudoc_spine_license_agpl3>> + + <<sisudoc_spine_summary>> + +<<sisudoc_spine_markup_samples>> +#+END_SRC + +** incorporate +*** copyright + +#+NAME: sisudoc_spine_copyright +#+BEGIN_SRC emacs-lisp +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:sisudoc_spine_copyright()>> +#+END_SRC + +*** agpl3 + +#+NAME: sisudoc_spine_license_agpl3 +#+BEGIN_SRC emacs-lisp +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:sisudoc_spine_license_agpl3()>> +#+END_SRC + +*** spine_summary + +#+NAME: sisudoc_spine_summary +#+BEGIN_SRC emacs-lisp +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:sisudoc_spine_summary()>> +#+END_SRC + +*** markup_samples + +#+NAME: sisudoc_spine_markup_samples +#+BEGIN_SRC emacs-lisp +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:sisudoc_spine_markup_samples()>> +#+END_SRC + +* org includes +** project version + +#+NAME: spine_version +#+HEADER: :noweb yes +#+BEGIN_SRC emacs-lisp +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> +#+END_SRC + +** year + +#+NAME: year +#+HEADER: :noweb yes +#+BEGIN_SRC emacs-lisp +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:year()>> +#+END_SRC + +** document header including copyright & license + +#+NAME: doc_header_including_copyright_and_license +#+HEADER: :noweb yes +#+BEGIN_SRC emacs-lisp +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +#+END_SRC + +* nixpkgs source + +#+NAME: nixpkgs_unstable +#+HEADER: :noweb yes +#+BEGIN_SRC emacs-lisp +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:nixpkgs_unstable()>> +#+END_SRC + +* __END__ diff --git a/org/sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org b/org/sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org new file mode 100644 index 0000000..a474009 --- /dev/null +++ b/org/sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org @@ -0,0 +1,260 @@ +-*- mode: org -*- +#+TITLE: sisudoc spine (doc_reform) object-centric document abstraction +#+DESCRIPTION: documents - structuring, publishing in multiple formats & search +#+FILETAGS: :spine:abstraction: +#+AUTHOR: Ralph Amissah +#+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] +#+COPYRIGHT: Copyright (C) 2015 (continuously updated, current 2026) Ralph Amissah +#+LANGUAGE: en +#+STARTUP: content hideblocks hidestars noindent entitiespretty +#+PROPERTY: header-args+ :eval never-export :exports code +#+PROPERTY: header-args+ :noweb yes :padline no +#+PROPERTY: header-args+ :results silent :cache no +#+PROPERTY: header-args+ :mkdirp yes +#+OPTIONS: H:3 num:nil toc:t \n:t ::t |:t ^:nil -:t f:t *:t + +- [[./doc-reform.org][doc-reform.org]] [[./][org/]] + +* spine doc header including copyright & license + +#+NAME: spine_doc_header_including_copyright_and_license +#+BEGIN_SRC org +/+ +- Name: SisuDoc Spine, Doc Reform [a part of] + - Description: documents, structuring, processing, publishing, search + - static content generator + + - Author: Ralph Amissah + [ralph.amissah@gmail.com] + + - Copyright: (C) 2015 (continuously updated, current 2026) Ralph Amissah, All Rights Reserved. + + - License: AGPL 3 or later: + + Spine (SiSU), a framework for document structuring, publishing and + search + + Copyright (C) Ralph Amissah + + This program is free software: you can redistribute it and/or modify it + under the terms of the GNU AFERO General Public License as published by the + Free Software Foundation, either version 3 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along with + this program. If not, see [https://www.gnu.org/licenses/]. + + If you have Internet connection, the latest version of the AGPL should be + available at these locations: + [https://www.fsf.org/licensing/licenses/agpl.html] + [https://www.gnu.org/licenses/agpl.html] + + - Spine (by Doc Reform, related to SiSU) uses standard: + - docReform markup syntax + - standard SiSU markup syntax with modified headers and minor modifications + - docReform object numbering + - standard SiSU object citation numbering & system + + - Homepages: + [https://www.sisudoc.org] + [https://www.doc-reform.org] + + - Git + [https://git.sisudoc.org/] + ++/ +#+END_SRC + +** incorporate +*** copyright + +#+NAME: sisudoc_spine_copyright +#+BEGIN_SRC org +- Description: documents, structuring, processing, publishing, search + - static content generator + +- Author: Ralph Amissah + [ralph.amissah@gmail.com] + +- Copyright: (C) 2015 - 2026 Ralph Amissah +#+END_SRC + +*** license +**** AGPLv3 + +#+NAME: sisudoc_spine_license_agpl3 +#+BEGIN_SRC org +- code under src/* src/sisudoc/* + - License: AGPL 3 or later: + + Spine, Doc Reform (SiSU), a framework for document structuring, publishing and + search + + Copyright (C) Ralph Amissah + + This program is free software: you can redistribute it and/or modify it + under the terms of the GNU AFERO General Public License as published by + the Free Software Foundation, either version 3 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License along + with this program. If not, see [https://www.gnu.org/licenses/]. + + If you have Internet connection, the latest version of the AGPL should be + available at these locations: + [https://www.fsf.org/licensing/licenses/agpl.html] + [https://www.gnu.org/licenses/agpl.html] +#+END_SRC + +*** spine_summary + +#+NAME: sisudoc_spine_summary +#+BEGIN_SRC org +- Spine, Doc Reform (related to SiSU) uses standard: + - docReform markup syntax (based on SiSU markup) + - standard SiSU markup syntax with modified headers and minor + modifications + - docReform object numbering (based on SiSU object citation numbering) + - standard SiSU document object numbering + +- Homepages: + [https://www.sisudoc.org] +#+END_SRC + +#+BEGIN_SRC org + - Homepages: + [https://www.sisudoc.org] + [https://www.sisudoc.org] + + - Git + [] +#+END_SRC + +*** markup_samples + +#+NAME: sisudoc_spine_markup_samples +#+BEGIN_SRC org +- Spine, Doc Reform (SiSU) markup samples + Individual document content Copyright (Author) [as stated in document header] + Individual document content License (Author) [as stated in document header] +#+END_SRC + +* spine version info SET VERSION +** version in full + +#+NAME: spine_project_version +#+BEGIN_SRC org +<<spine_project_version_part_major>>.<<spine_project_version_part_minor>>.<<spine_project_version_part_patch>> +#+END_SRC + +** version parts (major, minor, patch) + +#+NAME: spine_project_version_major_minor_patch +#+BEGIN_SRC org +<<spine_project_version_part_major>>, <<spine_project_version_part_minor>>, <<spine_project_version_part_patch>> +#+END_SRC + +*** major + +#+NAME: spine_project_version_part_major +#+BEGIN_SRC org +0 +#+END_SRC + +*** minor + +#+NAME: spine_project_version_part_minor +#+BEGIN_SRC org +25 +#+END_SRC + +*** patch + +#+NAME: spine_project_version_part_patch +#+BEGIN_SRC org +2 +#+END_SRC + +* year + +#+NAME: year +#+BEGIN_SRC org +2026 +#+END_SRC + +* sisudoc spine git source SET +** sisudoc-spine src + +#+NAME: sisudoc_spine_nix_src +#+BEGIN_SRC org +git://git.sisudoc.org/software/sisudoc-spine +#+END_SRC + +#+BEGIN_SRC org +git+file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/code/software/sisudoc-spine +#+END_SRC + +** dlang overlay src + +#+NAME: sisudoc_dlang_nix_overlay_src +#+BEGIN_SRC org +git://git.sisudoc.org/package/dlang-nix-overlays-and-flake +#+END_SRC + +#+BEGIN_SRC org +git+file:///home/ralph/grotto/repo/git.repo/projects/doc-reform/packages/nix-flakes/dlang/dlang-nix-flakes" +#+END_SRC + +* ocda ssp version format SET +** ocda ssp version in full + +#+NAME: ocda_ssp_format_version +#+BEGIN_SRC org +<<ocda_ssp_format_version_part_major>>.<<ocda_ssp_format_version_part_minor>> +#+END_SRC + +** parts +*** major + +#+NAME: ocda_ssp_format_version_part_major +#+BEGIN_SRC org +2 +#+END_SRC + +*** minor + +#+NAME: ocda_ssp_format_version_part_minor +#+BEGIN_SRC org +1 +#+END_SRC + +* sqlite collection search db schema version + +#+NAME: sqlite_collection_search_db_schema_version +#+BEGIN_SRC org +1 +#+END_SRC + +* nipkgs source + +- github:NixOS/nixpkgs/nixpkgs-unstable +- https://channels.nixos.org/nixpkgs-unstable/nixexprs.tar.zst + +#+NAME: nixpkgs_unstable +#+BEGIN_SRC org +https://channels.nixos.org/nixpkgs-unstable/nixexprs.tar.zst +#+END_SRC + +#+BEGIN_SRC org +github:NixOS/nixpkgs/nixpkgs-unstable +#+END_SRC |
