summaryrefslogtreecommitdiffhomepage
path: root/gleam/src/ocda
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2026-10-01 17:23:00 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2026-10-01 17:26:10 -0400
commit987828d4fd07cb390d6c61e91cd29bec79d444eb (patch)
tree67b008c99d20a43e59798c4923f4659c8aa6d57c /gleam/src/ocda
parentREADME: the reader, in each language, and what writing it found (diff)
gleam sisudoc-ocda-libclaude-org
Diffstat (limited to 'gleam/src/ocda')
-rw-r--r--gleam/src/ocda/dump.gleam49
-rw-r--r--gleam/src/ocda/images.gleam49
-rw-r--r--gleam/src/ocda/inventory.gleam49
-rw-r--r--gleam/src/ocda/load.gleam49
-rw-r--r--gleam/src/ocda/load_db.gleam49
-rw-r--r--gleam/src/ocda/load_pod.gleam49
-rw-r--r--gleam/src/ocda/load_ssp.gleam49
-rw-r--r--gleam/src/ocda/model.gleam49
-rw-r--r--gleam/src/ocda/zip.gleam49
9 files changed, 441 insertions, 0 deletions
diff --git a/gleam/src/ocda/dump.gleam b/gleam/src/ocda/dump.gleam
index e5563ca..19bd93d 100644
--- a/gleam/src/ocda/dump.gleam
+++ b/gleam/src/ocda/dump.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// The model, written out canonically.
////
//// Not an output format: an *oracle*. Two libraries in two languages
diff --git a/gleam/src/ocda/images.gleam b/gleam/src/ocda/images.gleam
index 2f3a56e..0639ff7 100644
--- a/gleam/src/ocda/images.gleam
+++ b/gleam/src/ocda/images.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// An image's bytes, from whichever source the document came from.
////
//// The model *names* images, with digest, byte size and pixel size; it does
diff --git a/gleam/src/ocda/inventory.gleam b/gleam/src/ocda/inventory.gleam
index 6047313..6bf1e99 100644
--- a/gleam/src/ocda/inventory.gleam
+++ b/gleam/src/ocda/inventory.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// What a source holds, beyond the one document the model is loaded from.
////
//// The model is one language of one document. Two questions a reader asks
diff --git a/gleam/src/ocda/load.gleam b/gleam/src/ocda/load.gleam
index 2a82ac9..579a4dd 100644
--- a/gleam/src/ocda/load.gleam
+++ b/gleam/src/ocda/load.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// What a path is, and loading it.
////
//// One place that decides, so that every reader and every writer accepts
diff --git a/gleam/src/ocda/load_db.gleam b/gleam/src/ocda/load_db.gleam
index 18a5335..5373be8 100644
--- a/gleam/src/ocda/load_db.gleam
+++ b/gleam/src/ocda/load_db.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// Loading a `.ocda.db` into the model.
////
//// The point of this module is that it returns *the same value*
diff --git a/gleam/src/ocda/load_pod.gleam b/gleam/src/ocda/load_pod.gleam
index 05f7add..4f8ee67 100644
--- a/gleam/src/ocda/load_pod.gleam
+++ b/gleam/src/ocda/load_pod.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// The abstraction out of a pod archive.
////
//// A pod built with `--pod2` carries the abstraction inside it, at
diff --git a/gleam/src/ocda/load_ssp.gleam b/gleam/src/ocda/load_ssp.gleam
index ec93ef5..1a546d4 100644
--- a/gleam/src/ocda/load_ssp.gleam
+++ b/gleam/src/ocda/load_ssp.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// Loading a `.ssp` into the model.
////
//// The format is line oriented and every line is one of eight shapes told
diff --git a/gleam/src/ocda/model.gleam b/gleam/src/ocda/model.gleam
index 48cc76e..7161308 100644
--- a/gleam/src/ocda/model.gleam
+++ b/gleam/src/ocda/model.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// The object-centric document abstraction, as Gleam types.
////
//// A deliberate mirror of the D library's `ocda.model`, field for field.
diff --git a/gleam/src/ocda/zip.gleam b/gleam/src/ocda/zip.gleam
index 5ce6e09..6917796 100644
--- a/gleam/src/ocda/zip.gleam
+++ b/gleam/src/ocda/zip.gleam
@@ -1,3 +1,52 @@
+/////+
+////- 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/]
+////
+////+/
//// Enough of the zip format to find one file in a pod and read it.
////
//// Not a zip library. A pod archive holds a handful of entries, spine writes