From d528fb1689e8e3c00557af57455c892d3c813b15 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 15 Oct 2018 10:04:49 -0400 Subject: org headings & tags, minor --- org/compile_time_info.org | 4 ++-- org/default_paths.org | 10 ++++---- org/default_regex.org | 8 +++---- org/default_shared.org | 4 ++-- org/imports.org | 5 ++-- org/meta_abstraction.org | 4 ++-- org/meta_conf_make_meta.org | 4 ++-- org/output_hub.org | 57 ++++++++++++++++++++++++++++++++++----------- org/output_sqlite.org | 8 +++---- org/output_src_pod.org | 12 +++++----- org/output_xmls.org | 16 ++++++------- org/source_files_read.org | 6 ++--- 12 files changed, 84 insertions(+), 54 deletions(-) diff --git a/org/compile_time_info.org b/org/compile_time_info.org index 49702a2..7f0a10f 100644 --- a/org/compile_time_info.org +++ b/org/compile_time_info.org @@ -14,14 +14,14 @@ #+TAGS: assert(a) class(c) debug(d) mixin(m) doc_reform(s) tangle(T) template(t) WEB(W) noexport(n) [[./doc_reform.org][doc_reform]] [[./][org/]] -* compilation info :module:doc_reform:compile_time_info: +* compilation info [[../maker.org][maker.org makefile]] [[./doc_reform.org][doc_reform hub]] [[./][org/]] e.g. do on linux bsd osx not windows: version(Windows) {} else { ... } -** 0. module template +** 0. module template :module:compile_time_info: #+begin_src d :tangle ../src/doc_reform/conf/compile_time_info.d /++ diff --git a/org/default_paths.org b/org/default_paths.org index 5299e3d..29f084f 100644 --- a/org/default_paths.org +++ b/org/default_paths.org @@ -14,8 +14,8 @@ #+TAGS: assert(a) class(c) debug(d) mixin(m) doc_reform(s) tangle(T) template(t) WEB(W) noexport(n) [[./doc_reform.org][doc_reform]] [[./][org/]] -* 0. source paths :module:doc_reform:paths_source: -** 0. module template +* 0. source paths +** 0. module template :module:paths_source: #+BEGIN_SRC d :tangle ../src/doc_reform/source/paths_source.d /++ @@ -551,7 +551,7 @@ template ConfigFilePaths() { } #+END_SRC -** _pod_ (including generated bundled source) :pod: +** _pod_ (including generated bundled source) :pod: *** notes tree pod @@ -901,8 +901,8 @@ template DocReformPathsPods() { } #+END_SRC -* 1. output paths :module:doc_reform:paths_output: -** 0. module template +* 1. output paths +** 0. module template :module:paths_output: #+BEGIN_SRC d :tangle ../src/doc_reform/output/paths_output.d /++ diff --git a/org/default_regex.org b/org/default_regex.org index c41b962..910be04 100644 --- a/org/default_regex.org +++ b/org/default_regex.org @@ -14,7 +14,7 @@ #+TAGS: assert(a) class(c) debug(d) mixin(m) doc_reform(s) tangle(T) template(t) WEB(W) noexport(n) [[./doc_reform.org][doc_reform]] [[./][org/]] -* 0. meta ctRegex :module: +* 0. meta ctRegex [[./doc_reform.org][doc_reform]] [[./][org/]] http://dlang.org/phobos/std_regex.html - Plain string, in which case it's compiled to bytecode before matching. @@ -27,7 +27,7 @@ http://dlang.org/phobos/std_regex.html 【】〖〗┥┝┤├¤░┘┙┚┼┿╂┊┏┚┆■☼ #+END_SRC -** 0. module template +** 0. module template :module: #+name: tangle_meta_rgx #+BEGIN_SRC d :tangle ../src/doc_reform/meta/rgx.d @@ -370,14 +370,14 @@ auto language_code_and_filename = ctRegex!("(?:^|[/])(am|bg|bn|br|ca|cs|cy|da|de|el|en|eo|es|et|eu|fi|fr|ga|gl|he|hi|hr|hy|ia|is|it|ja|ko|la|lo|lt|lv|ml|mr|nl|no|nn|oc|pl|pt|pt_BR|ro|ru|sa|se|sk|sl|sq|sr|sv|ta|te|th|tk|tr|uk|ur|vi|zh)/[A-Za-z0-9._-].+?[.](?:sst|ssm)$"); #+END_SRC -* 1. output ctRegex :module:doc_reform:output_rgx: +* 1. output ctRegex [[./doc_reform.org][doc_reform]] [[./][org/]] http://dlang.org/phobos/std_regex.html - Plain string, in which case it's compiled to bytecode before matching. - Regex!char (wchar/dchar) that contains a pattern in the form of compiled bytecode. - StaticRegex!char (wchar/dchar) that contains a pattern in the form of compiled native machine code. -** 0. module template +** 0. module template :module:output: #+name: tangle_meta_rgx #+BEGIN_SRC d :tangle ../src/doc_reform/output/rgx.d diff --git a/org/default_shared.org b/org/default_shared.org index e94ab60..54a2f4f 100644 --- a/org/default_shared.org +++ b/org/default_shared.org @@ -14,8 +14,8 @@ #+TAGS: assert(a) class(c) debug(d) mixin(m) doc_reform(s) tangle(T) template(t) WEB(W) noexport(n) [[./doc_reform.org][doc_reform]] [[./][org/]] -* 0. shared :module:doc_reform:shared: -** 0. module template +* 0. shared +** 0. module template :module:shared: #+BEGIN_SRC d :tangle ../src/doc_reform/share/defaults.d /++ diff --git a/org/imports.org b/org/imports.org index 435c6b6..e513e81 100644 --- a/org/imports.org +++ b/org/imports.org @@ -13,7 +13,7 @@ #+EXPORT_EXCLUDE_TAGS: noexport #+TAGS: assert(a) class(c) debug(d) mixin(m) doc_reform(s) tangle(T) template(t) WEB(W) noexport(n) -* 1. imports for meta +* 1. imports for meta :meta: ** package dir #+BEGIN_SRC d :tangle ../src/doc_reform/meta/package.d @@ -43,8 +43,7 @@ public import std.conv : to; #+END_SRC -* 2. imports for output - +* 2. imports for output :output: ** package dir #+BEGIN_SRC d :tangle ../src/doc_reform/output/package.d diff --git a/org/meta_abstraction.org b/org/meta_abstraction.org index b75a801..7f200bf 100644 --- a/org/meta_abstraction.org +++ b/org/meta_abstraction.org @@ -15,10 +15,10 @@ - [[./doc_reform.org][doc_reform]] [[./][org/]] -* 1. Document Abstraction :module:doc_reform:metadoc_from_src: +* 1. Document Abstraction Process markup document, create document abstraction. -** 0. module template +** 0. module template :module:metadoc_from_src: #+BEGIN_SRC d :tangle ../src/doc_reform/meta/metadoc_from_src.d /++ diff --git a/org/meta_conf_make_meta.org b/org/meta_conf_make_meta.org index de24fda..df8d299 100644 --- a/org/meta_conf_make_meta.org +++ b/org/meta_conf_make_meta.org @@ -419,7 +419,7 @@ auto config_jsonstr = `{ }`; #+END_SRC -* 1. JSON to DocReformStruct :module:doc_reform:meta_conf_make_meta_json: +* 1. JSON to DocReformStruct :module:conf_make_meta:json: ** 0. module template #+BEGIN_SRC d :tangle ../src/doc_reform/meta/conf_make_meta_json.d @@ -1050,7 +1050,7 @@ if (_struct_composite.meta.title_main.empty) { } #+END_SRC -* 2. TOML returns DocReformStruct (via JSON) :module:doc_reform:meta_conf_make_meta: +* 2. TOML returns DocReformStruct (via JSON) :module:conf_make_meta:struct: ** 0. parse TOML config return JSON #+BEGIN_SRC d :tangle ../src/doc_reform/meta/conf_make_meta_toml.d diff --git a/org/output_hub.org b/org/output_hub.org index 4d9c320..9cad03e 100644 --- a/org/output_hub.org +++ b/org/output_hub.org @@ -15,8 +15,8 @@ - [[./doc_reform.org][doc_reform]] [[./][org/]] -* 0. output hub [#A] :module:doc_reform:output_hub: -** module template +* 0. output hub [#A] +** module template :module: #+BEGIN_SRC d :tangle ../src/doc_reform/output/hub.d /++ @@ -73,6 +73,10 @@ import doc_reform.output, doc_reform.output.paths_output; #+END_SRC +** outputs +*** source: _sisusrc_ &/or _pod_ :source:pod: +- [[./output_pod.org][output_pod]] + #+name: output_scheduled_task #+BEGIN_SRC d if (sched == outTask.pod) { @@ -80,26 +84,58 @@ if (sched == outTask.pod) { DocReformPod!()(doc_matters); msg.vv("sisu source done"); } +#+END_SRC + +*** sqlite :sqlite: +**** discrete + +#+name: output_scheduled_task +#+BEGIN_SRC d if (sched == outTask.sqlite) { msg.v("sqlite processing... "); SQLiteHubDiscreteBuildTablesAndPopulate!()(doc_matters, doc_abstraction); msg.vv("sqlite done"); } +#+END_SRC + +*** epub :epub: + +#+name: output_scheduled_task +#+BEGIN_SRC d if (sched == outTask.epub) { msg.v("epub3 processing... "); outputEPub3!()(doc_abstraction, doc_matters); msg.vv("epub3 done"); } +#+END_SRC + +*** html :html: +**** scroll :scroll: + +#+name: output_scheduled_task +#+BEGIN_SRC d if (sched == outTask.html_scroll) { msg.v("html scroll processing... "); outputHTML!().scroll(doc_abstraction, doc_matters); msg.vv("html scroll done"); } +#+END_SRC + +**** seg :seg: + +#+name: output_scheduled_task +#+BEGIN_SRC d if (sched == outTask.html_seg) { msg.v("html seg processing... "); outputHTML!().seg(doc_abstraction, doc_matters); msg.vv("html seg done"); } +#+END_SRC + +**** css, images etc :css:images: + +#+name: output_scheduled_task +#+BEGIN_SRC d if (sched == outTask.html_stuff) { outputHTML!().css(doc_matters); outputHTML!().images_cp(doc_matters); @@ -107,14 +143,9 @@ if (sched == outTask.html_stuff) { } #+END_SRC -** output options -*** verbose - -*** output source: _sisusrc_ &/or _pod_ -- [[./output_pod.org][output_pod]] - -**** collection -***** update / populate +* output options +** sqlite collection :sqlite: +*** update / populate :update: #+name: output_shared_sqlite_db #+BEGIN_SRC d @@ -129,8 +160,8 @@ if (doc_matters.opt.action.sqlite_update) { } #+END_SRC -***** no markup source files to process -****** drop +*** no markup source files to process +**** drop :drop: #+name: output_options_op #+BEGIN_SRC d @@ -145,7 +176,7 @@ if ((opt_action.sqlite_db_drop)) { } #+END_SRC -****** create +**** create :create: #+name: output_options_op #+BEGIN_SRC d diff --git a/org/output_sqlite.org b/org/output_sqlite.org index e456fe7..ae1eb6d 100644 --- a/org/output_sqlite.org +++ b/org/output_sqlite.org @@ -1,6 +1,6 @@ #+TITLE: doc_reform output sqlite #+DESCRIPTION: documents - structuring, publishing in multiple formats & search -#+FILETAGS: :doc_reform:output:sqlite: +#+FILETAGS: :doc_reform:output:db:sql:sqlite: #+AUTHOR: Ralph Amissah #+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] #+LANGUAGE: en @@ -17,7 +17,7 @@ - [[./output_hub.org][output_hub]] * sql -** 0. module, templates +** 0. module, templates :module: *** hub **** collection @@ -263,7 +263,7 @@ template SQLiteDbDrop() { } #+END_SRC -** 1. [#A] sqlite_db_statement +** 1. [#A] sqlite_db_statement :statement: *** collection #+name: sqlite_db_statement_composite_collection @@ -1333,7 +1333,7 @@ foreach (part; doc_matters.xml.keys_seq.sql) { return _insert_doc_objects.join.to!(char[]).toUTF8; #+END_SRC -** 5. SQL statements +** 5. SQL statements :statement: *** drop index and tables **** DROP INDEX IF EXISTS diff --git a/org/output_src_pod.org b/org/output_src_pod.org index ee0925a..c699786 100644 --- a/org/output_src_pod.org +++ b/org/output_src_pod.org @@ -1,6 +1,6 @@ #+TITLE: doc_reform output pod #+DESCRIPTION: documents - structuring, publishing in multiple formats & search -#+FILETAGS: :doc_reform:output:pod: +#+FILETAGS: :doc_reform:output:source:pod: #+AUTHOR: Ralph Amissah #+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] #+LANGUAGE: en @@ -16,8 +16,8 @@ - [[./doc_reform.org][doc_reform]] [[./][org/]] - [[./output_hub.org][output_hub]] -* pod :module:doc_reform:source_pod: -** module template +* pod +** module template :module: #+BEGIN_SRC d :tangle ../src/doc_reform/output/source_pod.d module doc_reform.output.source_pod; @@ -37,7 +37,7 @@ template DocReformPod() { } #+END_SRC -** output imports +** imports #+name: output_imports #+BEGIN_SRC d @@ -53,7 +53,7 @@ import doc_reform.output.xmls; #+END_SRC -** mkdir +** mkdir :mkdir: #+name: source_pod_init #+BEGIN_SRC d @@ -100,7 +100,7 @@ if (doc_matters.opt.action.source) { } #+END_SRC -** copy +** copy :copy: #+name: source_pod_copy #+BEGIN_SRC d diff --git a/org/output_xmls.org b/org/output_xmls.org index a1b166e..12b37a1 100644 --- a/org/output_xmls.org +++ b/org/output_xmls.org @@ -16,9 +16,9 @@ - [[./doc_reform.org][doc_reform]] [[./][org/]] - [[./output_hub.org][output_hub]] -* xml offspring (xhtml html epub) :module: +* xml offspring (xhtml html epub) ** format xhtml objects :format: -*** 0. module template +*** 0. module template :module: #+BEGIN_SRC d :tangle ../src/doc_reform/output/xmls.d module doc_reform.output.xmls; @@ -1401,8 +1401,8 @@ auto endnote(M,O)( } #+END_SRC -* _html_ [#A] :module:doc_reform:output_html: -** module template +* _html_ [#A] :html: +** module template :module: #+BEGIN_SRC d :tangle ../src/doc_reform/output/html.d module doc_reform.output.html; @@ -1920,7 +1920,7 @@ void images_cp(M)( } #+END_SRC -* _epub_ [#B] :module:doc_reform:output_epub3: +* _epub_ [#B] :epub: |-----------------------+--------------------------+---------------------------+----------------------------------| | function | filename | module | variable | @@ -1938,7 +1938,7 @@ void images_cp(M)( | | | | doc_epub3_endnotes[seg_filename] | |-----------------------+--------------------------+---------------------------+----------------------------------| -** module template +** module template :module: #+BEGIN_SRC d :tangle ../src/doc_reform/output/epub3.d module doc_reform.output.epub3; @@ -2564,7 +2564,7 @@ void outputEPub3(D,I)( } #+END_SRC -** write output files +** write output files :write:zip: #+name: output_epub3_xhtml_seg #+BEGIN_SRC d @@ -2763,7 +2763,7 @@ void epub3_write_output_files(M,D,E,Mt,Mic,Otnx,Otn,Oc)( } #+END_SRC -** zip debug, read zip archive +** zip debug, read zip archive :zip: #+name: output_epub3_xhtml_seg #+BEGIN_SRC d diff --git a/org/source_files_read.org b/org/source_files_read.org index ceb2c36..798b370 100644 --- a/org/source_files_read.org +++ b/org/source_files_read.org @@ -25,8 +25,8 @@ import std.path; #+END_SRC -* A. get _config file_ (read in) :module:config_files: -** 0. module template +* A. get _config file_ (read in) +** 0. module template :module:config_files: #+BEGIN_SRC d :tangle ../src/doc_reform/source/read_config_files.d /++ @@ -139,7 +139,7 @@ static template readConfigDoc() { } #+END_SRC -** A. TOML +** A. TOML :toml: *** 1. TOML read config files (config_local_site & sisu_document_make) :file:config: **** TOML config_local_site -- cgit v1.2.3