track org config suggestions that require bespoke adjustment

1 files changed, 134 insertions, 0 deletions

diff --git a/.envrc-local_ b/.envrc-local_
new file mode 100644
index 0000000..3cfc9b1
--- /dev/null
+++ b/.envrc-local_
@@ -0,0 +1,134 @@
+export NIX_PATH=/nix/var/nix/profiles/per-user/root/channels/nixos
+#export NIX_PATH=/nixpkgs-ra/nixpkgs
+## reload when these files change
+#use flake
+watch_file flake.nix
+# watch_file flake.lock
+## load the flake devShell
+eval "$(nix print-dev-env)"
+# echo $NIX_BUILD_TOP
+export SpineVER=$(git describe --long --tags | sed 's/^[ a-z_-]\+\([0-9.]\+\)/\1/;s/\([^-]*-g\)/r\1/;s/-/./g')
+export SpineSRC=/grotto-ra/repo/git.repo/projects/project-spine/doc-reform
+export SpineBIN=/grotto-ra/repo/git.repo/projects/project-spine/doc-reform/result/bin
+export SpineDOC=/grotto-ra/repo/git.repo/projects/project-spine/doc-reform-markup/spine-markup-samples
+export SpineOUT=/srv/www/spine/$SpineVER
+export SpineOUTstatic=/srv/www/spine/static
+
+echo '-*- mode: org -*-
+
+* nixpkgs path?
+
+  eval "$(nix print-dev-env)"
+' > nix_note_
+
+echo "  <nixpkgs> == `nix-instantiate --find-file nixpkgs`" >> nix_note_
+
+echo '
+* nix build and show derivation
+
+  nix-shell --pure
+
+  nix-build
+  nix build -f default.nix
+  nix shell -f default.nix
+  nix-instantiate | nix-build
+  nix build `nix-instantiate`
+
+  nix develop
+
+  nix-instantiate | nix show-derivation | jq
+  nix-instantiate | nix show-derivation --recursive | jq
+
+  nix search --json 2>/dev/null |jq
+
+* version and build info
+' >> nix_note_
+
+echo "  spine version (git) == $SpineVER" >> nix_note_
+echo "  nix-instantiate == `nix-instantiate`" >> nix_note_
+
+echo "
+* initialised shell variables
+
+  SpineSRC=$SpineSRC
+  SpineDOC=$SpineDOC
+  SpineOUT=$SpineOUT
+  SpineOUTstatic=$SpineOUTstatic
+" >> nix_note_
+
+echo '* spine run instruction examples
+** parallelized tasks
+
+  - doc source
+    $SpineBIN/spine --very-verbose --pod --source --output="$SpineOUT" $SpineDOC/markup/pod/*
+
+  - html & epub output
+    $SpineBIN/spine --very-verbose --html --epub --output="$SpineOUT" $SpineDOC/markup/pod/*
+
+  - sqlite db for each document - populate each db
+    $SpineBIN/spine --very-verbose --sqlite-discrete --output="$SpineOUT" $SpineDOC/markup/pod/*
+
+  - doc source; html, epub; sqlite outputs
+    $SpineBIN/spine --verbose --pod --html --epub --sqlite-discrete --output="$SpineOUT" $SpineDOC/markup/pod/*
+
+  - harvest (authors topics)
+    $SpineBIN/spine --very-verbose --harvest --output="$SpineOUT" $SpineDOC/markup/pod/*
+  - html, harvest
+    $SpineBIN/spine --verbose --dark --html --html-link-harvest --harvest --output="$SpineOUT" $SpineDOC/markup/pod/*
+    $SpineBIN/spine --very-verbose --html --html-link-harvest --harvest --output="$SpineOUT" $SpineDOC/markup/pod/*
+
+  - composite command: source pod, html, epub, harvest, sqlite
+    $SpineBIN/spine --verbose --dark --pod --epub --html --html-link-harvest --harvest --sqlite-discrete --output="$SpineOUT" $SpineDOC/markup/pod/*
+
+** sequential tasks
+
+  - sqlite db (shared)  - create db
+    $SpineBIN/spine --very-verbose --sqlite-db-create --output="$SpineOUT"
+  - sqlite db (shared) - populate db
+    $SpineBIN/spine --very-verbose --sqlite-update --output="$SpineOUT" $SpineDOC/spine-markup-samples/markup/pod/*
+  - sqlite db (shared) - drop db
+    $SpineBIN/spine --very-verbose --sqlite-db-drop --output="$SpineOUT"
+
+  - sqlite db (shared) - create & populate db (single step)
+    $SpineBIN/spine --very-verbose --sqlite-db-create --sqlite-update --output="$SpineOUT" $SpineDOC/markup/pod/*
+
+  - composite command: source pod, html, epub, harvest, sqlite
+    $SpineBIN/spine --verbose --no-parallel --dark --pod --epub --html --html-link-harvest --harvest --sqlite-discrete --output="$SpineOUT" $SpineDOC/markup/pod/*
+
+** config [./pod/].dr/config_local_site
+
+  cat $SpineDOC/markup/pod/.dr/config_local_site
+  $SpineBIN/spine --show-config $SpineDOC/markup/pod
+  $SpineBIN/spine --show-config --output="$SpineOUT" $SpineDOC/markup/pod
+
+** cgi operations (output to $SpineOUTstatic /var/www)
+
+    $SpineBIN/spine --very-verbose --sqlite-db-create --output="$SpineOUTstatic" $SpineDOC/markup/pod/*
+
+    $SpineBIN/spine -v --cgi-search-form-codegen --output=$SpineOUTstatic $SpineDOC/markup/pod/*
+
+    $SpineBIN/spine -v --show-config --config=$SpineDOC/markup/pod/.dr
+
+    $SpineBIN/spine --html $SpineDOC/markup/pod/*
+
+    $SpineBIN/spine -v  --sqlite-db-create --sqlite-db-filename="spine.search.db" --output="$SpineOUTstatic" $SpineDOC/markup/pod/*
+
+    $SpineBIN/spine -v  --sqlite-db-create --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=$SpineOUTstatic $SpineDOC/markup/pod/*
+    $SpineBIN/spine -v  --sqlite-db-recreate --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --output=$SpineOUTstatic $SpineDOC/markup/pod/*
+
+    $SpineBIN/spine -v  --sqlite-update --sqlite-db-filename="spine.search.db"   --output=$SpineOUTstatic $SpineDOC/markup/pod/*
+
+    $SpineBIN/spine -v --cgi-search-form-codegen --config=$SpineDOC/markup/pod/.dr/config_local_site
+
+  - generate html linked to search form
+    $SpineBIN/spine -v --html --html-link-search --html-link-harvest --harvest  --output=$SpineOUTstatic $SpineDOC/markup/pod/*
+
+  - populate sqlite db
+    $SpineBIN/spine -v  --sqlite-db-recreate --sqlite-db-filename="spine.search.db" --cgi-sqlite-search-filename="spine-search" --sqlite-update --output=$SpineOUTstatic $SpineDOC/markup/pod/*
+
+  - make search form
+    $SpineBIN/spine -v --cgi-search-form-codegen --config=$SpineDOC/markup/pod/.dr/config_local_site --output=$SpineOUTstatic
+
+' >> nix_note_
+cat nix_note_
+echo "cat nix_note_"