aboutsummaryrefslogtreecommitdiffhomepage
path: root/org/spine.org
diff options
context:
space:
mode:
Diffstat (limited to 'org/spine.org')
-rw-r--r--org/spine.org84
1 files changed, 49 insertions, 35 deletions
diff --git a/org/spine.org b/org/spine.org
index 5c66ce6..58d76ed 100644
--- a/org/spine.org
+++ b/org/spine.org
@@ -4,30 +4,43 @@
#+FILETAGS: :spine:hub:
#+AUTHOR: Ralph Amissah
#+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]]
-#+COPYRIGHT: Copyright (C) 2015 - 2019 Ralph Amissah
+#+COPYRIGHT: Copyright (C) 2015 - 2020 Ralph Amissah
#+LANGUAGE: en
-#+STARTUP: indent content hideblocks hidestars
-#+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t
-#+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc
-#+OPTIONS: author:nil email:nil creator:nil timestamp:nil
-#+PROPERTY: header-args :results silent :padline no :exports code :cache no :noweb yes
-#+EXPORT_SELECT_TAGS: export
-#+EXPORT_EXCLUDE_TAGS: noexport
-#+TAGS: assert(a) class(c) debug(d) mixin(m) spine(s) tangle(T) template(t) WEB(W) noexport(n)
+#+STARTUP: content hideblocks hidestars noindent entitiespretty
+#+PROPERTY: header-args :exports code
+#+PROPERTY: header-args+ :noweb yes
+#+PROPERTY: header-args+ :eval no
+#+PROPERTY: header-args+ :results no
+#+PROPERTY: header-args+ :cache no
+#+PROPERTY: header-args+ :padline no
[[../maker.org][maker.org makefile]] [[./][org/]]
* 0. version.txt (set version) :version:
-** set program version
-- set program version
+** 0. set program tangle
-#+BEGIN_SRC d :tangle "../views/version.txt"
-/+ obt - org generated file +/
+#+BEGIN_SRC txt :tangle "../views/version.txt"
+<<spine_version_struct>>
+<<spine_version_current_set>>
+<<spine_compiler_restrictions>>
+#+END_SRC
+
+** program version struct
+
+#+NAME: spine_version_struct
+#+BEGIN_SRC d
+/+ obt - org-mode generated file +/
struct Version {
int major;
int minor;
int patch;
}
+#+END_SRC
+
+** TODO set program version
+
+#+NAME: spine_version_current_set
+#+BEGIN_SRC d
enum _ver = Version(0, 9, 2);
#+END_SRC
@@ -36,7 +49,8 @@ enum _ver = Version(0, 9, 2);
http://dlang.org/spec/version.html#predefined-versions
-#+BEGIN_SRC d :tangle "../views/version.txt"
+#+NAME: spine_compiler_restrictions
+#+BEGIN_SRC d
version (Posix) {
version (DigitalMars) {
} else version (LDC) {
@@ -60,14 +74,14 @@ version (Posix) {
- process file
- output
-** 0. spine src/spine :template:
+** 0. spine src/spine :template:
- process files (act according to requirements of each type)
- by sourcefilename
- by sourcefiles contents identifier
- by zip filename
-#+BEGIN_SRC d :tangle "../src/doc_reform/spine.d" :shebang #!/usr/bin/env rdmd
+#+BEGIN_SRC d :tangle "../src/doc_reform/spine.d" :shebang "#!/usr/bin/env rdmd"
<<doc_header_including_copyright_and_license>>
module doc_reform.sisu_document_parser;
import
@@ -143,7 +157,7 @@ homepage "http://sisudoc.org"
*** document header including copyright & license
#+NAME: doc_header_including_copyright_and_license
-#+BEGIN_SRC text
+#+BEGIN_SRC txt
/+
- Name: Spine, Doc Reform
- Description: documents, structuring, processing, publishing, search
@@ -152,7 +166,7 @@ homepage "http://sisudoc.org"
- Author: Ralph Amissah
[ralph.amissah@gmail.com]
- - Copyright: (C) 2015 - 2019 Ralph Amissah, All Rights
+ - Copyright: (C) 2015 - 2020 Ralph Amissah, All Rights
Reserved.
- License: AGPL 3 or later:
@@ -197,10 +211,10 @@ homepage "http://sisudoc.org"
+/
#+END_SRC
-** 1. pre-loop init :init:
+** 1. pre-loop init :init:
*** init
-**** imports :import:
-***** spine :spine:
+**** imports :import:
+***** spine :spine:
#+NAME: imports_spine
#+BEGIN_SRC d
@@ -248,8 +262,8 @@ import
keep up to date, configuration in ../maker.org
-**** mixins :mixin:
-***** version.txt :version:
+**** mixins :mixin:
+***** version.txt :version:
#+NAME: mixin_spine_version
#+BEGIN_SRC d
@@ -263,7 +277,7 @@ mixin(import("version.txt"));
mixin CompileTimeInfo;
#+END_SRC
-***** spine "main" mixins :spine:
+***** spine "main" mixins :spine:
#+NAME: spine_mixin
#+BEGIN_SRC d
@@ -274,14 +288,14 @@ mixin spineRgxInitFlags;
mixin outputHub;
#+END_SRC
-**** init :init:
+**** init :init:
#+NAME: spine_init
#+BEGIN_SRC d
auto hvst = spineHarvest!();
#+END_SRC
-**** args :args:
+**** args :args:
#+NAME: spine_init
#+BEGIN_SRC d
@@ -291,7 +305,7 @@ enum dAM { abstraction, matters }
static auto rgx = Rgx();
#+END_SRC
-*** scope (run complete) :scope:
+*** scope (run complete) :scope:
#+NAME: spine_init
#+BEGIN_SRC d
@@ -313,7 +327,7 @@ scope(failure) {
}
#+END_SRC
-*** getopt args for loop :args:getopt:
+*** getopt args for loop :args:getopt:
**** set getopt options
- set getopt options
@@ -967,8 +981,8 @@ if (!(_opt_action.skip_output)) {
}
#+END_SRC
-** _2. processing: (loop each file)_ [+2] :loop:files:
-*** scope (loop) :scope:
+** _2. processing: (loop each file)_ [+2] :loop:files:
+*** scope (loop) :scope:
#+NAME: spine_each_file_do_scope
#+BEGIN_SRC d
@@ -1076,7 +1090,7 @@ if (doc_matters.opt.action.show_config
}
#+END_SRC
-***** abstraction harvest :abstraction:harvest:
+***** abstraction harvest :abstraction:harvest:
- abstraction harvest
#+NAME: spine_each_file_do_debugs_checkdoc
@@ -1098,7 +1112,7 @@ if (doc_matters.opt.action.harvest) {
}
#+END_SRC
-**** 1. _debug_ (document parts, checkdoc) :debug:checkdoc:
+**** 1. _debug_ (document parts, checkdoc) :debug:checkdoc:
- [[./meta_output_debugs.org][meta_output_debugs]]
#+NAME: spine_each_file_do_debugs_checkdoc
@@ -1109,7 +1123,7 @@ if (doc_matters.opt.action.debug_do) {
}
#+END_SRC
-**** 2. _process outputs_ :outputs:
+**** 2. _process outputs_ :outputs:
- [[./output_hub.org][output_hub]]
#+NAME: spine_each_file_do_selected_output
@@ -1130,7 +1144,7 @@ if (!(doc_matters.opt.action.skip_output)) {
}
#+END_SRC
-*** scope (on loop exit) :scope:exit:
+*** scope (on loop exit) :scope:exit:
#+NAME: spine_each_file_do_scope_exit
#+BEGIN_SRC d
@@ -1155,7 +1169,7 @@ break; // terminate, stop
#+END_SRC
* 2. pre-processing
-** Output _document abstraction functions_ :module:spine:abstraction:
+** Output _document abstraction functions_ :module:spine:abstraction:
*** 0 module template
- abstraction template