From 90873fabd7451e1dd8c4b39303906e19bdc481f7 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Wed, 10 Apr 2024 22:24:34 -0400 Subject: 0.16.0 sisudoc (src/sisudoc sisudoc spine) - src/sisudoc (replaces src/doc_reform) - sisudoc spine (used more) --- org/compile_time_info.org | 8 +- org/config_d_cfte.org | 4 +- org/config_dub.org | 16 +-- org/config_env.org | 4 +- org/config_make.org | 42 ++++---- org/config_meson.org | 82 ++++++++-------- org/config_misc.org | 4 +- org/config_nix.org | 4 +- org/default_imports.org | 22 ++--- org/default_misc.org | 12 +-- org/default_paths.org | 18 ++-- org/default_regex.org | 28 +++--- org/default_shared_snippets.org | 18 ++-- org/in_source_files.org | 48 ++++----- org/meta_conf_make_meta.org | 52 +++++----- org/meta_debugs.org | 12 +-- org/ocda.org | 20 ++-- org/ocda_functions.org | 18 ++-- org/ocda_obj_setter.org | 8 +- org/out_curate_metadata.org | 34 +++---- org/out_latex.org | 22 ++--- org/out_metadata.org | 14 +-- org/out_odt.org | 30 +++--- org/out_sqlite.org | 14 +-- org/out_src_pod.org | 18 ++-- org/out_xmls.org | 50 +++++----- org/out_xmls_css.org | 8 +- org/out_zip.org | 8 +- org/output_hub.org | 50 +++++----- org/output_show.org | 24 ++--- ..._doc_header_including_copyright_and_license.org | 109 +++++++++++++++++++++ org/spine.org | 88 ++++++++--------- org/spine_info.org | 12 +-- ..._doc_header_including_copyright_and_license.org | 109 --------------------- org/util_spine_markup_conversion_from_sisu.org | 2 +- org/util_spine_syntax_highlighting_emacs.org | 2 +- org/util_spine_syntax_highlighting_vim.org | 2 +- 37 files changed, 508 insertions(+), 508 deletions(-) create mode 100644 org/sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org delete mode 100644 org/spine_version_info_and_doc_header_including_copyright_and_license.org (limited to 'org') diff --git a/org/compile_time_info.org b/org/compile_time_info.org index f333390..20a6cc8 100644 --- a/org/compile_time_info.org +++ b/org/compile_time_info.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) compile time info +#+TITLE: sisudoc spine (doc_reform) compile time info #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:compile: #+AUTHOR: Ralph Amissah @@ -27,14 +27,14 @@ version(Windows) {} else { ... } ** _module template_ :module:compile_time_info: -#+HEADER: :tangle "../src/doc_reform/conf/compile_time_info.d" +#+HEADER: :tangle "../src/sisudoc/conf/compile_time_info.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ compile_time_info +/ -module doc_reform.conf.compile_time_info; +module sisudoc.conf.compile_time_info; @safe: template CompileTimeInfo() { <> @@ -47,7 +47,7 @@ template CompileTimeInfo() { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC ** complile time os diff --git a/org/config_d_cfte.org b/org/config_d_cfte.org index aed3221..a1e8f81 100644 --- a/org/config_d_cfte.org +++ b/org/config_d_cfte.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: configuration d cfte +#+TITLE: sisudoc spine configuration d cfte #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:hub: #+AUTHOR: Ralph Amissah @@ -28,7 +28,7 @@ #+NAME: spine_version_mmp #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version_major_minor_patch()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version_major_minor_patch()>> #+END_SRC *** set program version tangle :version: diff --git a/org/config_dub.org b/org/config_dub.org index 7cef080..c91eb94 100644 --- a/org/config_dub.org +++ b/org/config_dub.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: configuration dub +#+TITLE: sisudoc configuration dub #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:hub: #+AUTHOR: Ralph Amissah @@ -22,7 +22,7 @@ #+NAME: spine_version #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> #+END_SRC ** dub @@ -54,33 +54,33 @@ "homepage": "https://sisudoc.org", "license": "AGPL-3.0+", "targetPath": "./bin", - "sourcePaths": [ "./src/doc_reform" ], + "sourcePaths": [ "./src/sisudoc" ], "stringImportPaths": [ "./views" ], "buildRequirements": [ "allowWarnings" ], "targetType": "executable", "buildTypes": { "dmd": { - "dflags": [ "-J=views", "-I=src/doc_reform" ], + "dflags": [ "-J=views", "-I=src/sisudoc" ], "buildOptions": [ "inline", "verbose" ], "buildRequirements": [ "allowWarnings" ] }, "ldc2": { - "dflags": [ "-O2", "-J=views", "-I=src/doc_reform" ], + "dflags": [ "-O2", "-J=views", "-I=src/sisudoc" ], "buildOptions": [ "optimize", "inline", "verbose" ], "buildRequirements": [ "allowWarnings" ] }, "ldmd2": { - "dflags": [ "-O2", "-boundscheck=on", "-J=views", "-I=src/doc_reform", "-color=on" ], + "dflags": [ "-O2", "-boundscheck=on", "-J=views", "-I=src/sisudoc", "-color=on" ], "buildOptions": [ "optimize", "inline", "verbose" ], "buildRequirements": [ "allowWarnings" ] }, "gdc": { - "dflags": [ "-O2", "-J=views", "-I=src/doc_reform" ], + "dflags": [ "-O2", "-J=views", "-I=src/sisudoc" ], "buildOptions": [ "optimize", "inline" ], "buildRequirements": [ "allowWarnings" ] }, "gdmd": { - "dflags": [ "-O2", "-J=views", "-I=src/doc_reform" ], + "dflags": [ "-O2", "-J=views", "-I=src/sisudoc" ], "buildOptions": [ "optimize", "inline" ], "buildRequirements": [ "allowWarnings" ] } diff --git a/org/config_env.org b/org/config_env.org index 79dfb02..cddcf01 100644 --- a/org/config_env.org +++ b/org/config_env.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) (project) environment +#+TITLE: sisudoc spine (doc_reform) (project) environment #+DESCRIPTION: env envrc used by make & nix #+FILETAGS: :spine:build:tools: #+AUTHOR: Ralph Amissah @@ -160,7 +160,7 @@ export DFLAGS="-O2 -inline -boundscheck=on -color=on" export SpineVER=$(git describe --long --tags | sed 's/^[ a-z_-]\+\([0-9.]\+\)/\1/;s/\([^-]*-g\)/r\1/;s/-/./g') export SpineBIN=result/bin export SpinePROJ=~/grotto/repo/git.repo/projects/doc-reform/code/software/spine -export SpineDOC=~/grotto/repo/git.repo/projects/project-spine/doc-reform-markup/spine-markup-samples +export SpineDOC=~/grotto/repo/git.repo/projects/project-spine/doc-reform-markup/sisudoc-spine-markup-samples export SpinePOD=${SpineDOC}/markup/pod export SpineOUT=/srv/www/spine export SpineOUTversioned=/srv/www/spine/${SpineVER} diff --git a/org/config_make.org b/org/config_make.org index ea11505..9e36285 100644 --- a/org/config_make.org +++ b/org/config_make.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) (project) makefile +#+TITLE: sisudoc spine (doc_reform) (project) makefile #+DESCRIPTION: makefile for spine #+FILETAGS: :spine:build:tools: #+AUTHOR: Ralph Amissah @@ -23,7 +23,7 @@ #+NAME: spine_version #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> #+END_SRC *** build tools if specified @@ -354,7 +354,7 @@ fzf-nix-e: fzf-src: echo -n "what to search source files for?: "; \ read FIND; \ - cd ./src/doc_reform; \ + cd ./src/sisudoc; \ rg --files-with-matches --no-messages "$${FIND}" | \ fzf --multi --ansi --print0 \ --preview-window=right:66% \ @@ -409,7 +409,7 @@ markup-pod-tree: # show markup pod source tree tree-src: - exa -alT --git -I'*_' --color=always -L5 $(SpineSRC)/doc_reform $(SpinePROJ)/views | less -R + exa -alT --git -I'*_' --color=always -L5 $(SpineSRC)/sisudoc $(SpinePROJ)/views | less -R ## show markup pod source tree #tree-src-omit: @@ -494,13 +494,13 @@ gitZip: if [ ! -d "./tarballGitHEAD" ]; then \ mkdir ./tarballGitHEAD; \ fi; \ - git archive -v --format=tar --prefix=`echo spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT)`/ HEAD | gzip > ./tarballGitHEAD/spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT).tar.gz && \ - echo "to unzip: tar -xzf spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT).tar.gz" + git archive -v --format=tar --prefix=`echo spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT)`/ HEAD | gzip > ./tarballGitHEAD/sisudoc-spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT).tar.gz && \ + echo "to unzip: tar -xzf sisudoc-spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT).tar.gz" # git archive project, produce current state .tar.gz gitArchive: - git archive -v --format=tar --prefix=spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT)/ HEAD | gzip > ./tarballGitHEAD/spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT).tar.gz && \ - echo "to unzip: tar -xzf spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT).tar.gz" + git archive -v --format=tar --prefix=sisudoc-spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT)/ HEAD | gzip > ./tarballGitHEAD/sisudoc-spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT).tar.gz && \ + echo "to unzip: tar -xzf sisudoc-spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT).tar.gz" # remove test tarball dir nixGitHEADtarballClean: @@ -513,22 +513,22 @@ nixGitHEADtarballTar: if [ ! -d "./tarballGitHEAD" ]; then \ mkdir ./tarballGitHEAD; \ fi; \ - git archive -v --format=tar --prefix="spine-$${PROG_VER_DECLARED}/" HEAD | \ - gzip > ./tarballGitHEAD/spine-$${PROG_VER_DECLARED}-tag-$${PROG_VER_GIT}.tar.gz && \ - cp -v ./tarballGitHEAD/spine-$${PROG_VER_DECLARED}-tag-$${PROG_VER_GIT}.tar.gz ./tarballGitHEAD/spine-$${PROG_VER_DECLARED}.tar.gz && \ - echo "to unzip: tar -xzf spine-$${PROG_VER_DECLARED}-tag-$${PROG_VER_GIT}.tar.gz"; \ - echo "to unzip: tar -xzf spine-$${PROG_VER_DECLARED}.tar.gz" + git archive -v --format=tar --prefix="sisudoc-spine-$${PROG_VER_DECLARED}/" HEAD | \ + gzip > ./tarballGitHEAD/sisudoc-spine-$${PROG_VER_DECLARED}-tag-$${PROG_VER_GIT}.tar.gz && \ + cp -v ./tarballGitHEAD/sisudoc-spine-$${PROG_VER_DECLARED}-tag-$${PROG_VER_GIT}.tar.gz ./tarballGitHEAD/sisudoc-spine-$${PROG_VER_DECLARED}.tar.gz && \ + echo "to unzip: tar -xzf sisudoc-spine-$${PROG_VER_DECLARED}-tag-$${PROG_VER_GIT}.tar.gz"; \ + echo "to unzip: tar -xzf sisudoc-spine-$${PROG_VER_DECLARED}.tar.gz" # check test tarball nixGitHEADtarballCheck: - nix flake check file://$${hwd}/tarballGitHEAD/spine-$${PROG_VER_DECLARED}.tar.gz; \ - nix flake lock file://$${hwd}/tarballGitHEAD/spine-$${PROG_VER_DECLARED}.tar.gz; \ - nix flake show file://$${hwd}/tarballGitHEAD/spine-$${PROG_VER_DECLARED}.tar.gz; + nix flake check file://$${hwd}/tarballGitHEAD/sisudoc-spine-$${PROG_VER_DECLARED}.tar.gz; \ + nix flake lock file://$${hwd}/tarballGitHEAD/sisudoc-spine-$${PROG_VER_DECLARED}.tar.gz; \ + nix flake show file://$${hwd}/tarballGitHEAD/sisudoc-spine-$${PROG_VER_DECLARED}.tar.gz; # build test tarball nixGitHEADtarballBuild: - echo "nix build file://$${hwd}/tarballGitHEAD/spine-$${PROG_VER_DECLARED}.tar.gz#spine --print-build-logs"; \ - nix build file://$${hwd}/tarballGitHEAD/spine-$${PROG_VER_DECLARED}.tar.gz#spine --print-build-logs + echo "nix build file://$${hwd}/tarballGitHEAD/sisudoc-spine-$${PROG_VER_DECLARED}.tar.gz#spine --print-build-logs"; \ + nix build file://$${hwd}/tarballGitHEAD/sisudoc-spine-$${PROG_VER_DECLARED}.tar.gz#spine --print-build-logs # clean create check & build test tarball nixGitHEADtarball: nixGitHEADtarballClean nixGitHEADtarballTar nixGitHEADtarballCheck nixGitHEADtarballBuild @@ -745,7 +745,7 @@ distclean_and_init: expunge mkdir -p $(PRG_BINDIR); ver: - echo spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT) + echo sisudoc-spine-$(PROG_VER_DECLARED)-tag-$(PROG_VER_GIT) clean_tangle_build: clean tangle build @@ -1349,8 +1349,8 @@ gitsnapshot: distclean tangle git commit -a version_tag: - echo "DRV=<>; git tag -f doc-reform_v$$\{DRV} -m\"doc-reform spine-$$\{DRV}\" HEAD"; \ - echo "git tag -f doc-reform_v<> -m\"doc-reform spine-<>\" HEAD" + echo "DRV=<>; git tag -f sisudoc-spine_v$$\{DRV} -m\"doc-reform sisudoc spine-$$\{DRV}\" HEAD"; \ + echo "git tag -f sisudoc-spine_v<> -m\"doc-reform sisudoc spine-<>\" HEAD" .PHONY : all build rebuild release \ distclean init \ diff --git a/org/config_meson.org b/org/config_meson.org index e3a6c1d..9f2f27b 100644 --- a/org/config_meson.org +++ b/org/config_meson.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: configuration meson +#+TITLE: sisudoc configuration meson #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:hub: #+AUTHOR: Ralph Amissah @@ -24,7 +24,7 @@ #+NAME: spine_version #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> #+END_SRC *** subprojects @@ -125,45 +125,45 @@ project('spine', 'd', # error('spine cannot be compiled with GDC at time. Sorry.') #endif spine_src = [ - 'src/doc_reform/spine.d', - 'src/doc_reform/conf/compile_time_info.d', - 'src/doc_reform/io_in/paths_source.d', - 'src/doc_reform/io_in/read_config_files.d', - 'src/doc_reform/io_in/read_source_files.d', - 'src/doc_reform/io_out/cgi_sqlite_search_form.d', - 'src/doc_reform/io_out/create_zip_file.d', - 'src/doc_reform/io_out/defaults.d', - 'src/doc_reform/io_out/epub3.d', - 'src/doc_reform/io_out/html.d', - 'src/doc_reform/io_out/hub.d', - 'src/doc_reform/io_out/latex.d', - 'src/doc_reform/io_out/metadata.d', - 'src/doc_reform/io_out/odt.d', - 'src/doc_reform/io_out/package.d', - 'src/doc_reform/io_out/paths_output.d', - 'src/doc_reform/io_out/rgx.d', - 'src/doc_reform/io_out/source_pod.d', - 'src/doc_reform/io_out/sqlite.d', - 'src/doc_reform/io_out/xmls_css.d', - 'src/doc_reform/io_out/xmls.d', - 'src/doc_reform/meta/conf_make_meta_json.d', - 'src/doc_reform/meta/conf_make_meta_structs.d', - 'src/doc_reform/meta/conf_make_meta_yaml.d', - 'src/doc_reform/meta/defaults.d', - 'src/doc_reform/meta/doc_debugs.d', - 'src/doc_reform/meta/metadoc.d', - 'src/doc_reform/meta/metadoc_from_src.d', - 'src/doc_reform/meta/metadoc_curate.d', - 'src/doc_reform/meta/metadoc_curate_authors.d', - 'src/doc_reform/meta/metadoc_curate_topics.d', - 'src/doc_reform/meta/metadoc_object_setter.d', - 'src/doc_reform/meta/metadoc_show_config.d', - 'src/doc_reform/meta/metadoc_show_make.d', - 'src/doc_reform/meta/metadoc_show_metadata.d', - 'src/doc_reform/meta/metadoc_show_summary.d', - 'src/doc_reform/meta/package.d', - 'src/doc_reform/meta/rgx.d', - 'src/doc_reform/share/defaults.d', + 'src/sisudoc/spine.d', + 'src/sisudoc/conf/compile_time_info.d', + 'src/sisudoc/io_in/paths_source.d', + '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/defaults.d', + 'src/sisudoc/io_out/epub3.d', + 'src/sisudoc/io_out/html.d', + 'src/sisudoc/io_out/hub.d', + 'src/sisudoc/io_out/latex.d', + 'src/sisudoc/io_out/metadata.d', + 'src/sisudoc/io_out/odt.d', + 'src/sisudoc/io_out/package.d', + '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/xmls_css.d', + 'src/sisudoc/io_out/xmls.d', + 'src/sisudoc/meta/conf_make_meta_json.d', + 'src/sisudoc/meta/conf_make_meta_structs.d', + 'src/sisudoc/meta/conf_make_meta_yaml.d', + 'src/sisudoc/meta/defaults.d', + 'src/sisudoc/meta/doc_debugs.d', + 'src/sisudoc/meta/metadoc.d', + 'src/sisudoc/meta/metadoc_from_src.d', + 'src/sisudoc/meta/metadoc_curate.d', + 'src/sisudoc/meta/metadoc_curate_authors.d', + 'src/sisudoc/meta/metadoc_curate_topics.d', + 'src/sisudoc/meta/metadoc_object_setter.d', + 'src/sisudoc/meta/metadoc_show_config.d', + 'src/sisudoc/meta/metadoc_show_make.d', + 'src/sisudoc/meta/metadoc_show_metadata.d', + 'src/sisudoc/meta/metadoc_show_summary.d', + 'src/sisudoc/meta/package.d', + 'src/sisudoc/meta/rgx.d', + 'src/sisudoc/share/defaults.d', ] source_root = meson.source_root() src_dir = include_directories('src/') diff --git a/org/config_misc.org b/org/config_misc.org index 1f280a3..8d0de84 100644 --- a/org/config_misc.org +++ b/org/config_misc.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: configuration git +#+TITLE: sisudoc configuration git #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:hub: #+AUTHOR: Ralph Amissah @@ -19,7 +19,7 @@ ** sh script to batch process _emacs org babel tangle_ :shell_script:tangle: [[https://orgmode.org/manual/Batch-execution.html]] creates a shell batch script called "tangle", that will tangle (emacs org -babel tangle) org files in ./org/ to create .d source files in ./src/doc_reform/ +babel tangle) org files in ./org/ to create .d source files in ./src/sisudoc/ (similar functionality is contained within the "makefile" created by this "dr_build_scaffold.org" file make tangle) diff --git a/org/config_nix.org b/org/config_nix.org index bdf3239..0b4851a 100644 --- a/org/config_nix.org +++ b/org/config_nix.org @@ -640,7 +640,7 @@ installPhase = '' #+NAME: spine_version #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>> #+END_SRC *** nixpkgs path / url @@ -842,7 +842,7 @@ $SpineBIN/spine --very-verbose --sqlite-db-create --output="$SpineOUTversioned" ,*** sqlite db (shared) - populate db ,#+BEGIN_SRC sh -$SpineBIN/spine --very-verbose --sqlite-update --output="$SpineOUTversioned" $SpineDOC/spine-markup-samples/markup/pod/* +$SpineBIN/spine --very-verbose --sqlite-update --output="$SpineOUTversioned" $SpineDOC/sisudoc-spine-markup-samples/markup/pod/* ,#+END_SRC ,*** sqlite db (shared) - drop db diff --git a/org/default_imports.org b/org/default_imports.org index 44aad7f..5945d39 100644 --- a/org/default_imports.org +++ b/org/default_imports.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) hub +#+TITLE: sisudoc spine (doc_reform) hub #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:imports: #+AUTHOR: Ralph Amissah @@ -20,11 +20,11 @@ * imports for _meta_ :meta: ** package dir -#+HEADER: :tangle "../src/doc_reform/meta/package.d" +#+HEADER: :tangle "../src/sisudoc/meta/package.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.meta; +module sisudoc.meta; <> #+END_SRC @@ -33,7 +33,7 @@ module doc_reform.meta; #+NAME: imports_for_meta_general #+BEGIN_SRC d public import - doc_reform.meta.defaults; + sisudoc.meta.defaults; /+ std +/ public import std.array, @@ -51,11 +51,11 @@ public import * imports for _output_ :output: ** package dir -#+HEADER: :tangle "../src/doc_reform/io_out/package.d" +#+HEADER: :tangle "../src/sisudoc/io_out/package.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out; +module sisudoc.io_out; <> #+END_SRC @@ -78,10 +78,10 @@ public import // std.uni, std.utf; public import - doc_reform.share.defaults, - doc_reform.io_in.paths_source, - doc_reform.io_out.defaults, - doc_reform.io_out.paths_output; + sisudoc.share.defaults, + sisudoc.io_in.paths_source, + sisudoc.io_out.defaults, + sisudoc.io_out.paths_output; #+END_SRC * document header including copyright & license @@ -89,7 +89,7 @@ public import #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/default_misc.org b/org/default_misc.org index 22a9781..3b0b23f 100644 --- a/org/default_misc.org +++ b/org/default_misc.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) defaults misc +#+TITLE: sisudoc spine (doc_reform) defaults misc #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:default:misc: #+AUTHOR: Ralph Amissah @@ -21,14 +21,14 @@ ** _module template_ #+NAME: tangle_defaults -#+HEADER: :tangle "../src/doc_reform/meta/defaults.d" +#+HEADER: :tangle "../src/sisudoc/meta/defaults.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ default settings +/ -module doc_reform.meta.defaults; +module sisudoc.meta.defaults; @safe: <> <> @@ -172,14 +172,14 @@ template spineBiblio() { ** _module template_ #+NAME: tangle_defaults -#+HEADER: :tangle "../src/doc_reform/io_out/defaults.d" +#+HEADER: :tangle "../src/sisudoc/io_out/defaults.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ default settings +/ -module doc_reform.io_out.defaults; +module sisudoc.io_out.defaults; @safe: <> <> @@ -365,7 +365,7 @@ template spineLanguageCodes() { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/default_paths.org b/org/default_paths.org index 9e9770f..6a41ae6 100644 --- a/org/default_paths.org +++ b/org/default_paths.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) default paths +#+TITLE: sisudoc spine (doc_reform) default paths #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:paths: #+AUTHOR: Ralph Amissah @@ -20,7 +20,7 @@ * source paths ** _module template_ :module:paths_source: -#+HEADER: :tangle "../src/doc_reform/io_in/paths_source.d" +#+HEADER: :tangle "../src/sisudoc/io_in/paths_source.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> @@ -29,7 +29,7 @@ - read config files
meta_config_files.d +/ -module doc_reform.io_in.paths_source; +module sisudoc.io_in.paths_source; @safe: import std.array, @@ -39,8 +39,8 @@ import std.stdio, std.conv : to; import - doc_reform.meta.defaults, - doc_reform.meta.rgx_files; + sisudoc.meta.defaults, + sisudoc.meta.rgx_files; <> <> <> @@ -965,14 +965,14 @@ template spinePathsPods() { * output paths ** _module template_ :module:paths_output: -#+HEADER: :tangle "../src/doc_reform/io_out/paths_output.d" +#+HEADER: :tangle "../src/sisudoc/io_out/paths_output.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ default settings +/ -module doc_reform.io_out.paths_output; +module sisudoc.io_out.paths_output; @safe: import std.array, @@ -980,7 +980,7 @@ import std.regex, std.stdio; import - doc_reform.meta.rgx_files; + sisudoc.meta.rgx_files; <> <> <> @@ -1692,7 +1692,7 @@ template spinePathsSQLite() { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/default_regex.org b/org/default_regex.org index bce6fa6..ffd03f1 100644 --- a/org/default_regex.org +++ b/org/default_regex.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) regex defaults +#+TITLE: sisudoc spine (doc_reform) regex defaults #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:regex: #+AUTHOR: Ralph Amissah @@ -34,14 +34,14 @@ https://dlang.org/phobos/std_regex.html ** _module template_ :module: -#+HEADER: :tangle "../src/doc_reform/meta/rgx.d" +#+HEADER: :tangle "../src/sisudoc/meta/rgx.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ regex: regular expressions used in sisu document parser +/ -module doc_reform.meta.rgx; +module sisudoc.meta.rgx; @safe: static template spineRgxIn() { static struct RgxI { @@ -453,14 +453,14 @@ https://dlang.org/phobos/std_regex.html ** _module template_ :module:output: -#+HEADER: :tangle "../src/doc_reform/io_out/rgx.d" +#+HEADER: :tangle "../src/sisudoc/io_out/rgx.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ regex: regular expressions used in sisu document parser +/ -module doc_reform.io_out.rgx; +module sisudoc.io_out.rgx; @safe: static template spineRgxOut() { static struct RgxO { @@ -658,14 +658,14 @@ static table_delimiter_row = ctRegex!("[ ]*\n", "mg"); ** files filename (& path) (including insert file) :insert:file:path:filename: -#+HEADER: :tangle "../src/doc_reform/meta/rgx_files.d" +#+HEADER: :tangle "../src/sisudoc/meta/rgx_files.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ regex: regular expressions used in sisu document parser +/ -module doc_reform.meta.rgx_files; +module sisudoc.meta.rgx_files; @safe: static template spineRgxFiles() { static struct RgxFiles { @@ -692,14 +692,14 @@ static src_formalised_file_path_parts = ctRegex!(`(?P(?:[/a-zA-Z0 ** _module template yaml tags -#+HEADER: :tangle "../src/doc_reform/meta/rgx_yaml_tags.d" +#+HEADER: :tangle "../src/sisudoc/meta/rgx_yaml_tags.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ regex: regular expressions used in sisu document parser +/ -module doc_reform.meta.rgx_yaml; +module sisudoc.meta.rgx_yaml; @safe: static template spineRgxYamlTags() { static struct RgxYaml { @@ -719,14 +719,14 @@ static yaml_tag_is_seq = ctRegex!(`:seq$`); ** special characters *** xhtml special characters template -#+HEADER: :tangle "../src/doc_reform/io_out/rgx_xhtml.d" +#+HEADER: :tangle "../src/sisudoc/io_out/rgx_xhtml.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ regex: regular expressions used in sisu document parser +/ -module doc_reform.io_out.rgx_xhtml; +module sisudoc.io_out.rgx_xhtml; @safe: static template spineRgxXHTML() { static struct RgxXHTML { @@ -748,14 +748,14 @@ static line_break = ctRegex!(` [\\]{2}`, "m"); // *** LaTeX special characters template -#+HEADER: :tangle "../src/doc_reform/io_out/rgx_latex.d" +#+HEADER: :tangle "../src/sisudoc/io_out/rgx_latex.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ regex: regular expressions used in sisu document parser +/ -module doc_reform.io_out.rgx_latex; +module sisudoc.io_out.rgx_latex; @safe: static template spineRgxLSC() { static struct RgxLSC { @@ -785,7 +785,7 @@ static latex_clean_bookindex_linebreak = ctRegex!(`\s*\\\\\\\\\s*`, "m" #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/default_shared_snippets.org b/org/default_shared_snippets.org index 66041f3..b5fa945 100644 --- a/org/default_shared_snippets.org +++ b/org/default_shared_snippets.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) shared +#+TITLE: sisudoc spine (doc_reform) shared #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:default:shared: #+AUTHOR: Ralph Amissah @@ -20,11 +20,11 @@ * html snippet ** _module template_ :module: -#+HEADER: :tangle "../src/doc_reform/io_out/html_snippet.d" +#+HEADER: :tangle "../src/sisudoc/io_out/html_snippet.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.html_snippet; +module sisudoc.io_out.html_snippet; @safe: template htmlSnippet() { import @@ -34,9 +34,9 @@ template htmlSnippet() { std.uri, std.conv : to; import - doc_reform.io_out.rgx, - doc_reform.meta.rgx_files, - doc_reform.io_out.rgx_xhtml; + sisudoc.io_out.rgx, + sisudoc.meta.rgx_files, + sisudoc.io_out.rgx_xhtml; auto format_html_blank_page_guide_home()( string css_style, string home_url, @@ -83,14 +83,14 @@ template htmlSnippet() { * shared ** _module template_ :module:shared: -#+HEADER: :tangle "../src/doc_reform/share/defaults.d" +#+HEADER: :tangle "../src/sisudoc/share/defaults.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ shared default settings +/ -module doc_reform.share.defaults; +module sisudoc.share.defaults; @safe: <> #+END_SRC @@ -124,7 +124,7 @@ template Msg() { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/in_source_files.org b/org/in_source_files.org index 2e21928..90143f4 100644 --- a/org/in_source_files.org +++ b/org/in_source_files.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) markup source raw +#+TITLE: sisudoc spine (doc_reform) markup source raw #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:sourcefile:read: #+AUTHOR: Ralph Amissah @@ -20,7 +20,7 @@ * A. get _config file_, read in (.readText) [#A] ** _module template_ :module:config_files: -#+HEADER: :tangle "../src/doc_reform/io_in/read_config_files.d" +#+HEADER: :tangle "../src/sisudoc/io_in/read_config_files.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> @@ -29,16 +29,16 @@ - read config files
meta_config_files.d +/ -module doc_reform.io_in.read_config_files; +module sisudoc.io_in.read_config_files; @safe: import std.file, std.path; import - doc_reform.meta, - doc_reform.io_in.paths_source, - doc_reform.meta.rgx_files, - doc_reform.meta.rgx; + sisudoc.meta, + sisudoc.io_in.paths_source, + sisudoc.meta.rgx_files, + sisudoc.meta.rgx; <> <> <> @@ -190,10 +190,10 @@ static template readConfigDoc() { std.file, std.path; import - doc_reform.meta, - doc_reform.io_in.paths_source, - doc_reform.meta.rgx_files, - doc_reform.meta.rgx; + sisudoc.meta, + sisudoc.io_in.paths_source, + sisudoc.meta.rgx_files, + sisudoc.meta.rgx; @system final auto readConfigDoc(M,E)(M _manifested, E _env) { mixin spineRgxIn; static auto rgx = RgxI(); @@ -253,10 +253,10 @@ static template configReadSiteYAML() { std.file, std.path; import - doc_reform.meta, - doc_reform.io_in.paths_source, - doc_reform.meta.rgx_files, - doc_reform.meta.rgx; + sisudoc.meta, + sisudoc.io_in.paths_source, + sisudoc.meta.rgx_files, + sisudoc.meta.rgx; final YAMLDocument configReadSiteYAML(M,E)(M _manifested, E _env) { string _configuration = configReadInSiteYAML!()(_manifested, _env); auto _conf_file_details = configFilePaths!()(_manifested, _env); @@ -270,8 +270,8 @@ static template configReadDocYAML() { std.file, std.path; import - doc_reform.meta, - doc_reform.io_in.paths_source; + sisudoc.meta, + sisudoc.io_in.paths_source; final YAMLDocument configReadDocYAML(M,E)(M _manifested, E _env) { string _configuration = configReadInDocYAML!()(_manifested, _env); auto _conf_file_details = configFilePaths!()(_manifested, _env); @@ -285,7 +285,7 @@ static template configReadDocYAML() { * B. get _markup source_, read file (.readText) [#A]:module:source_files: ** _module template_ (includes tuple) -#+HEADER: :tangle "../src/doc_reform/io_in/read_source_files.d" +#+HEADER: :tangle "../src/sisudoc/io_in/read_source_files.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> @@ -294,17 +294,17 @@ static template configReadDocYAML() { - open markup files
- if master file scan for addional files to import/insert +/ -module doc_reform.io_in.read_source_files; +module sisudoc.io_in.read_source_files; @safe: template spineRawMarkupContent() { import std.file, std.path; import - doc_reform.meta, - doc_reform.io_in.paths_source, - doc_reform.meta.rgx_files, - doc_reform.meta.rgx; + sisudoc.meta, + sisudoc.io_in.paths_source, + sisudoc.meta.rgx_files, + sisudoc.meta.rgx; mixin spineRgxIn; static auto rgx = RgxI(); mixin spineRgxFiles; @@ -746,7 +746,7 @@ return t; #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/meta_conf_make_meta.org b/org/meta_conf_make_meta.org index 8b5fc12..f608a87 100644 --- a/org/meta_conf_make_meta.org +++ b/org/meta_conf_make_meta.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) config & header (make & meta) extract +#+TITLE: sisudoc spine (doc_reform) config & header (make & meta) extract #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:config: #+AUTHOR: Ralph Amissah @@ -227,16 +227,16 @@ import std.uni, std.utf, std.conv : to; -import doc_reform.meta.conf_make_meta_structs; +import sisudoc.meta.conf_make_meta_structs; #+END_SRC ** struct ConfComposite -#+HEADER: :tangle "../src/doc_reform/meta/conf_make_meta_structs.d" +#+HEADER: :tangle "../src/sisudoc/meta/conf_make_meta_structs.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.meta.conf_make_meta_structs; +module sisudoc.meta.conf_make_meta_structs; @safe: <> <> @@ -262,9 +262,9 @@ import std.utf, std.conv : to; import - doc_reform.meta.defaults, - doc_reform.meta.rgx_yaml, - doc_reform.meta.rgx; + sisudoc.meta.defaults, + sisudoc.meta.rgx_yaml, + sisudoc.meta.rgx; mixin spineRgxIn; static auto rgx = RgxI(); mixin spineRgxYamlTags; @@ -560,7 +560,7 @@ JSONValue config_jsonstr = `{ * YAML to spineStruct :module:conf_make_meta:yaml: ** _module template_ -#+HEADER: :tangle "../src/doc_reform/meta/conf_make_meta_yaml.d" +#+HEADER: :tangle "../src/sisudoc/meta/conf_make_meta_yaml.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> @@ -568,7 +568,7 @@ JSONValue config_jsonstr = `{ yaml headers
extract yaml header return struct +/ -module doc_reform.meta.conf_make_meta_yaml; +module sisudoc.meta.conf_make_meta_yaml; @safe: template contentYAMLtoSpineStruct() { import @@ -583,10 +583,10 @@ template contentYAMLtoSpineStruct() { std.utf, std.conv : to; import - doc_reform.meta.conf_make_meta_structs, - doc_reform.meta.defaults, - doc_reform.meta.rgx_yaml, - doc_reform.meta.rgx; + sisudoc.meta.conf_make_meta_structs, + sisudoc.meta.defaults, + sisudoc.meta.rgx_yaml, + sisudoc.meta.rgx; ConfComposite _struct_composite; @system auto contentYAMLtoSpineStruct(C,Y,M,O,Cfg)( C _struct_composite, @@ -1739,7 +1739,7 @@ if ("rights" in _yaml * JSON to spineStruct :module:conf_make_meta:json: ** _module template_ -#+HEADER: :tangle "../src/doc_reform/meta/conf_make_meta_json.d" +#+HEADER: :tangle "../src/sisudoc/meta/conf_make_meta_json.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> @@ -1747,7 +1747,7 @@ if ("rights" in _yaml json headers
extract json header return json +/ -module doc_reform.meta.conf_make_meta_json; +module sisudoc.meta.conf_make_meta_json; @safe: static template contentJSONtoSpineStruct() { import @@ -1761,10 +1761,10 @@ static template contentJSONtoSpineStruct() { std.utf, std.conv : to; import - doc_reform.meta.conf_make_meta_structs, - doc_reform.meta.conf_make_meta_json, - doc_reform.meta.defaults, - doc_reform.meta.rgx; + sisudoc.meta.conf_make_meta_structs, + sisudoc.meta.conf_make_meta_json, + sisudoc.meta.defaults, + sisudoc.meta.rgx; ConfComposite _struct_composite; auto contentJSONtoSpineStruct(C,J,M)(C _struct_composite, J _json, M _manifested, string _identifier) { mixin spineRgxIn; @@ -2419,8 +2419,8 @@ if ("rights" in _json.object) { template configParseYAMLreturnSpineStruct() { import dyaml; import - doc_reform.meta.conf_make_meta_structs, - doc_reform.meta.conf_make_meta_json; + sisudoc.meta.conf_make_meta_structs, + sisudoc.meta.conf_make_meta_json; mixin contentYAMLtoSpineStruct; @system auto configParseYAMLreturnSpineStruct(T,CCm,M,O,Cfg)( T _document_struct, @@ -2467,10 +2467,10 @@ template docHeaderMakeAndMetaTupYamlExtractAndConvertToStruct() { import dyaml; import - doc_reform.meta.conf_make_meta_structs, - doc_reform.meta.conf_make_meta_json, - doc_reform.meta.rgx_yaml, - doc_reform.meta.rgx; + sisudoc.meta.conf_make_meta_structs, + sisudoc.meta.conf_make_meta_json, + sisudoc.meta.rgx_yaml, + sisudoc.meta.rgx; mixin spineRgxIn; mixin contentJSONtoSpineStruct; static auto rgx = RgxI(); @@ -2503,7 +2503,7 @@ template docHeaderMakeAndMetaTupYamlExtractAndConvertToStruct() { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/meta_debugs.org b/org/meta_debugs.org index 0ec9599..fcf8e3c 100644 --- a/org/meta_debugs.org +++ b/org/meta_debugs.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) abstraction summary and debugs +#+TITLE: sisudoc spine (doc_reform) abstraction summary and debugs #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:debugs: #+AUTHOR: Ralph Amissah @@ -20,14 +20,14 @@ * abstraction debugs :module:spine:meta_doc_debugs: ** _module template_ -#+HEADER: :tangle "../src/doc_reform/meta/doc_debugs.d" +#+HEADER: :tangle "../src/sisudoc/meta/doc_debugs.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ output debugs +/ -module doc_reform.meta.doc_debugs; +module sisudoc.meta.doc_debugs; template spineDebugs() { <> auto spineDebugs(S,T)( @@ -53,8 +53,8 @@ template spineDebugs() { #+NAME: debug_imports #+BEGIN_SRC d import - doc_reform.meta.defaults, - doc_reform.meta.rgx_files; + sisudoc.meta.defaults, + sisudoc.meta.rgx_files; import std.algorithm, std.array, @@ -872,7 +872,7 @@ debug(checkdoc) { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/ocda.org b/org/ocda.org index 74c1f64..696c4c9 100644 --- a/org/ocda.org +++ b/org/ocda.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) object-centric document abstraction +#+TITLE: sisudoc spine (doc_reform) object-centric document abstraction #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:abstraction: #+AUTHOR: Ralph Amissah @@ -22,14 +22,14 @@ Process markup document, create document abstraction. ** _module template_ :module:metadoc_from_src: -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_from_src.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_from_src.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> // document abstraction: // abstraction of sisu markup for downstream processing // metadoc_from_src.d -module doc_reform.meta.metadoc_from_src; +module sisudoc.meta.metadoc_from_src; @safe: template docAbstraction() { <> @@ -58,12 +58,12 @@ import std.json, std.path; import - doc_reform.meta, - doc_reform.meta.defaults, - doc_reform.meta.rgx, - doc_reform.meta.metadoc_object_setter, - doc_reform.meta.rgx; -public import doc_reform.meta.metadoc_from_src_functions; + sisudoc.meta, + sisudoc.meta.defaults, + sisudoc.meta.rgx, + sisudoc.meta.metadoc_object_setter, + sisudoc.meta.rgx; +public import sisudoc.meta.metadoc_from_src_functions; mixin docAbstractionFunctions; #+END_SRC @@ -1550,7 +1550,7 @@ return ret; #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/ocda_functions.org b/org/ocda_functions.org index 00e391d..6c300f1 100644 --- a/org/ocda_functions.org +++ b/org/ocda_functions.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) object-centric document abstraction +#+TITLE: sisudoc spine (doc_reform) object-centric document abstraction #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:abstraction: #+AUTHOR: Ralph Amissah @@ -22,14 +22,14 @@ Process markup document, create document abstraction. ** _module + templates_ :module:metadoc_from_src: -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_from_src_functions.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_from_src_functions.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> // document abstraction: // abstraction of sisu markup for downstream processing // metadoc_from_src.d -module doc_reform.meta.metadoc_from_src_functions; +module sisudoc.meta.metadoc_from_src_functions; @safe: template docAbstractionFunctions() { <> @@ -54,11 +54,11 @@ import std.json, std.path; import - doc_reform.meta, - doc_reform.meta.defaults, - doc_reform.meta.rgx, - doc_reform.meta.metadoc_object_setter, - doc_reform.meta.rgx; + sisudoc.meta, + sisudoc.meta.defaults, + sisudoc.meta.rgx, + sisudoc.meta.metadoc_object_setter, + sisudoc.meta.rgx; // ↓ abstraction mixins mixin ObjectSetter; mixin InternalMarkup; @@ -5430,7 +5430,7 @@ auto docSectKeysSeq(string[][string] document_section_keys_sequenced) { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/ocda_obj_setter.org b/org/ocda_obj_setter.org index e009a67..5002ee2 100644 --- a/org/ocda_obj_setter.org +++ b/org/ocda_obj_setter.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) object-centric document abstraction +#+TITLE: sisudoc spine (doc_reform) object-centric document abstraction #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:abstraction: #+AUTHOR: Ralph Amissah @@ -23,7 +23,7 @@ set abstracted objects for downstream processing ** _module template_ -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_object_setter.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_object_setter.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> @@ -32,7 +32,7 @@ set abstracted objects for downstream processing setting of sisu objects for downstream processing metadoc_object_setter.d +/ -module doc_reform.meta.metadoc_object_setter; +module sisudoc.meta.metadoc_object_setter; @safe: template ObjectSetter() { /+ structs +/ @@ -447,7 +447,7 @@ static auto eN() { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_curate_metadata.org b/org/out_curate_metadata.org index 470fc17..40a47e7 100644 --- a/org/out_curate_metadata.org +++ b/org/out_curate_metadata.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_manifest) metadata (multidocument) curates +#+TITLE: sisudoc spine (doc_reform) metadata (multidocument) curates #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:hub: #+AUTHOR: Ralph Amissah @@ -26,11 +26,11 @@ ** _module template_ metadoc curate -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_curate.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_curate.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.meta.metadoc_curate; +module sisudoc.meta.metadoc_curate; @safe: template spineMetaDocCurate() { auto spineMetaDocCurate(T,H)( @@ -51,8 +51,8 @@ template spineMetaDocCurate() { #+NAME: metadoc_curate_imports #+BEGIN_SRC d import - doc_reform.meta.defaults, - doc_reform.meta.rgx; + sisudoc.meta.defaults, + sisudoc.meta.rgx; import std.array, std.exception, @@ -97,7 +97,7 @@ writefln( #+NAME: meta_metadoc_curate #+BEGIN_SRC d -import doc_reform.io_out.paths_output; +import sisudoc.io_out.paths_output; auto pth_html_abs = spinePathsHTML!()(doc_matters.output_path, doc_matters.src.language); auto pth_html_rel = spineDocRootTreeHTML!()(doc_matters.src.language); hvst.curate.title = doc_matters.conf_make_meta.meta.title_full; @@ -121,11 +121,11 @@ return hvst.curate; ** _module template_ metadoc curate topics *** _module template_ metadoc curate topics template -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_curate_topics.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_curate_topics.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.meta.metadoc_curate_topics; +module sisudoc.meta.metadoc_curate_topics; @safe: import std.algorithm, @@ -136,8 +136,8 @@ module doc_reform.meta.metadoc_curate_topics; std.string, std.conv : to; import - doc_reform.meta.defaults, - doc_reform.meta.rgx; + sisudoc.meta.defaults, + sisudoc.meta.rgx; mixin spineCurateMetadata; mixin InternalMarkup; template spineMetaDocCuratesTopics() { @@ -451,7 +451,7 @@ foreach(k0; #+NAME: curated_topics_html_write #+BEGIN_SRC d -import doc_reform.io_out.paths_output; +import sisudoc.io_out.paths_output; auto out_pth = spinePathsHTML!()(_make_and_meta_struct.conf.output_path, ""); try { auto f = File(out_pth.curate("topics.html"), "w"); @@ -466,11 +466,11 @@ try { ** _module template_ metadoc curates authors *** _module template_ metadoc curate authors -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_curate_authors.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_curate_authors.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.meta.metadoc_curate_authors; +module sisudoc.meta.metadoc_curate_authors; @safe: import std.algorithm, @@ -481,8 +481,8 @@ module doc_reform.meta.metadoc_curate_authors; std.string, std.conv : to; import - doc_reform.meta.defaults, - doc_reform.meta.rgx; + sisudoc.meta.defaults, + sisudoc.meta.rgx; mixin spineCurateMetadata; mixin InternalMarkup; template spineMetaDocCuratesAuthors() { @@ -614,7 +614,7 @@ template spineMetaDocCuratesAuthors() { #+NAME: curated_authors_html_write #+BEGIN_SRC d -import doc_reform.io_out.paths_output; +import sisudoc.io_out.paths_output; auto out_pth = spinePathsHTML!()(_make_and_meta_struct.conf.output_path, ""); try { auto f = File(out_pth.curate("authors.html"), "w"); @@ -1023,7 +1023,7 @@ string inline_search_form(M)( #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_latex.org b/org/out_latex.org index 8783da8..daafd37 100644 --- a/org/out_latex.org +++ b/org/out_latex.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) output latex +#+TITLE: sisudoc spine (doc_reform) output latex #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:latex:pdf: #+AUTHOR: Ralph Amissah @@ -22,11 +22,11 @@ ** _module template_ :latex:pdf:module: *** latex.d module & templates -#+HEADER: :tangle "../src/doc_reform/io_out/latex.d" +#+HEADER: :tangle "../src/sisudoc/io_out/latex.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.latex; +module sisudoc.io_out.latex; @safe: <> <> @@ -134,7 +134,7 @@ template outputLaTeX() { #+HEADER: :noweb yes #+BEGIN_SRC d template outputLaTeXstyInit() { - import doc_reform.io_out; + import sisudoc.io_out; auto paper = paperLaTeX; <> <> @@ -218,7 +218,7 @@ void writeOutputLaTeX(T,M)( } } if (!exists(pth_latex.latex_path_stuff ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_latex.latex_path_stuff ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -232,7 +232,7 @@ void writeOutputLaTeX(T,M)( } // should be in latex init and done just once, doc_matters not passed there though if (!exists(pth_latex.base ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_latex.base ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -244,7 +244,7 @@ void writeOutputLaTeX(T,M)( )); } if (!exists(pth_latex.base_sty ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_latex.base_sty ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -670,9 +670,9 @@ import std.uri, std.conv : to; import - doc_reform.io_out, - doc_reform.io_out.rgx, - doc_reform.io_out.rgx_latex; + sisudoc.io_out, + sisudoc.io_out.rgx, + sisudoc.io_out.rgx_latex; mixin spineRgxOut; static auto rgx = RgxO(); mixin spineRgxLSC; @@ -2409,7 +2409,7 @@ string _latex_tail = format(q"┃ #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_metadata.org b/org/out_metadata.org index e048abd..31cc9a9 100644 --- a/org/out_metadata.org +++ b/org/out_metadata.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_manifest) metadata (document curate) +#+TITLE: sisudoc spine (doc_reform) metadata (document curate) #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:metadata: #+AUTHOR: Ralph Amissah @@ -21,11 +21,11 @@ ** _module template_ metadoc document metadata -#+HEADER: :tangle "../src/doc_reform/io_out/metadata.d" +#+HEADER: :tangle "../src/sisudoc/io_out/metadata.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.metadata; +module sisudoc.io_out.metadata; @safe: template outputMetadata() { void outputMetadata(T)( T doc_matters) { @@ -50,7 +50,7 @@ template outputMetadata() { import std.file, std.format; -import doc_reform.io_out; +import sisudoc.io_out; mixin InternalMarkup; string[] metadata_; #+END_SRC @@ -60,7 +60,7 @@ string[] metadata_; #+NAME: output_metadata #+BEGIN_SRC d static auto mkup = InlineMarkup(); -import doc_reform.io_out.html_snippet; +import sisudoc.io_out.html_snippet; mixin htmlSnippet; if (doc_matters.opt.action.debug_do) { writeln(doc_matters.src.filename_base); @@ -288,7 +288,7 @@ void metadata_write_output(M)(M doc_matters, string[] metadata_) { } } if (!exists(pth_html.base ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_html.base ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -678,7 +678,7 @@ string inline_search_form(M)( #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_odt.org b/org/out_odt.org index 022fdc7..048fd11 100644 --- a/org/out_odt.org +++ b/org/out_odt.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: doc_reform output odt +#+TITLE: sisudoc spine (doc_reform) output odt #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:xml:odt: #+AUTHOR: Ralph Amissah @@ -46,11 +46,11 @@ ** _module template_ :odf:odt:module: -#+HEADER: :tangle "../src/doc_reform/io_out/odt.d" :noweb yes +#+HEADER: :tangle "../src/sisudoc/io_out/odt.d" :noweb yes #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.odt; +module sisudoc.io_out.odt; @safe: template formatODT() { <> @@ -974,7 +974,7 @@ string table(O,M)( } } if (!exists(pth_odt.base_pth ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_odt.base_pth ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -1042,9 +1042,9 @@ void outputODT(D,I)( #+NAME: output_imports #+BEGIN_SRC d import - doc_reform.io_out, - doc_reform.io_out.rgx, - doc_reform.io_out.rgx_xhtml; + sisudoc.io_out, + sisudoc.io_out.rgx, + sisudoc.io_out.rgx_xhtml; import std.digest.sha, std.file, @@ -1053,9 +1053,9 @@ import std.zip, std.conv : to; import - doc_reform.io_out.create_zip_file, - doc_reform.io_out.xmls, - doc_reform.io_out.xmls_css; + sisudoc.io_out.create_zip_file, + sisudoc.io_out.xmls, + sisudoc.io_out.xmls_css; #+END_SRC *** make directory tree @@ -1065,7 +1065,7 @@ import void dirtree(I)( I doc_matters, ) { - import doc_reform.io_out.paths_output; + import sisudoc.io_out.paths_output; auto pth_odt = spinePathsODT!()(doc_matters); if (doc_matters.opt.action.debug_do) { /+ (dir tree) +/ if (!exists(pth_odt.meta_inf_dir("fs"))) { @@ -1079,7 +1079,7 @@ void dirtree(I)( pth_odt.base_pth.mkdirRecurse; } if (!exists(pth_odt.base_pth ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_odt.base_pth ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -2477,7 +2477,7 @@ string odt_body(D,I)( #+NAME: output_odt_variable_content_xml_12 #+BEGIN_SRC d string odt_tail() { - string _odt_tail = format(q"┃spine: <www.doc_reform.org> and <www.sisudoc.org> + string _odt_tail = format(q"┃spine: <www.sisudoc.org> and <www.sisudoc.org> ┃",); return _odt_tail; } @@ -2584,7 +2584,7 @@ void images_cp(M)( auto ref M doc_matters, ) { { /+ (copy odt images) +/ - import doc_reform.io_out.paths_output; + import sisudoc.io_out.paths_output; auto pth_odt = spinePathsODT!()(doc_matters); foreach (image; doc_matters.srcs.image_list) { auto fn_src_in = doc_matters.src.image_dir_path ~ "/" ~ image; @@ -2608,7 +2608,7 @@ void images_cp(M)( #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_sqlite.org b/org/out_sqlite.org index ade8498..991c4ad 100644 --- a/org/out_sqlite.org +++ b/org/out_sqlite.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) output sqlite +#+TITLE: sisudoc spine (doc_reform) output sqlite #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:db:sql:sqlite: #+AUTHOR: Ralph Amissah @@ -41,11 +41,11 @@ sudo chown ralph:ralph /var/www ** _module, templates_ :module: *** template -#+HEADER: :tangle "../src/doc_reform/io_out/sqlite.d" +#+HEADER: :tangle "../src/sisudoc/io_out/sqlite.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.sqlite; +module sisudoc.io_out.sqlite; <> <> <> @@ -580,9 +580,9 @@ db.close; #+NAME: sqlite_imports #+BEGIN_SRC d import - doc_reform.io_out, - doc_reform.io_out.rgx, - doc_reform.io_out.rgx_xhtml; + sisudoc.io_out, + sisudoc.io_out.rgx, + sisudoc.io_out.rgx_xhtml; import std.file, std.uri; @@ -2187,7 +2187,7 @@ VALUES ( #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_src_pod.org b/org/out_src_pod.org index 883572f..9accccb 100644 --- a/org/out_src_pod.org +++ b/org/out_src_pod.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) output pod +#+TITLE: sisudoc spine (doc_reform) output pod #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:source:pod: #+AUTHOR: Ralph Amissah @@ -21,11 +21,11 @@ * pod ** _module template_ :module: -#+HEADER: :tangle "../src/doc_reform/io_out/source_pod.d" +#+HEADER: :tangle "../src/sisudoc/io_out/source_pod.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.source_pod; +module sisudoc.io_out.source_pod; @system: // is not @safe: use: @system: or @trusted: template spinePod() { <> @@ -50,8 +50,8 @@ template spinePod() { #+NAME: output_imports #+BEGIN_SRC d import - doc_reform.meta.rgx_files, - doc_reform.io_out; + sisudoc.meta.rgx_files, + sisudoc.io_out; import std.digest.sha, std.file, @@ -59,8 +59,8 @@ import std.zip, std.conv : to; import - doc_reform.io_out.create_zip_file, - doc_reform.io_out.xmls; + sisudoc.io_out.create_zip_file, + sisudoc.io_out.xmls; #+END_SRC *** init @@ -145,7 +145,7 @@ if (doc_matters.opt.action.source_or_pod) { } } if (!exists(pths_pod.pod_dir_() ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pths_pod.pod_dir_() ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -457,7 +457,7 @@ if (exists(fn_pod)) { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_xmls.org b/org/out_xmls.org index e9f8d79..c3b9aab 100644 --- a/org/out_xmls.org +++ b/org/out_xmls.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) output xmls +#+TITLE: sisudoc spine (doc_reform) output xmls #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:xml: #+AUTHOR: Ralph Amissah @@ -27,11 +27,11 @@ ** format xhtml objects :format: *** _module template_ :module: -#+HEADER: :tangle "../src/doc_reform/io_out/xmls.d" +#+HEADER: :tangle "../src/sisudoc/io_out/xmls.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.xmls; +module sisudoc.io_out.xmls; @safe: template outputXHTMLs() { <> @@ -97,13 +97,13 @@ import std.uri, std.conv : to; import - doc_reform.io_out, - doc_reform.io_out.rgx, - doc_reform.meta.rgx_files, - doc_reform.io_out.rgx_xhtml, - doc_reform.io_out.create_zip_file, - doc_reform.io_out.xmls, - doc_reform.io_out.xmls_css; + sisudoc.io_out, + sisudoc.io_out.rgx, + sisudoc.meta.rgx_files, + sisudoc.io_out.rgx_xhtml, + sisudoc.io_out.create_zip_file, + sisudoc.io_out.xmls, + sisudoc.io_out.xmls_css; #+END_SRC **** epub3 @@ -117,12 +117,12 @@ import std.zip, std.conv : to; import - doc_reform.io_out, - doc_reform.io_out.rgx, - doc_reform.io_out.rgx_xhtml, - doc_reform.io_out.create_zip_file, - doc_reform.io_out.xmls, - doc_reform.io_out.xmls_css; + sisudoc.io_out, + sisudoc.io_out.rgx, + sisudoc.io_out.rgx_xhtml, + sisudoc.io_out.create_zip_file, + sisudoc.io_out.xmls, + sisudoc.io_out.xmls_css; #+END_SRC *** misc @@ -1757,11 +1757,11 @@ string table(O,M)( * _html_ [#A] :html: ** _module template_ :module: -#+HEADER: :tangle "../src/doc_reform/io_out/html.d" +#+HEADER: :tangle "../src/sisudoc/io_out/html.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.html; +module sisudoc.io_out.html; @safe: template outputHTML() { <> @@ -2022,7 +2022,7 @@ scroll_write_output(doc, doc_matters); } } if (!exists(pth_html.base ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_html.base ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -2397,7 +2397,7 @@ void css(M)(M doc_matters) { f.writeln(css.html_scroll); } if (!exists(pth_html.css ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_html.css ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -2441,7 +2441,7 @@ void css(M)(M doc_matters) { } } if (!exists(pth_html.image ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_html.image ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -2476,11 +2476,11 @@ void css(M)(M doc_matters) { ** _module template_ :module: -#+HEADER: :tangle "../src/doc_reform/io_out/epub3.d" +#+HEADER: :tangle "../src/sisudoc/io_out/epub3.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.epub3; +module sisudoc.io_out.epub3; @safe: template outputEPub3() { <> @@ -3185,7 +3185,7 @@ zip -0 file.epub mimetype && zip -r -9 file.epub META-INF OEBPS pth_epub3.base.mkdirRecurse; } if (!exists(pth_epub3.base ~ "/index.html")) { - import doc_reform.io_out.html_snippet; + import sisudoc.io_out.html_snippet; mixin htmlSnippet; auto f = File(pth_epub3.base ~"/index.html", "w"); f.writeln(format_html_blank_page_guide_home( @@ -3365,7 +3365,7 @@ zip -0 file.epub mimetype && zip -r -9 file.epub META-INF OEBPS #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_xmls_css.org b/org/out_xmls_css.org index 9e0d10a..4e099de 100644 --- a/org/out_xmls_css.org +++ b/org/out_xmls_css.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) defaults css +#+TITLE: sisudoc spine (doc_reform) defaults css #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:xmls:css: #+AUTHOR: Ralph Amissah @@ -21,14 +21,14 @@ * output css defaults :module:spine:output_xmls_css: ** _module template_ -#+HEADER: :tangle "../src/doc_reform/io_out/xmls_css.d" +#+HEADER: :tangle "../src/sisudoc/io_out/xmls_css.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> /++ default css settings +/ -module doc_reform.io_out.xmls_css; +module sisudoc.io_out.xmls_css; @safe: template spineCss() { import std.format; @@ -2507,7 +2507,7 @@ p[indent="h9i9"] { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/out_zip.org b/org/out_zip.org index 1302d18..7b4b365 100644 --- a/org/out_zip.org +++ b/org/out_zip.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) output zip +#+TITLE: sisudoc spine (doc_reform) output zip #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:zip: #+AUTHOR: Ralph Amissah @@ -21,11 +21,11 @@ * _zip_ :module:spine:create_zip_file: ** module template -#+HEADER: :tangle "../src/doc_reform/io_out/create_zip_file.d" +#+HEADER: :tangle "../src/sisudoc/io_out/create_zip_file.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.io_out.create_zip_file; +module sisudoc.io_out.create_zip_file; @safe: template createZipFile() { import @@ -51,7 +51,7 @@ template createZipFile() { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/output_hub.org b/org/output_hub.org index a6a2db1..b73c582 100644 --- a/org/output_hub.org +++ b/org/output_hub.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine(doc_reform) output hub +#+TITLE: sisudoc spine(doc_reform) output hub #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:hub: #+AUTHOR: Ralph Amissah @@ -20,7 +20,7 @@ * output hub [#A] ** _module template_ :module: -#+HEADER: :tangle "../src/doc_reform/io_out/hub.d" +#+HEADER: :tangle "../src/sisudoc/io_out/hub.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> @@ -28,7 +28,7 @@ output hub
check & generate output types requested +/ -module doc_reform.io_out.hub; +module sisudoc.io_out.hub; @safe: template outputHub() { <> @@ -69,9 +69,9 @@ template outputHub() { } template outputHubInitialize() { import std.file; - import doc_reform.io_out, - doc_reform.io_out.metadata, - doc_reform.io_out.paths_output; + import sisudoc.io_out, + sisudoc.io_out.metadata, + sisudoc.io_out.paths_output; string _bespoke_homepage = "./spine-bespoke-output/html/homepage.index.html"; @system void outputHubInitialize(O,I)( O opt_action, @@ -96,7 +96,7 @@ template outputHubInitialize() { && opt_action.output_dir_set.length > 0 && !(isValidPath(opt_action.output_dir_set ~ "/latex/sty"))) ) { // .sty need to be produced only once (if unchanged per output-dir of which there usually will be only one) - import doc_reform.io_out.latex; + import sisudoc.io_out.latex; outputLaTeXstyInit!()( opt_action.output_dir_set, opt_action.generated_by, @@ -120,11 +120,11 @@ template outputHubOp() { #+NAME: output_imports #+BEGIN_SRC d -import doc_reform.io_out, - doc_reform.io_out.metadata, - doc_reform.io_out.xmls, - doc_reform.io_out.create_zip_file, - doc_reform.io_out.paths_output; +import sisudoc.io_out, + sisudoc.io_out.metadata, + sisudoc.io_out.xmls, + sisudoc.io_out.create_zip_file, + sisudoc.io_out.paths_output; #+END_SRC ** outputs @@ -139,7 +139,7 @@ if (sched == outTask.source_or_pod) { if (doc_matters.opt.action.pod) { msg.v("spine (doc reform) source pod processing... "); } - import doc_reform.io_out.source_pod; + import sisudoc.io_out.source_pod; spinePod!()(doc_matters); if (doc_matters.opt.action.source) { msg.vv("spine (doc reform) source done"); @@ -156,7 +156,7 @@ if (sched == outTask.source_or_pod) { #+BEGIN_SRC d if (sched == outTask.epub) { msg.v("epub3 processing... "); - import doc_reform.io_out.epub3; + import sisudoc.io_out.epub3; doc_abstraction.outputEPub3!()(doc_matters); msg.vv("epub3 done"); } @@ -179,7 +179,7 @@ if (sched == outTask.html_stuff) { #+BEGIN_SRC d if (sched == outTask.html_scroll) { msg.v("html scroll processing... "); - import doc_reform.io_out.html; + import sisudoc.io_out.html; outputHTML!().scroll(doc_abstraction, doc_matters); msg.vv("html scroll done"); } @@ -191,7 +191,7 @@ if (sched == outTask.html_scroll) { #+BEGIN_SRC d if (sched == outTask.html_seg) { msg.v("html seg processing... "); - import doc_reform.io_out.html; + import sisudoc.io_out.html; outputHTML!().seg(doc_abstraction, doc_matters); msg.vv("html seg done"); } @@ -202,7 +202,7 @@ if (sched == outTask.html_seg) { #+NAME: output_scheduled_task_html_out #+BEGIN_SRC d if (sched == outTask.html_stuff) { - import doc_reform.io_out.html; + import sisudoc.io_out.html; outputHTML!().css(doc_matters); outputHTML!().images_cp(doc_matters); msg.vv("html css & images done"); @@ -224,7 +224,7 @@ if (sched == outTask.html_stuff) { #+BEGIN_SRC d if (sched == outTask.latex) { msg.v("latex processing... (available for downstream processing & pdf output"); - import doc_reform.io_out.latex; + import sisudoc.io_out.latex; import std.file; if ((isValidPath(doc_matters.output_path ~ "/latex/sty")) && (!(exists(doc_matters.output_path ~ "/latex/sty"))) @@ -247,7 +247,7 @@ if (sched == outTask.latex) { #+BEGIN_SRC d if (sched == outTask.odt) { msg.v("odf:odt processing... "); - import doc_reform.io_out.odt; + import sisudoc.io_out.odt; outputODT!()(doc_abstraction, doc_matters); msg.vv("odf:odt done"); } @@ -259,7 +259,7 @@ if (sched == outTask.odt) { #+BEGIN_SRC d if (sched == outTask.sqlite) { msg.v("sqlite processing... "); - import doc_reform.io_out.sqlite; + import sisudoc.io_out.sqlite; doc_abstraction.SQLiteHubDiscreteBuildTablesAndPopulate!()(doc_matters); msg.vv("sqlite done"); } @@ -273,12 +273,12 @@ if (sched == outTask.sqlite) { #+BEGIN_SRC d if (doc_matters.opt.action.sqlite_update) { msg.v("sqlite update processing..."); - import doc_reform.io_out.sqlite; + import sisudoc.io_out.sqlite; doc_abstraction.SQLiteHubBuildTablesAndPopulate!()(doc_matters); msg.vv("sqlite update done"); } else if (doc_matters.opt.action.sqlite_delete) { msg.v("sqlite delete processing..."); - import doc_reform.io_out.sqlite; + import sisudoc.io_out.sqlite; doc_abstraction.SQLiteHubBuildTablesAndPopulate!()(doc_matters); msg.vv("sqlite delete done"); } @@ -293,7 +293,7 @@ if ((opt_action.sqlite_db_drop)) { if ((opt_action.vox_gt1)) { writeln("sqlite drop db..."); } - import doc_reform.io_out.sqlite; + import sisudoc.io_out.sqlite; SQLiteDbDrop!()(opt_action, config); if ((opt_action.vox_gt2)) { writeln("sqlite drop db done"); @@ -310,7 +310,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 doc_reform.io_out.sqlite; + import sisudoc.io_out.sqlite; SQLiteTablesCreate!()(env, opt_action, config); if ((opt_action.vox_gt2)) { writeln("sqlite create table done"); @@ -323,7 +323,7 @@ if ((opt_action.sqlite_db_create)) { #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/output_show.org b/org/output_show.org index 0247176..f5e4c68 100644 --- a/org/output_show.org +++ b/org/output_show.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) metadata (multidocument) curates +#+TITLE: sisudoc spine (doc_reform) metadata (multidocument) curates #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:hub: #+AUTHOR: Ralph Amissah @@ -21,11 +21,11 @@ ** _module template_ metadoc summary - document summary from abstraction -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_show_summary.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_show_summary.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.meta.metadoc_show_summary; +module sisudoc.meta.metadoc_show_summary; @safe: template spineMetaDocSummary() { void spineMetaDocSummary(S,T)( @@ -141,7 +141,7 @@ writefln( ** _module template_ show config *** _show config tangle -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_show_config.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_show_config.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> @@ -155,7 +155,7 @@ writefln( #+NAME: spine_show_site_config #+HEADER: :noweb yes #+BEGIN_SRC d -module doc_reform.meta.metadoc_show_config; +module sisudoc.meta.metadoc_show_config; @safe: template spineShowSiteConfig() { void spineShowSiteConfig(O,T)( @@ -337,11 +337,11 @@ writefln( ** _module template_ show make --show-make (show document make) -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_show_make.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_show_make.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.meta.metadoc_show_make; +module sisudoc.meta.metadoc_show_make; @safe: template spineShowMake() { void spineShowMake(T)( @@ -411,11 +411,11 @@ writefln( ** _module template_ show metadata --show-metadata (show document metadata) -#+HEADER: :tangle "../src/doc_reform/meta/metadoc_show_metadata.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc_show_metadata.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.meta.metadoc_show_metadata; +module sisudoc.meta.metadoc_show_metadata; @safe: template spineShowMetaData() { void spineShowMetaData(T)( @@ -553,8 +553,8 @@ import #+NAME: metadoc_show_summary_imports #+BEGIN_SRC d import - doc_reform.meta.defaults, - doc_reform.meta.rgx; + sisudoc.meta.defaults, + sisudoc.meta.rgx; #+END_SRC *** initialize :report: @@ -575,7 +575,7 @@ char_repeat_number = (char_repeat_number > min_repeat_number) #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+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..14cccaf --- /dev/null +++ b/org/sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org @@ -0,0 +1,109 @@ +-*- 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 - 2024 Ralph Amissah +#+LANGUAGE: en +#+STARTUP: content hideblocks hidestars noindent entitiespretty +#+PROPERTY: header-args :noweb yes +#+PROPERTY: header-args+ :exports code +#+PROPERTY: header-args+ :results no +#+PROPERTY: header-args+ :cache no +#+PROPERTY: header-args+ :padline 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 - 2024 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 + +* spine version info SET VERSION +** version in full + +#+NAME: spine_project_version +#+BEGIN_SRC org +<>.<>.<> +#+END_SRC + +** version parts (major, minor, patch) + +#+NAME: spine_project_version_major_minor_patch +#+BEGIN_SRC org +<>, <>, <> +#+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 +16 +#+END_SRC + +*** patch + +#+NAME: spine_project_version_part_patch +#+BEGIN_SRC org +0 +#+END_SRC diff --git a/org/spine.org b/org/spine.org index 30585a6..ac9f552 100644 --- a/org/spine.org +++ b/org/spine.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine ≅ (doc-reform) hub +#+TITLE: sisudoc spine ≅ (doc-reform) hub #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:hub: #+AUTHOR: Ralph Amissah @@ -36,12 +36,12 @@ - by sourcefiles contents identifier - by zip filename -#+HEADER: :tangle "../src/doc_reform/spine.d" +#+HEADER: :tangle "../src/sisudoc/spine.d" #+HEADER: :shebang "#!/usr/bin/env rdmd" #+HEADER: :noweb yes #+BEGIN_SRC d <> -module doc_reform.sisu_document_parser; +module sisudoc.sisu_document_parser; /++ name "spine" description "A SiSU inspired document parser written in D." @@ -108,7 +108,7 @@ string program_name = "spine"; spineMetaDocCuratesAuthors!()(hvst.curates, _make_and_meta_struct, _opt_action); } if (_opt_action.vox_gt0) { - import doc_reform.io_out.paths_output; + import sisudoc.io_out.paths_output; auto out_pth = spinePathsHTML!()(_make_and_meta_struct.conf.output_path, ""); if (_opt_action.curate_authors) { writeln("- ", out_pth.curate("authors.html")); @@ -136,24 +136,24 @@ import std.path, std.process; import - doc_reform.conf.compile_time_info, - doc_reform.meta, - doc_reform.meta.metadoc, - doc_reform.meta.metadoc_curate, - doc_reform.meta.metadoc_curate_authors, - doc_reform.meta.metadoc_curate_topics, - doc_reform.meta.metadoc_from_src, - doc_reform.meta.conf_make_meta_structs, - doc_reform.meta.conf_make_meta_json, - doc_reform.meta.defaults, - doc_reform.meta.doc_debugs, - doc_reform.meta.rgx, - doc_reform.meta.rgx_yaml, - doc_reform.meta.rgx_files, - doc_reform.io_in.paths_source, - doc_reform.io_in.read_config_files, - doc_reform.io_in.read_source_files, - doc_reform.io_out.hub; + sisudoc.conf.compile_time_info, + sisudoc.meta, + sisudoc.meta.metadoc, + sisudoc.meta.metadoc_curate, + sisudoc.meta.metadoc_curate_authors, + sisudoc.meta.metadoc_curate_topics, + sisudoc.meta.metadoc_from_src, + sisudoc.meta.conf_make_meta_structs, + sisudoc.meta.conf_make_meta_json, + sisudoc.meta.defaults, + sisudoc.meta.doc_debugs, + sisudoc.meta.rgx, + sisudoc.meta.rgx_yaml, + sisudoc.meta.rgx_files, + sisudoc.io_in.paths_source, + sisudoc.io_in.read_config_files, + sisudoc.io_in.read_source_files, + sisudoc.io_out.hub; #+END_SRC ***** spine metadoc :spine: @@ -163,20 +163,20 @@ import import std.datetime; import - doc_reform.meta, - doc_reform.meta.metadoc_from_src, - doc_reform.meta.conf_make_meta_structs, - doc_reform.meta.conf_make_meta_json, - doc_reform.meta.defaults, - doc_reform.io_in.paths_source, - doc_reform.io_in.read_config_files, - doc_reform.io_in.read_source_files, - doc_reform.io_out.hub; + sisudoc.meta, + sisudoc.meta.metadoc_from_src, + sisudoc.meta.conf_make_meta_structs, + sisudoc.meta.conf_make_meta_json, + sisudoc.meta.defaults, + sisudoc.io_in.paths_source, + sisudoc.io_in.read_config_files, + sisudoc.io_in.read_source_files, + sisudoc.io_out.hub; #+END_SRC ****** notes ├── src -│   ├── doc_reform.d +│   ├── sisudoc.d │   └── spine │ ├── conf │ ├── meta @@ -1031,7 +1031,7 @@ if ( { /+ local site config +/ _conf_file_details = configFilePaths!()(_manifested, _env, _opt_action.config_path_set); auto _config_local_site_struct = readConfigSite!()(_conf_file_details, _opt_action, _cfg); - import doc_reform.meta.conf_make_meta_yaml; + import sisudoc.meta.conf_make_meta_yaml; _siteConfig = _config_local_site_struct.configParseYAMLreturnSpineStruct!()(_siteConfig, _manifested, _opt_action, _cfg); // - get local site config break; } @@ -1039,11 +1039,11 @@ if ( } } else { /+ local site config +/ auto _config_local_site_struct = readConfigSite!()(_conf_file_details, _opt_action, _cfg); - import doc_reform.meta.conf_make_meta_yaml; + import sisudoc.meta.conf_make_meta_yaml; _siteConfig = _config_local_site_struct.configParseYAMLreturnSpineStruct!()(_siteConfig, _manifested, _opt_action, _cfg); // - get local site config } if (_opt_action.show_config) { - import doc_reform.meta.metadoc_show_config; + import sisudoc.meta.metadoc_show_config; spineShowSiteConfig!()(_opt_action, _siteConfig); } #+END_SRC @@ -1242,7 +1242,7 @@ foreach(arg; args[1..$]) { #+BEGIN_SRC d { /+ document config/make file +/ auto _config_document_struct = readConfigDoc!()(_manifest, _env); - import doc_reform.meta.conf_make_meta_yaml; + import sisudoc.meta.conf_make_meta_yaml; _make_and_meta_struct = _config_document_struct.configParseYAMLreturnSpineStruct!()(_make_and_meta_struct, _manifest, _opt_action, _cfg); } #+END_SRC @@ -1322,7 +1322,7 @@ if ((doc_matters.opt.action.debug_do) #+BEGIN_SRC d /+ ↓ debugs +/ if (doc_matters.opt.action.show_summary) { - import doc_reform.meta.metadoc_show_summary; + import sisudoc.meta.metadoc_show_summary; spineMetaDocSummary!()(doc_abstraction, doc_matters); } #+END_SRC @@ -1334,7 +1334,7 @@ if (doc_matters.opt.action.show_summary) { #+BEGIN_SRC d /+ ↓ debugs +/ if (doc_matters.opt.action.show_metadata) { - import doc_reform.meta.metadoc_show_metadata; + import sisudoc.meta.metadoc_show_metadata; spineShowMetaData!()(doc_matters); } #+END_SRC @@ -1346,7 +1346,7 @@ if (doc_matters.opt.action.show_metadata) { #+BEGIN_SRC d /+ ↓ debugs +/ if (doc_matters.opt.action.show_make) { - import doc_reform.meta.metadoc_show_make; + import sisudoc.meta.metadoc_show_make; spineShowMake!()(doc_matters); } #+END_SRC @@ -1358,7 +1358,7 @@ if (doc_matters.opt.action.show_make) { #+BEGIN_SRC d /+ ↓ debugs +/ if (doc_matters.opt.action.show_config) { - import doc_reform.meta.metadoc_show_config; + import sisudoc.meta.metadoc_show_config; spineShowConfig!()(doc_matters); } #+END_SRC @@ -1455,10 +1455,10 @@ break; // terminate, stop *** 0 module template - abstraction template -#+HEADER: :tangle "../src/doc_reform/meta/metadoc.d" +#+HEADER: :tangle "../src/sisudoc/meta/metadoc.d" #+BEGIN_SRC d <> -module doc_reform.meta.metadoc; +module sisudoc.meta.metadoc; @safe: template spineAbstraction() { <> @@ -1565,7 +1565,7 @@ if ((_opt_action.debug_do) ) { writeln("step2 commence → (read document header (yaml) return struct) [", _manifest.src.filename, "]"); } -import doc_reform.meta.conf_make_meta_yaml; +import sisudoc.meta.conf_make_meta_yaml; _make_and_meta_struct = docHeaderMakeAndMetaTupYamlExtractAndConvertToStruct!()( _header_body_insertfilelist_imagelist[headBody.header], @@ -1832,7 +1832,7 @@ if ((_opt_action.debug_do) #+NAME: doc_header_including_copyright_and_license #+HEADER: :noweb yes #+BEGIN_SRC emacs-lisp -<<./spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> +<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>> #+END_SRC * __END__ diff --git a/org/spine_info.org b/org/spine_info.org index d22563a..4cfa865 100644 --- a/org/spine_info.org +++ b/org/spine_info.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) information files +#+TITLE: sisudoc spine (doc_reform) information files #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:info: #+AUTHOR: Ralph Amissah @@ -59,7 +59,7 @@ #+NAME: sisu_spine_readme_org_header #+BEGIN_SRC text -*- mode: org -*- -#+TITLE: spine (doc_reform) (project) README +#+TITLE: spine (sisudoc) (project) README #+DESCRIPTION: README for spine #+FILETAGS: :spine:build:tools: #+AUTHOR: Ralph Amissah @@ -4756,9 +4756,9 @@ matches are found. <> #+END_SRC -*** code source ./src/doc_reform +*** code source ./src/sisudoc -#+HEADER: :tangle "../src/doc_reform/COPYRIGHT" +#+HEADER: :tangle "../src/sisudoc/COPYRIGHT" #+HEADER: :noweb yes #+BEGIN_SRC txt - Name: spine - SiSU Spine, Doc Reform @@ -4819,7 +4819,7 @@ matches are found. #+NAME: sisu_spine_license_agpl3 #+BEGIN_SRC txt -- code under src/* src/doc_reform/* +- code under src/* src/sisudoc/* - License: AGPL 3 or later: Spine, Doc Reform (SiSU), a framework for document structuring, publishing and @@ -4864,7 +4864,7 @@ matches are found. #+BEGIN_SRC txt - Homepages: [https://www.sisudoc.org] - [https://www.doc-reform.org] + [https://www.sisudoc.org] - Git [] diff --git a/org/spine_version_info_and_doc_header_including_copyright_and_license.org b/org/spine_version_info_and_doc_header_including_copyright_and_license.org deleted file mode 100644 index 13e1723..0000000 --- a/org/spine_version_info_and_doc_header_including_copyright_and_license.org +++ /dev/null @@ -1,109 +0,0 @@ --*- mode: org -*- -#+TITLE: 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 - 2024 Ralph Amissah -#+LANGUAGE: en -#+STARTUP: content hideblocks hidestars noindent entitiespretty -#+PROPERTY: header-args :noweb yes -#+PROPERTY: header-args+ :exports code -#+PROPERTY: header-args+ :results no -#+PROPERTY: header-args+ :cache no -#+PROPERTY: header-args+ :padline 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: 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 - 2024 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 - -* spine version info SET VERSION -** version in full - -#+NAME: spine_project_version -#+BEGIN_SRC org -<>.<>.<> -#+END_SRC - -** version parts (major, minor, patch) - -#+NAME: spine_project_version_major_minor_patch -#+BEGIN_SRC org -<>, <>, <> -#+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 -15 -#+END_SRC - -*** patch - -#+NAME: spine_project_version_part_patch -#+BEGIN_SRC org -0 -#+END_SRC diff --git a/org/util_spine_markup_conversion_from_sisu.org b/org/util_spine_markup_conversion_from_sisu.org index 2453711..99852b0 100644 --- a/org/util_spine_markup_conversion_from_sisu.org +++ b/org/util_spine_markup_conversion_from_sisu.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) information files +#+TITLE: sisudoc spine (doc_reform) information files #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:info: #+AUTHOR: Ralph Amissah diff --git a/org/util_spine_syntax_highlighting_emacs.org b/org/util_spine_syntax_highlighting_emacs.org index 52364d7..00f82a6 100644 --- a/org/util_spine_syntax_highlighting_emacs.org +++ b/org/util_spine_syntax_highlighting_emacs.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) information files +#+TITLE: sisudoc spine (doc_reform) information files #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:info: #+AUTHOR: Ralph Amissah diff --git a/org/util_spine_syntax_highlighting_vim.org b/org/util_spine_syntax_highlighting_vim.org index 94d2dab..bd9aa6d 100644 --- a/org/util_spine_syntax_highlighting_vim.org +++ b/org/util_spine_syntax_highlighting_vim.org @@ -1,5 +1,5 @@ -*- mode: org -*- -#+TITLE: spine (doc_reform) information files +#+TITLE: sisudoc spine (doc_reform) information files #+DESCRIPTION: documents - structuring, various output representations & search #+FILETAGS: :spine:info: #+AUTHOR: Ralph Amissah -- cgit v1.2.3