aboutsummaryrefslogtreecommitdiffhomepage
path: root/org
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2026-09-11 22:01:51 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2026-09-12 12:39:08 -0400
commitbf605ac48b231c5852986be2b9a91838c617bfb7 (patch)
treebcb5e58153f3ac95498d5457bceea553ef2263c3 /org
parentorg renames (diff)
some file renames
Diffstat (limited to 'org')
-rw-r--r--org/config_meson.org4
-rw-r--r--org/in_abstraction_artefacts.org10
-rw-r--r--org/out_ocda_peg_ssp.org18
-rw-r--r--org/out_ocda_sqlite_db.org4
-rw-r--r--org/out_odt.org2
-rw-r--r--org/out_sqlite.org4
-rw-r--r--org/out_src_pod.org2
-rw-r--r--org/out_xmls.org4
-rw-r--r--org/out_zip.org6
-rw-r--r--org/output_hub.org12
-rw-r--r--org/sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org21
-rw-r--r--org/spine.org4
-rw-r--r--org/tests_for_document_abstraction_shell_scripts.org2
13 files changed, 68 insertions, 25 deletions
diff --git a/org/config_meson.org b/org/config_meson.org
index f268ff6..c18cbe2 100644
--- a/org/config_meson.org
+++ b/org/config_meson.org
@@ -123,7 +123,7 @@ spine_src = [
'src/sisudoc/io_in/read_config_files.d',
'src/sisudoc/io_in/read_source_files.d',
'src/sisudoc/io_out/cgi_sqlite_search_form.d',
- 'src/sisudoc/io_out/create_zip_file.d',
+ 'src/sisudoc/io_out/zip_pod.d',
'src/sisudoc/io_out/defaults.d',
'src/sisudoc/io_out/epub3.d',
'src/sisudoc/io_out/html.d',
@@ -135,7 +135,7 @@ spine_src = [
'src/sisudoc/io_out/paths_output.d',
'src/sisudoc/io_out/rgx.d',
'src/sisudoc/io_out/source_pod.d',
- 'src/sisudoc/io_out/sqlite.d',
+ 'src/sisudoc/io_out/sqlite_collection_db.d',
'src/sisudoc/io_out/xmls_css.d',
'src/sisudoc/io_out/xmls.d',
'src/sisudoc/meta/conf_make_meta_json.d',
diff --git a/org/in_abstraction_artefacts.org b/org/in_abstraction_artefacts.org
index d8ce545..863134c 100644
--- a/org/in_abstraction_artefacts.org
+++ b/org/in_abstraction_artefacts.org
@@ -225,7 +225,7 @@ template spineAbstractionRead() {
object sections in the order the file gives them
+/
struct SSPdocument {
- string format; // "% SiSU Document Abstraction v1.1"
+ string format; // "% SiSU Document Abstraction v<<ocda_ssp_format_version>>"
string source; // "% Source: ..."
string[string] source_info; // the @source block
string[] source_info_order;
@@ -1449,6 +1449,14 @@ template spineDocHasFromAbstraction() {
#+END_SRC
* org includes
+** ocda ssp format version
+
+#+NAME: ocda_ssp_format_version
+#+HEADER: :noweb yes
+#+BEGIN_SRC emacs-lisp
+<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:ocda_ssp_format_version()>>
+#+END_SRC
+
** project version
#+NAME: spine_version
diff --git a/org/out_ocda_peg_ssp.org b/org/out_ocda_peg_ssp.org
index 511c589..78e9a56 100644
--- a/org/out_ocda_peg_ssp.org
+++ b/org/out_ocda_peg_ssp.org
@@ -47,8 +47,8 @@ module sisudoc.ocda.abstraction.ssp;
reference to a heading above level 4 lands on;
was 0.1
+/
-enum ssp_format_version = "1.1";
-enum ssp_format_version_major = "1";
+enum ssp_format_version = "<<ocda_ssp_format_version>>";
+enum ssp_format_version_major = "<<ocda_ssp_format_version_part_major>>";
/+ ↓ escaping for values that are folded onto one line
a .ssp property value runs to the end of its line, and
@@ -709,6 +709,20 @@ template spineAbstractionTxt() {
#+END_SRC
* org includes
+** ocda ssp format version
+
+#+NAME: ocda_ssp_format_version
+#+HEADER: :noweb yes
+#+BEGIN_SRC emacs-lisp
+<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:ocda_ssp_format_version()>>
+#+END_SRC
+
+#+NAME: ocda_ssp_format_version_part_major
+#+HEADER: :noweb yes
+#+BEGIN_SRC emacs-lisp
+<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:ocda_ssp_format_version_part_major()>>
+#+END_SRC
+
** project version
#+NAME: spine_version
diff --git a/org/out_ocda_sqlite_db.org b/org/out_ocda_sqlite_db.org
index 70c118a..6916fa0 100644
--- a/org/out_ocda_sqlite_db.org
+++ b/org/out_ocda_sqlite_db.org
@@ -25,11 +25,11 @@
rename source_abstraction_peg_txt.d
-#+HEADER: :tangle "../src/sisudoc/outputs/io_out/create_ocda_db.d"
+#+HEADER: :tangle "../src/sisudoc/outputs/io_out/sqlite_ocda_db.d"
#+HEADER: :noweb yes
#+BEGIN_SRC d
<<doc_header_including_copyright_and_license>>
-module sisudoc.outputs.io_out.create_ocda_db;
+module sisudoc.outputs.io_out.sqlite_ocda_db;
/+ ↓ write document abstraction as per-document sqlite3 database +/
template spineAbstractionDb() {
diff --git a/org/out_odt.org b/org/out_odt.org
index 25feda2..66c8eaf 100644
--- a/org/out_odt.org
+++ b/org/out_odt.org
@@ -1048,7 +1048,7 @@ import std.outbuffer;
import std.uri;
import std.zip;
import std.conv : to;
-import sisudoc.outputs.io_out.create_zip_file;
+import sisudoc.outputs.io_out.zip_pod;
import sisudoc.outputs.io_out.xmls;
import sisudoc.outputs.io_out.xmls_css;
#+END_SRC
diff --git a/org/out_sqlite.org b/org/out_sqlite.org
index 275931b..df9adbb 100644
--- a/org/out_sqlite.org
+++ b/org/out_sqlite.org
@@ -41,11 +41,11 @@ sudo chown ralph:ralph /var/www
** _module, templates_ :module:
*** template
-#+HEADER: :tangle "../src/sisudoc/outputs/io_out/sqlite.d"
+#+HEADER: :tangle "../src/sisudoc/outputs/io_out/sqlite_collection_db.d"
#+HEADER: :noweb yes
#+BEGIN_SRC d
<<doc_header_including_copyright_and_license>>
-module sisudoc.outputs.io_out.sqlite;
+module sisudoc.outputs.io_out.sqlite_collection_db;
<<sqlite_imports>>
<<sqlite_common>>
<<sqlite_schema>>
diff --git a/org/out_src_pod.org b/org/out_src_pod.org
index 94094ae..caf19b4 100644
--- a/org/out_src_pod.org
+++ b/org/out_src_pod.org
@@ -127,7 +127,7 @@ import std.zip;
import std.conv : to;
import sisudoc.ocda.meta.rgx_files;
import sisudoc.outputs.io_out;
-import sisudoc.outputs.io_out.create_zip_file;
+import sisudoc.outputs.io_out.zip_pod;
import sisudoc.outputs.io_out.xmls;
#+END_SRC
diff --git a/org/out_xmls.org b/org/out_xmls.org
index 52ab735..e25327f 100644
--- a/org/out_xmls.org
+++ b/org/out_xmls.org
@@ -94,7 +94,7 @@ import sisudoc.outputs.io_out;
import sisudoc.outputs.io_out.rgx;
import sisudoc.ocda.meta.rgx_files;
import sisudoc.outputs.io_out.rgx_xhtml;
-import sisudoc.outputs.io_out.create_zip_file;
+import sisudoc.outputs.io_out.zip_pod;
import sisudoc.outputs.io_out.xmls;
import sisudoc.outputs.io_out.xmls_css;
#+END_SRC
@@ -111,7 +111,7 @@ import std.conv : to;
import sisudoc.outputs.io_out;
import sisudoc.outputs.io_out.rgx;
import sisudoc.outputs.io_out.rgx_xhtml;
-import sisudoc.outputs.io_out.create_zip_file;
+import sisudoc.outputs.io_out.zip_pod;
import sisudoc.outputs.io_out.xmls;
import sisudoc.outputs.io_out.xmls_css;
#+END_SRC
diff --git a/org/out_zip.org b/org/out_zip.org
index 7cde8a7..e1eeecb 100644
--- a/org/out_zip.org
+++ b/org/out_zip.org
@@ -18,14 +18,14 @@
- [[./doc-reform.org][doc-reform.org]] [[./][org/]]
- [[./output_hub.org][output_hub]]
-* _zip_ :module:spine:create_zip_file:
+* _zip_ :module:spine:zip_pod:
** module template
-#+HEADER: :tangle "../src/sisudoc/outputs/io_out/create_zip_file.d"
+#+HEADER: :tangle "../src/sisudoc/outputs/io_out/zip_pod.d"
#+HEADER: :noweb yes
#+BEGIN_SRC d
<<doc_header_including_copyright_and_license>>
-module sisudoc.outputs.io_out.create_zip_file;
+module sisudoc.outputs.io_out.zip_pod;
@safe:
template createZipFile() {
import std.file;
diff --git a/org/output_hub.org b/org/output_hub.org
index 88e28c1..27e0efc 100644
--- a/org/output_hub.org
+++ b/org/output_hub.org
@@ -120,7 +120,7 @@ template outputHubOp() {
import sisudoc.outputs.io_out;
import sisudoc.outputs.io_out.metadata;
import sisudoc.outputs.io_out.xmls;
-import sisudoc.outputs.io_out.create_zip_file;
+import sisudoc.outputs.io_out.zip_pod;
import sisudoc.outputs.io_out.paths_output;
#+END_SRC
@@ -274,7 +274,7 @@ if (sched == outTask.skel) {
#+BEGIN_SRC d
if (sched == outTask.sqlite) {
msg.v("sqlite processing... ");
- import sisudoc.outputs.io_out.sqlite;
+ import sisudoc.outputs.io_out.sqlite_collection_db;
doc.SQLiteHubDiscreteBuildTablesAndPopulate!();
msg.vv("sqlite done");
}
@@ -288,12 +288,12 @@ if (sched == outTask.sqlite) {
#+BEGIN_SRC d
if (doc.matters.opt.action.sqlite_update) {
msg.v("sqlite update processing...");
- import sisudoc.outputs.io_out.sqlite;
+ import sisudoc.outputs.io_out.sqlite_collection_db;
doc.SQLiteHubBuildTablesAndPopulate!();
msg.vv("sqlite update done");
} else if (doc.matters.opt.action.sqlite_delete) {
msg.v("sqlite delete processing...");
- import sisudoc.outputs.io_out.sqlite;
+ import sisudoc.outputs.io_out.sqlite_collection_db;
doc.SQLiteHubBuildTablesAndPopulate!();
msg.vv("sqlite delete done");
}
@@ -308,7 +308,7 @@ if ((opt_action.sqlite_db_drop)) {
if ((opt_action.vox_gt_2)) {
writeln("sqlite drop db...");
}
- import sisudoc.outputs.io_out.sqlite;
+ import sisudoc.outputs.io_out.sqlite_collection_db;
SQLiteDbDrop!()(opt_action, config);
if ((opt_action.vox_gt_3)) {
writeln("sqlite drop db done");
@@ -325,7 +325,7 @@ if ((opt_action.sqlite_db_create)) {
auto pth_sqlite_db = spinePathsSQLite!()(opt_action.cgi_sqlite_search_filename, opt_action.output_dir_set);
writeln("sqlite create table...");
}
- import sisudoc.outputs.io_out.sqlite;
+ import sisudoc.outputs.io_out.sqlite_collection_db;
SQLiteTablesCreate!()(env, opt_action, config);
if ((opt_action.vox_gt_3)) {
writeln("sqlite create table done");
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
index e6dda9f..ce6051e 100644
--- 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
@@ -137,3 +137,24 @@ git://git.sisudoc.org/package/dlang-nix-overlays-and-flake
#+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
+
+#+NAME: ocda_ssp_format_version
+#+BEGIN_SRC org
+<<ocda_ssp_format_version_part_major>>.<<ocda_ssp_format_version_part_minor>>
+#+END_SRC
+
+*** major
+
+#+NAME: ocda_ssp_format_version_part_major
+#+BEGIN_SRC org
+1
+#+END_SRC
+
+*** minor
+
+#+NAME: ocda_ssp_format_version_part_minor
+#+BEGIN_SRC org
+1
+#+END_SRC
diff --git a/org/spine.org b/org/spine.org
index d3f434b..0893b96 100644
--- a/org/spine.org
+++ b/org/spine.org
@@ -182,7 +182,7 @@ string program_name = "spine";
}
/+ ↓ sqlite statements that failed are fatal to the run, report and exit non-zero +/
{
- import sisudoc.outputs.io_out.sqlite : sqliteFailureTally;
+ import sisudoc.outputs.io_out.sqlite_collection_db : sqliteFailureTally;
if (sqliteFailureTally() > 0) {
stderr.writefln(
"~ run FAILED ~ %s sqlite statement(s) failed, db not written as expected",
@@ -1827,7 +1827,7 @@ if (doc.matters.opt.action.show_abstraction) {
+/
if (doc.matters.opt.action.ocda_db) {
import sisudoc.ocda.abstraction.ssp_in;
- import sisudoc.outputs.io_out.create_ocda_db;
+ import sisudoc.outputs.io_out.sqlite_ocda_db;
mixin spineAbstractionRead;
spineAbstractionDb!()(doc, sspRoundTripDocument(doc));
}
diff --git a/org/tests_for_document_abstraction_shell_scripts.org b/org/tests_for_document_abstraction_shell_scripts.org
index 5f355c8..690144f 100644
--- a/org/tests_for_document_abstraction_shell_scripts.org
+++ b/org/tests_for_document_abstraction_shell_scripts.org
@@ -921,7 +921,7 @@ echo " documents: $docs, objects: $objs"
# ── schema version: spine's declaration, the stamp in the db, the search
# form's expectation; all three have to agree
echo "Checking schema version ..."
-SPINE_SQL_SRC="$SPINE_DIR/src/sisudoc/outputs/io_out/sqlite.d"
+SPINE_SQL_SRC="$SPINE_DIR/src/sisudoc/outputs/io_out/sqlite_collection_db.d"
declared=$(sed -n 's/^enum sqlite_db_schema_version *= *\([0-9][0-9]*\);.*/\1/p' \
"$SPINE_SQL_SRC" | head -1)
stamped=$(sqlite3 "$DB" "pragma user_version;")