diff options
| author | Ralph Amissah <ralph.amissah@gmail.com> | 2026-04-22 11:18:11 -0400 |
|---|---|---|
| committer | Ralph Amissah <ralph.amissah@gmail.com> | 2026-04-22 20:42:29 -0400 |
| commit | 0ffce21928d3c0ae7af8fbd1388fddae4666c25a (patch) | |
| tree | 8b07c0342e00caabbb426a3e41a6fbe9bb151cef /org | |
| parent | spine may be run against a zipped spine-pod url (diff) | |
upkeep, update a few pathssisudoc-spine_v0.18.0
Diffstat (limited to 'org')
| -rw-r--r-- | org/COPYRIGHT | 2 | ||||
| -rw-r--r-- | org/config_env.org | 33 | ||||
| -rw-r--r-- | org/config_git.org | 1 | ||||
| -rw-r--r-- | org/config_make.org | 10 | ||||
| -rw-r--r-- | org/config_misc.org | 27 | ||||
| -rw-r--r-- | org/config_nix.org | 6 | ||||
| -rw-r--r-- | org/nixpkgs_overlays_d_related.org | 8 | ||||
| -rw-r--r-- | org/out_curate_metadata.org | 2 | ||||
| -rw-r--r-- | org/out_sqlite.org | 6 | ||||
| -rw-r--r-- | org/spine.org | 20 | ||||
| -rw-r--r-- | org/spine_info.org | 16 |
11 files changed, 75 insertions, 56 deletions
diff --git a/org/COPYRIGHT b/org/COPYRIGHT index b1cdad5..1678968 100644 --- a/org/COPYRIGHT +++ b/org/COPYRIGHT @@ -5,7 +5,7 @@ - Author: Ralph Amissah [ralph.amissah@gmail.com] - - Copyright: (C) 2015 - 2025 Ralph Amissah + - Copyright: (C) 2015 - 2026 Ralph Amissah - Spine, Doc Reform (related to SiSU) uses standard: - docReform markup syntax (based on SiSU markup) diff --git a/org/config_env.org b/org/config_env.org index a39978d..8c526c7 100644 --- a/org/config_env.org +++ b/org/config_env.org @@ -95,24 +95,29 @@ echo ' • to build project: - ❯❯ nix build --print-build-logs - ❯❯ nix build ".#" --print-build-logs - • to build project: + • nix flake set default + ❯❯ nix build --print-build-logs + ❯❯ nix build ".#" --print-build-logs • nix build using nixpkgs ❯❯ nix build ".#spine-nixpkgs-dmd" --print-build-logs ❯❯ nix build ".#spine-nixpkgs-ldc" --print-build-logs - • nix build using package overlays: (dmd-<<dmd_version>>, ldc-<<ldc_version>>, dub-<<dub_version>>, dtools-<<dtools_version>>) + • nix build using package overlays: (dmd, ldc, dub, dtools) ❯❯ nix build ".#spine-overlay-dmd" --print-build-logs ❯❯ nix build ".#spine-overlay-ldc" --print-build-logs • to build using dub on nix (get dependencies by setting your development environment): ❯❯ nix develop ".#dsh-nixpkgs-dmd" --print-build-logs -c zsh - ❯❯ dub --verbose --compiler=dmd --config=dmd + ❯❯ dub run --compiler=dmd --config=dmd ❯❯ nix develop ".#dsh-nixpkgs-ldc" --print-build-logs -c zsh - ❯❯ dub --verbose --compiler=ldmd2 --config=ldmd2 + ❯❯ dub run --compiler=ldmd2 --config=ldmd2 + + ❯❯ nix develop ".#dsh-nixpkgs-ldc" --print-build-logs -c dub build --compiler=ldmd2 --config=ldmd2 --combined --skip-registry=all + ❯❯ nix develop ".#dsh-overlay-ldc" --print-build-logs -c dub build --compiler=ldmd2 --config=ldmd2 --combined --skip-registry=all + + ❯❯ nix-shell -p ldc dub --run "dub build --compiler=ldc2 2>&1" • for develop environment & build options @@ -129,7 +134,7 @@ echo ' ❯❯ ${SpineBIN} -v --sqlite-db-create --sqlite-db-filename=${SpineSQLdb} --sqlite-db-path=./_tmp-db ❯❯ ${SpineBIN} -v --sqlite-update --sqlite-db-filename=${SpineSQLdb} --sqlite-db-path=./_tmp-db ${SpinePOD}/* - ❯❯ ${SpineBIN} --source --pod --curate --text --latex --epub --html --manifest --html-link-search --html-link-pdf --html-link-text --html-link-curate --html-link-markup --html-link-source --html-link-pod --html-link-metadata --cgi-sqlite-search-filename="${SpineCGIform}" --cgi-url-action="${SpineSearchActionRemote}" --sqlite-db-path="${SpineDBpath}" --sqlite-db-filename="${SpineSQLdb}" --www-url-doc-root=${SpineURLdocRoot} --set-papersize="a4,letter" --output=${SpineOUT} ${SpinePOD}/* + ❯❯ ${SpineBIN} --source --pod --curate --text --latex --epub --html --manifest --html-link-search --html-link-pdf --html-link-text --html-link-curate --html-link-markup --html-link-source --html-link-pod --html-link-metadata --cgi-sqlite-search-filename="${SpineCGIform}" --cgi-url-action="${SpineSearchActionRemote}" --sqlite-db-path="${SpineDBpath}" --sqlite-db-filename="${SpineSQLdb}" --www-url-doc-root=${SpineURLdocRootRemote} --set-papersize="a4,letter" --output=${SpineOUT} ${SpinePOD}/* ' echo "• ❯❯ ${SpineBIN} -v --source --pod --epub --html --html-link-curate --html-link-markup --curate --output=${SpineOUT} ${SpinePOD}/* @@ -158,9 +163,15 @@ fi #+HEADER: :shebang #!/usr/bin/env sh #+BEGIN_SRC shell SpineProjVer=`rg "Version\((\d+), (\d+), (\d+)\)" views/version.txt | sed -E 's/.*([0-9]+), ([0-9]+), ([0-9]+).*/spine-v\1.\2.\3/'` && \ - SpineGitVer=`git describe | sed "s/^[a-z_-]\+\([0-9.]\+\)/\1/" | sed "s/\([^-]*-g\)/r\1/" | sed "s/-/./g"` && \ + SpineGitVer=`git describe | sed "s/^[a-z_-]\+\([0-9.]\+\)/\1/" | sed "s/\([^-]*-g\)/r\1/" | sed "s/\(r[0-9.]\+\)-g/\1:/g" | sed "s/\([a-z0-9._-]\+\)/(\1)/g" | sed "s/:/-/"| sed "s/(\([0-9a-f]\{7\}\))/[\1]/"` && \ + SpineDateCurrent=`date "+%Y-%m-%d"` && \ + SpineDateCommit=`git log -1 --format="%ad" --date=format:"%Y%m%d"` && \ SpineGitBranch=`git branch --show-current` && \ - echo "❯❯ $SpineProjVer - ($SpineGitBranch: $SpineGitVer)" + cat <<EOF +spine-$SpineDateCommit-$SpineGitVer ($SpineGitBranch) + +$SpineProjVer (project) +EOF #+END_SRC ** .envrc-local CHECK MODIFY @@ -186,13 +197,15 @@ export SpineDOC=../sisudoc-spine-samples # ❯❯ location of source files pod: export SpinePOD=${SpineDOC}/markup/pod-samples/pod # ❯❯ sisudoc-spine output processing path: -export SpineOUT=./OUTPUT_TEST_sisudocSpine +export SpineOUT=./OUTPUT_TEST # ❯❯ sisudoc-spine output processing path (web server e.g.): #export SpineOUT=/srv/www/spine #export SpineOUTversioned=${SpineOUT}/${SpineVER} # ❯❯ www url doc root export SpineURLdocRoot='http://localhost' # export SpineURLdocRoot='https://sisudoc.org' +export SpineURLdocRootLocal='http://localhost' +export SpineURLdocRootRemote='https://sisudoc.org' # ❯❯ path configured for cgi search form: export SpineSearchActionLocal='http://localhost/spine_search' export SpineSearchActionRemote='https://sisudoc.org/spine_search' diff --git a/org/config_git.org b/org/config_git.org index d0950e1..cdcd3da 100644 --- a/org/config_git.org +++ b/org/config_git.org @@ -23,6 +23,7 @@ #+HEADER: :tangle "../.gitignore" #+BEGIN_SRC gitignore # git ls-files --others --exclude-from=.git/info/exclude +# git ls-files --others --ignored --exclude-standard --directory # git check-ignore -v flake.lock # git clean -ix # find . -name "*_" | xargs rm -rf diff --git a/org/config_make.org b/org/config_make.org index fc2fbc3..17b5986 100644 --- a/org/config_make.org +++ b/org/config_make.org @@ -800,28 +800,28 @@ testrun_paths: testrun_paths_pod_source: spine -v --source \ --output-dir=tmp/program_output_pod \ - ./markup/pod/* + ./markup/pod-samples/pod/* testrun_paths_pod_pod: spine -v --pod \ --output-dir=tmp/program_output_pod \ - ./markup/pod/* + ./markup/pod-samples/pod/* testrun_paths_pod_html: spine -v --html \ --output-dir=tmp/program_output_pod \ - ./markup/pod/* + ./markup/pod-samples/pod/* testrun_paths_pod_epub: spine -v --epub \ --output-dir=tmp/program_output_pod \ - ./markup/pod/* + ./markup/pod-samples/pod/* testrun_paths_pod_all: spine -v --source --html --epub --sqlite-discrete \ --sqlite-create --sqlite-update \ --output-dir=tmp/program_output_pod \ - ./markup/pod/* + ./markup/pod-samples/pod/* testrun_find_dir_source: $(SiSU_MARKUP_SAMPLES_DIR_FILES_FOUND) \ diff --git a/org/config_misc.org b/org/config_misc.org index 675ac75..670f4ba 100644 --- a/org/config_misc.org +++ b/org/config_misc.org @@ -145,24 +145,29 @@ find data/sisudir/media/text -name *.ss[tm] | sort | xargs *** sort #+BEGIN_SRC shell -~dr/bin/spine-ldc -v --sqlite-db-create --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=/var/www/html \ - ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod/* +./bin/spine-ldc -v --sqlite-db-create --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=/var/www/html \ + ../sisudoc-spine-samples/markup/pod-samples/pod/* -~dr/bin/spine-ldc -v --sqlite-update --sqlite-db-filename="spine.search.db" --output=/var/www/html \ - ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod/* +./bin/spine-ldc -v --sqlite-update --sqlite-db-filename="spine.search.db" --output=/var/www/html \ + ../sisudoc-spine-samples/markup/pod-samples/pod/* -~dr/bin/spine-ldc -v --html --curate-link --output=/var/www/html \ - ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod/* +./bin/spine-ldc -v --html --curate-link --output=/var/www/html \ + ../sisudoc-spine-samples/markup/pod-samples/pod/* -~dr/bin/spine-ldc -q --show-config --html --output=/var/www/html ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod +./bin/spine-ldc -q --show-config --html --output=/var/www/html \ + ../sisudoc-spine-samples/markup/pod-samples/pod -~dr/bin/spine-ldc -q --show-config ~/grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod +./bin/spine-ldc -q --show-config \ + ../sisudoc-spine-samples/markup/pod-samples/pod -~dr/result/bin/spine --html --output=/var/www/html ~/grotto/repo/git.repo/projects/project-spine/doc-reform-markup/markup_samples/markup/pod/* +./result/bin/spine --html --output=/var/www/html \ + ../sisudoc-spine-samples/markup/pod-samples/pod/* -~dr/result/bin/spine --very-verbose --sqlite-db-create --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=/var/www ~/grotto/repo/git.repo/projects/project-spine/doc-reform-markup/markup_samples/markup/pod/* +./result/bin/spine --very-verbose --sqlite-db-create --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=/var/www \ + ../sisudoc-spine-samples/markup/pod-samples/pod/* -~dr/result/bin/spine --very-verbose --sqlite-update --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=/var/www ~/grotto/repo/git.repo/projects/project-spine/doc-reform-markup/markup_samples/markup/pod/* +./result/bin/spine --very-verbose --sqlite-update --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=/var/www \ + ../sisudoc-spine-samples/markup/pod-samples/pod/* #+END_SRC - produces: diff --git a/org/config_nix.org b/org/config_nix.org index ac74bca..0fef79d 100644 --- a/org/config_nix.org +++ b/org/config_nix.org @@ -78,7 +78,7 @@ runHook postInstall ''; postInstall = '' - echo "❯❯ ./result/bin/spine -v --source --pod --text --epub --html --html-link-pdf --html-link-curate --html-link-markup --curate --output=./OUTPUT_TEST_sisudocSpine ../sisu-spine-samples/markup/pod/*"; + echo "❯❯ ./result/bin/spine -v --source --pod --text --epub --html --html-link-pdf --html-link-curate --html-link-markup --curate --output=./OUTPUT_TEST ../sisu-spine-samples/markup/pod-samples/pod/*"; echo `ls -la $out/bin/spine` echo "❯❯ spine-v${version} (rev: ${self.shortRev or "unknown"})" $out/bin/spine -v @@ -409,7 +409,7 @@ stdenv.mkDerivation { ''; postInstall = '' echo `ls -la $out/bin/spine` - echo "❯❯ spine-v0.18.0 (rev: ${rev})" + echo "❯❯ spine-v<<spine_version>> (rev: ${rev})" $out/bin/spine -v ''; meta = { @@ -746,7 +746,7 @@ $SpineBIN/spine --very-verbose --sqlite-db-create --output="$SpineOUTversioned" ,*** sqlite db (shared) - populate db ,#+BEGIN_SRC shell -$SpineBIN/spine --very-verbose --sqlite-update --output="$SpineOUTversioned" $SpineDOC/sisudoc-spine-markup-samples/markup/pod/* +$SpineBIN/spine --very-verbose --sqlite-update --output="$SpineOUTversioned" $SpineDOC/sisudoc-spine-markup-samples/markup/pod-samples/pod/* ,#+END_SRC ,*** sqlite db (shared) - drop db diff --git a/org/nixpkgs_overlays_d_related.org b/org/nixpkgs_overlays_d_related.org index dc8291f..53210eb 100644 --- a/org/nixpkgs_overlays_d_related.org +++ b/org/nixpkgs_overlays_d_related.org @@ -357,7 +357,7 @@ use flake . ]; inherit shellHook; }; - dsh-overlay-ldc-dub = mkShell { + dsh-overlay-ldc = mkShell { name = "overlay - ldc-<<ldc_version>> - dub-<<dub_version>> - dtools-<<dtools_version>>"; inherit shell; inherit devEnv; @@ -369,7 +369,7 @@ use flake . ]; inherit shellHook; }; - dsh-overlay-dmd-dub = mkShell { + dsh-overlay-dmd = mkShell { name = "overlay - dmd-<<dmd_version>> - dub-<<dub_version>> - dtools-<<dtools_version>>"; inherit shell; inherit devEnv; @@ -407,7 +407,7 @@ use flake . # ]; # inherit shellHook; #}; - dsh-nixpkgs-ldc-dub = mkShell { + dsh-nixpkgs-ldc = mkShell { name = "nixpkgs - ldc - dub"; inherit shell; inherit devEnv; @@ -419,7 +419,7 @@ use flake . ]; inherit shellHook; }; - dsh-nixpkgs-dmd-dub = mkShell { + dsh-nixpkgs-dmd = mkShell { name = "nixpkgs - ldc - dub"; inherit shell; inherit devEnv; diff --git a/org/out_curate_metadata.org b/org/out_curate_metadata.org index dfe3a9e..eda8194 100644 --- a/org/out_curate_metadata.org +++ b/org/out_curate_metadata.org @@ -22,7 +22,7 @@ - html ~dr/bin/spine-ldc -v --html --html-link-curate --curate \ --output=/var/www/html \ - ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod/* + ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod-samples/pod/* ** _module template_ metadoc curate diff --git a/org/out_sqlite.org b/org/out_sqlite.org index 7bb259a..06d4a9f 100644 --- a/org/out_sqlite.org +++ b/org/out_sqlite.org @@ -24,18 +24,18 @@ sudo chown ralph:ralph /var/www ~dr/bin/spine-ldc -v \ --sqlite-db-create --sqlite-db-filename="spine.search.db" \ --output=/var/www/html \ - ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod/* + ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod-samples/pod/* - update db ~dr/bin/spine-ldc -v \ --sqlite-update --sqlite-db-filename="spine.search.db" \ --output=/var/www/html \ - ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod/* + ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod-samples/pod/* - produce html (and some other) output files ~dr/bin/spine-ldc -v --html --epub --latex --odt \ --output=/var/www \ - ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod/* + ~grotto/repo/git.repo/code/project-spine/doc-reform-markup/markup_samples/markup/pod-samples/pod/* * sql ** _module, templates_ :module: diff --git a/org/spine.org b/org/spine.org index a8b7cf9..40a89e9 100644 --- a/org/spine.org +++ b/org/spine.org @@ -927,16 +927,16 @@ struct OptActions { } auto output_task_scheduler() { int[] schedule; - if (source_or_pod) { schedule ~= outTask.source_or_pod; } - if (sqlite_discrete) { schedule ~= outTask.sqlite; } - if (epub) { schedule ~= outTask.epub; } - if (html_scroll) { schedule ~= outTask.html_scroll; } - if (html_seg) { schedule ~= outTask.html_seg; } - if (html_stuff) { schedule ~= outTask.html_stuff; } - if (odt) { schedule ~= outTask.odt; } - if (latex) { schedule ~= outTask.latex; } - if (text) { schedule ~= outTask.text; } - if (skel) { schedule ~= outTask.skel; } + if (source_or_pod) schedule ~= outTask.source_or_pod; + if (sqlite_discrete) schedule ~= outTask.sqlite; + if (epub) schedule ~= outTask.epub; + if (html_scroll) schedule ~= outTask.html_scroll; + if (html_seg) schedule ~= outTask.html_seg; + if (html_stuff) schedule ~= outTask.html_stuff; + if (odt) schedule ~= outTask.odt; + if (latex) schedule ~= outTask.latex; + if (text) schedule ~= outTask.text; + if (skel) schedule ~= outTask.skel; return schedule.sort().uniq; } @trusted bool abstraction() { diff --git a/org/spine_info.org b/org/spine_info.org index b587dc7..cd7ea11 100644 --- a/org/spine_info.org +++ b/org/spine_info.org @@ -385,16 +385,16 @@ For the most basic output you will need to specify: - the (path for) where the generated output is to be placed export SpineBIN=./result/bin/spine -export SpinePOD=../sisudoc-spine-samples/markup/pod -export SpineOUT=./OUTPUT_TEST_sisudocSpine +export SpinePOD=../sisudoc-spine-samples/markup/pod-samples/pod +export SpineOUT=./OUTPUT_TEST ${SpineBIN} -v --source --pod --epub --html --html-link-curate --html-link-markup --curate --output=${SpineOUT} ${SpinePOD}/* ${SpineBIN} -v --source --pod --latex --latex-init --epub --html --html-link-pdf --html-link-curate --html-link-markup --curate --output=${SpineOUT} ${SpinePOD}/* which would execute the following command: -./result/bin/spine -v --source --pod --epub --html --html-link-curate --html-link-markup --curate --output=./OUTPUT_TEST_sisudocSpine ../sisudoc-spine-samples/markup/pod/* -./result/bin/spine -v --source --pod --latex --latex-init --epub --html --html-link-pdf --html-link-curate --html-link-markup --curate --output=./OUTPUT_TEST_sisudocSpine ../sisudoc-spine-samples/markup/pod/* +./result/bin/spine -v --source --pod --epub --html --html-link-curate --html-link-markup --curate --output=./OUTPUT_TEST ../sisudoc-spine-samples/markup/pod-samples/pod/* +./result/bin/spine -v --source --pod --latex --latex-init --epub --html --html-link-pdf --html-link-curate --html-link-markup --curate --output=./OUTPUT_TEST ../sisudoc-spine-samples/markup/pod-samples/pod/* #+END_SRC *** commands help @@ -530,11 +530,11 @@ summary of the collection can be made using the curate command: ${SpineBIN} -v --curate --output=${SpineOUT} ${SpinePOD}/* -spine -v --curate --output=./OUTPUT_TEST_sisudocSpine ../sisudoc-spine-samples/markup/pod/* +spine -v --curate --output=./OUTPUT_TEST ../sisudoc-spine-samples/markup/pod-samples/pod/* ${SpineBIN} -v --html --html-link-curate --curate --output=${SpineOUT} ${SpinePOD}/* -spine -v --html --html-link-curate --curate --output=./OUTPUT_TEST_sisudocSpine ../sisudoc-spine-samples/markup/pod/* +spine -v --html --html-link-curate --curate --output=./OUTPUT_TEST ../sisudoc-spine-samples/markup/pod-samples/pod/* #+END_SRC #+NAME: sisudoc_spine_README_command_examples_sqlite_text @@ -722,10 +722,10 @@ export SpineBIN=./result/bin/spine export SpineDOC=../sisudoc-spine-samples # ❯❯ location of source files pod: -export SpinePOD=${SpineDOC}/markup/pod +export SpinePOD=${SpineDOC}/markup/pod-samples/pod # ❯❯ sisudoc-spine output processing path: -export SpineOUT=./OUTPUT_TEST_sisudocSpine +export SpineOUT=./OUTPUT_TEST # ❯❯ sisudoc-spine output processing path (web server e.g.): #export SpineOUT=/srv/www/spine |
