aboutsummaryrefslogtreecommitdiffhomepage
path: root/org/spine.org
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2020-10-28 09:38:33 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2020-11-09 14:29:49 -0500
commit5f62c5b7d84e4ab3fe2e48e799d16630c2b6f216 (patch)
tree41811554315437db55965422345b5cc5589a690c /org/spine.org
parentldc current, ldc-1.24.0 available on nix 21.03 (diff)
org tags
Diffstat (limited to 'org/spine.org')
-rw-r--r--org/spine.org434
1 files changed, 218 insertions, 216 deletions
diff --git a/org/spine.org b/org/spine.org
index ebd5e95..30a08f5 100644
--- a/org/spine.org
+++ b/org/spine.org
@@ -15,9 +15,10 @@
#+PROPERTY: header-args+ :cache no
#+PROPERTY: header-args+ :padline no
-[[../maker.org][maker.org makefile]] [[./][org/]]
+[[./spine_info.org][spine_info.org]] [[./][org/]]
+[[./spine_build_scaffold.org][make/build]] VERSION
-* 0. version.txt (set version) :version:
+* 0. version.txt (set version) :version:
** 0. set program tangle
#+BEGIN_SRC txt :tangle "../views/version.txt"
@@ -38,7 +39,7 @@ struct Version {
}
#+END_SRC
-** TODO set program version
+** set program version VERSION :version:set:project:
#+NAME: spine_version_current_set
#+BEGIN_SRC d
@@ -64,7 +65,7 @@ version (Posix) {
}
#+END_SRC
-* 1. spine (sisu document parser) :spine:
+* 1. spine (sisu document parser) :spine:
** notes
- deal with imports
- get options
@@ -75,7 +76,7 @@ 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
@@ -227,10 +228,10 @@ string program_name = "spine";
+/
#+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
@@ -260,7 +261,7 @@ import
doc_reform.io_out.hub;
#+END_SRC
-***** spine metadoc :spine:
+***** spine metadoc :spine:
#+NAME: imports_spine_metadoc
#+BEGIN_SRC d
@@ -298,10 +299,11 @@ import
[[./output.org][output]]
[[./spine.org][spine]]
-keep up to date, configuration in ../maker.org
+keep up to date, configuration in
+[[./spine_build_scaffold.org][make/build]]
-**** mixins :mixin:
-***** version.txt :version:
+**** mixins :mixin:
+***** version.txt :version:
#+NAME: mixin_spine_version
#+BEGIN_SRC d
@@ -315,7 +317,7 @@ mixin(import("version.txt"));
mixin CompileTimeInfo;
#+END_SRC
-***** spine "main" mixins :spine:
+***** spine "main" mixins :spine:
#+NAME: spine_mixin
#+BEGIN_SRC d
@@ -324,14 +326,14 @@ mixin spineBiblio;
mixin outputHub;
#+END_SRC
-**** init :init:
+**** init :init:
#+NAME: spine_init_0
#+BEGIN_SRC d
auto hvst = spineHarvest!();
#+END_SRC
-**** args :args:
+**** args :args:
#+NAME: spine_init_1
#+BEGIN_SRC d
@@ -341,7 +343,7 @@ enum dAM { abstraction, matters }
static auto rgx = RgxI();
#+END_SRC
-*** scope (run complete) :scope:
+*** scope (run complete) :scope:
#+NAME: spine_init_2
#+BEGIN_SRC d
@@ -363,7 +365,7 @@ scope(failure) {
}
#+END_SRC
-*** getopt args for loop :args:getopt:
+*** getopt args for loop :args:getopt:
**** set getopt options
- set getopt options
***** initialize
@@ -1113,8 +1115,8 @@ foreach(arg; args[1..$]) {
}
#+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
@@ -1219,7 +1221,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_4
@@ -1241,7 +1243,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_5
@@ -1252,7 +1254,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
@@ -1273,7 +1275,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
@@ -1298,7 +1300,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
@@ -1876,21 +1878,21 @@ dev notes
** spine glossary / terms
-|------------+-------------------------------------|
-| spine | sisu document parser |
-|------------+-------------------------------------|
-| dmso | document markup, structure, objects |
-|------------+-------------------------------------|
-| meta | meta document, document abstraction |
-| mda | meta, meta document abstraction |
-| adr | abstract document representation |
-| dar | document abstract representation |
-| (da) | (document abstraction) |
-| | (code representation of document) |
-|------------+-------------------------------------|
-| ao | abstract objects |
-| | (code representation of objects) |
-|------------+-------------------------------------|
+|-------+-------------------------------------|
+| spine | sisu document parser |
+|-------+-------------------------------------|
+| dmso | document markup, structure, objects |
+|-------+-------------------------------------|
+| meta | meta document, document abstraction |
+| mda | meta, meta document abstraction |
+| adr | abstract document representation |
+| dar | document abstract representation |
+| (da) | (document abstraction) |
+| | (code representation of document) |
+|-------+-------------------------------------|
+| ao | abstract objects |
+| | (code representation of objects) |
+|-------+-------------------------------------|
consider
|-------+----------------------------------------------|
@@ -1944,180 +1946,180 @@ provide the result as a single set of make instructions for each document parsed
*** config & metadata (from instruction sources)
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | 1. document make file | 2. config file | 3. document header | 4. command line instruction |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| comment, fixed: | per dir (pod) | per dir | per document (pod) | per command instruction |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | config_document | config_local_site | | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| local site specific | | * | | *? |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | webserv | | |
-| | | - url_root | | |
-| | | - path | | |
-| | | - images | | |
-| | | - cgi | | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | webserv_cgi | | |
-| | | - host | | |
-| | | - base_path | | |
-| | | - port | | |
-| | | - user | | |
-| | | - file_links | | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | processing | | |
-| | | - path | | |
-| | | - dir | | |
-| | | - concord_max | | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | flag (configure) | | (call) |
-| | | - act0 | | act0 |
-| | | - act1 | | act1 |
-| | | - act2 | | act2 |
-| | | - act3 | | act3 |
-| | | - act4 | | act4 |
-| | | - act5 | | act5 |
-| | | - act6 | | act6 |
-| | | - act7 | | act7 |
-| | | - act8 | | act8 |
-| | | - act9 | | act9 |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | default | | |
-| | | - papersize | | |
-| | | - text_wrap | | |
-| | | - emphasis | | |
-| | | - language | | |
-| | | - digest | | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | permission | | |
-| | | - share_source | | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | program_select | | |
-| | | - editor | | |
-| | | - epub_viewer | | |
-| | | - html_viewer | | |
-| | | - odf_viewer | | |
-| | | - pdf_viewer | | |
-| | | - xml_viewer | | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | search | | |
-| | | - flag | | |
-| | | - action | | |
-| | | - db | | |
-| | | - title | | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| make instruction | ** | omit or override share? | ** | *? |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | make | make | make | |
-| | - bold | - bold | - bold | |
-| | - breaks | - breaks | - breaks | |
-| | - cover_image | - cover_image | - cover_image | |
-| | - css | - css | - css | |
-| | - emphasis | - emphasis | - emphasis | |
-| | - footer | - footer | - footer | |
-| | - headings | - headings | - headings | |
-| | - home_button_image | - home_button_image | - home_button_image | |
-| | - home_button_text | - home_button_text | - home_button_text | |
-| | - italics | - italics | - italics | |
-| | - num_top | - num_top | - num_top | |
-| | - auto_num_depth | - auto_num_depth | - auto_num_depth | |
-| | - substitute | - substitute | - substitute | |
-| | - texpdf_font | - texpdf_font | - texpdf_font | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| actions | | | | * |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | | assertions |
-| | | | | concordance |
-| | | | | debug |
-| | | | | digest |
-| | | | | docbook |
-| | | | | epub |
-| | | | | html |
-| | | | | html-seg |
-| | | | | html-scroll |
-| | | | | manifest |
-| | | | | ocn |
-| | | | | odt |
-| | | | | pdf |
-| | | | | postgresql |
-| | | | | qrcode |
-| | | | | pod |
-| | | | | source |
-| | | | | sqlite |
-| | | | | sqlite-db-create |
-| | | | | sqlite-db-drop |
-| | | | | text |
-| | | | | verbose |
-| | | | | xhtml |
-| | | | | xml-dom |
-| | | | | xml-sax |
-| | | | | section_toc |
-| | | | | section_body |
-| | | | | section_endnotes |
-| | | | | section_glossary |
-| | | | | section_biblio |
-| | | | | section_bookindex |
-| | | | | section_blurb |
-| | | | | backmatter |
-| | | | | skip-output |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| metadata | | | * | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | classify | |
-| | | | - dewey | |
-| | | | - keywords | |
-| | | | - loc | |
-| | | | - subject | |
-| | | | - topic_register | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | creator | |
-| | | | - author | |
-| | | | - author_email | |
-| | | | - illustrator | |
-| | | | - translator | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | date | |
-| | | | - added_to_site | |
-| | | | - available | |
-| | | | - created | |
-| | | | - issued | |
-| | | | - modified | |
-| | | | - published | |
-| | | | - valid | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | identifier | |
-| | | | - isbn | |
-| | | | - oclc | |
-| | | | - pg | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | links | |
-| | | | - link | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | notes | |
-| | | | - abstract | |
-| | | | - description | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | original | |
-| | | | - language | |
-| | | | - source | |
-| | | | - title | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | publisher | |
-| | | | - name | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | rights | |
-| | | | - copyright | |
-| | | | - cover | |
-| | | | - illustrations | |
-| | | | - license | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
-| | | | title | |
-| | | | - edition | |
-| | | | - full | |
-| | | | - language | |
-| | | | - main | |
-| | | | - note | |
-| | | | - sub | |
-| | | | - subtitle | |
-|---------------------+--------------------------+----------------------------+---------------------+-----------------------------|
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | 1. document make file | 2. config file | 3. document header | 4. command line instruction |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| comment, fixed: | per dir (pod) | per dir | per document (pod) | per command instruction |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | config_document | config_local_site | | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| local site specific | | * | | *? |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | webserv | | |
+| | | - url_root | | |
+| | | - path | | |
+| | | - images | | |
+| | | - cgi | | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | webserv_cgi | | |
+| | | - host | | |
+| | | - base_path | | |
+| | | - port | | |
+| | | - user | | |
+| | | - file_links | | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | processing | | |
+| | | - path | | |
+| | | - dir | | |
+| | | - concord_max | | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | flag (configure) | | (call) |
+| | | - act0 | | act0 |
+| | | - act1 | | act1 |
+| | | - act2 | | act2 |
+| | | - act3 | | act3 |
+| | | - act4 | | act4 |
+| | | - act5 | | act5 |
+| | | - act6 | | act6 |
+| | | - act7 | | act7 |
+| | | - act8 | | act8 |
+| | | - act9 | | act9 |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | default | | |
+| | | - papersize | | |
+| | | - text_wrap | | |
+| | | - emphasis | | |
+| | | - language | | |
+| | | - digest | | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | permission | | |
+| | | - share_source | | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | program_select | | |
+| | | - editor | | |
+| | | - epub_viewer | | |
+| | | - html_viewer | | |
+| | | - odf_viewer | | |
+| | | - pdf_viewer | | |
+| | | - xml_viewer | | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | search | | |
+| | | - flag | | |
+| | | - action | | |
+| | | - db | | |
+| | | - title | | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| make instruction | ** | omit or override share? | ** | *? |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | make | make | make | |
+| | - bold | - bold | - bold | |
+| | - breaks | - breaks | - breaks | |
+| | - cover_image | - cover_image | - cover_image | |
+| | - css | - css | - css | |
+| | - emphasis | - emphasis | - emphasis | |
+| | - footer | - footer | - footer | |
+| | - headings | - headings | - headings | |
+| | - home_button_image | - home_button_image | - home_button_image | |
+| | - home_button_text | - home_button_text | - home_button_text | |
+| | - italics | - italics | - italics | |
+| | - num_top | - num_top | - num_top | |
+| | - auto_num_depth | - auto_num_depth | - auto_num_depth | |
+| | - substitute | - substitute | - substitute | |
+| | - texpdf_font | - texpdf_font | - texpdf_font | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| actions | | | | * |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | | assertions |
+| | | | | concordance |
+| | | | | debug |
+| | | | | digest |
+| | | | | docbook |
+| | | | | epub |
+| | | | | html |
+| | | | | html-seg |
+| | | | | html-scroll |
+| | | | | manifest |
+| | | | | ocn |
+| | | | | odt |
+| | | | | pdf |
+| | | | | postgresql |
+| | | | | qrcode |
+| | | | | pod |
+| | | | | source |
+| | | | | sqlite |
+| | | | | sqlite-db-create |
+| | | | | sqlite-db-drop |
+| | | | | text |
+| | | | | verbose |
+| | | | | xhtml |
+| | | | | xml-dom |
+| | | | | xml-sax |
+| | | | | section_toc |
+| | | | | section_body |
+| | | | | section_endnotes |
+| | | | | section_glossary |
+| | | | | section_biblio |
+| | | | | section_bookindex |
+| | | | | section_blurb |
+| | | | | backmatter |
+| | | | | skip-output |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| metadata | | | * | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | classify | |
+| | | | - dewey | |
+| | | | - keywords | |
+| | | | - loc | |
+| | | | - subject | |
+| | | | - topic_register | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | creator | |
+| | | | - author | |
+| | | | - author_email | |
+| | | | - illustrator | |
+| | | | - translator | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | date | |
+| | | | - added_to_site | |
+| | | | - available | |
+| | | | - created | |
+| | | | - issued | |
+| | | | - modified | |
+| | | | - published | |
+| | | | - valid | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | identifier | |
+| | | | - isbn | |
+| | | | - oclc | |
+| | | | - pg | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | links | |
+| | | | - link | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | notes | |
+| | | | - abstract | |
+| | | | - description | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | original | |
+| | | | - language | |
+| | | | - source | |
+| | | | - title | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | publisher | |
+| | | | - name | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | rights | |
+| | | | - copyright | |
+| | | | - cover | |
+| | | | - illustrations | |
+| | | | - license | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
+| | | | title | |
+| | | | - edition | |
+| | | | - full | |
+| | | | - language | |
+| | | | - main | |
+| | | | - note | |
+| | | | - sub | |
+| | | | - subtitle | |
+|---------------------+-----------------------+-------------------------+---------------------+-----------------------------|
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-06 19:50:05 +0000