config rearranged, more put in maker.orgdoc-reform_v0.0.3

7 files changed, 129 insertions, 76 deletions

diff --git a/dub.json b/dub.json
index f23678a..85eb0e2 100644
--- a/dub.json
+++ b/dub.json
@@ -1,14 +1,13 @@
-
 {
-  "name": "sdp",
-  "targetType": "executable",
-  "targetName": "sdp",
-  "targetPath": "bin",
-  "description": "sisu document parser.",
-  "authors": ["Ralph Amissah"],
-  "homepage": "http://sisudoc.org",
-  "license": "GPL-3.0",
-  "add-path": "./src/sdp",
+  "name"        : "sdp",
+  "targetType"  : "executable",
+  "targetName"  : "sdp",
+  "targetPath"  : "bin",
+  "description" : "sisu document parser.",
+  "authors"     : ["Ralph Amissah"],
+  "homepage"    : "http://sisudoc.org",
+  "license"     : "AGPL-3+",
+  "add-path"    : "./src/sdp",
   "dependencies": {
   }
 }
diff --git a/maker.org b/maker.org
index 651473f..0bb9519 100644
--- a/maker.org
+++ b/maker.org
@@ -59,34 +59,26 @@ DUB=dub
 DUB_FLAGS=-v --force --compiler=
 #+END_SRC
 
-*** TODO set/select: ~D compiler~ & ~debug flags~ [+1] [2/2]   :select:
+*** TODO set/select: ~D compiler~ & ~debug flags~ [+1] [2/2]             :select:
 - [X] Set D_COMPILER (one of DMD LDC or GDC)
 - [X] Set debug flags (using DMD standard flag -debug=)
 
-**** SET compiler: "SET_D_COMPILER=":                         :compiler:select:
+**** TODO [#A] SET compiler: "SET_D_COMPILER=":             :compiler:select:
 [[http://wiki.dlang.org/Compilers][D Compilers wiki]]
 [[http://dlang.org/download.html][D Compilers download]]
 Set D_COMPILER one of DMD, LDC or GDC e.g.: SET_D_COMPILER=DMD
 
-***** TODO [#A] set compiler
 #+BEGIN_SRC makefile :tangle makefile
 # SET_D_COMPILER=(one of: DMD LDC or GDC):
 SET_D_COMPILER=DMD
 #+END_SRC
 
-***** +note+
-
-"nice how you can get 2x speedup without a single line of asm just by using ldc", p0nce
-"gdc might be worth a shot if your code is compatible", profan
-re: dmd "one can easily get 2x (and even more) speedup by simply switching to gdc -O2", ketmar
-
-**** SET debug flags: "SET_DC_FLAGS_DEBUG_EXTRA=-debug=":  :compiler:flags:debug:
+**** TODO [#A] SET debug flags: "SET_DC_FLAGS_DEBUG_EXTRA=-debug=": :compiler:flags:debug:
 Set debug flags using DMD standard flag -debug= e.g.:
   SET_DC_FLAGS_DEBUG_EXTRA=-debug=headings -debug=bookindex
   SET_DC_FLAGS_DEBUG_EXTRA=-debug=headings -debug=footnotes -debug=endnotes
   SET_DC_FLAGS_DEBUG_EXTRA=-debug=headings -debug=biblio
 
-***** TODO [#A] set debug flags
 #+BEGIN_SRC makefile :tangle makefile
 SET_DC_FLAGS_DEBUG_EXTRA=-debug=dumpdoc
 #+END_SRC
@@ -394,7 +386,54 @@ gitsnapshot: distclean tangle
 	tangle gitsnapshot
 #+END_SRC
 
-* sh script to batch process emacs org babel tangle     :shell_script:tangle:
+* conf misc
+** dub.json                                                 :dub:description:
+
+Every DUB package should contain a [[http://code.dlang.org/package-format?lang=json][dub.json]] (or [[http://code.dlang.org/package-format?lang=sdl][dub.sdl]])
+
+#+BEGIN_SRC json  :tangle dub.json
+{
+  "name"        : "sdp",
+  "targetType"  : "executable",
+  "targetName"  : "sdp",
+  "targetPath"  : "bin",
+  "description" : "sisu document parser.",
+  "authors"     : ["Ralph Amissah"],
+  "homepage"    : "http://sisudoc.org",
+  "license"     : "AGPL-3+",
+  "add-path"    : "./src/sdp",
+  "dependencies": {
+  }
+}
+#+END_SRC
+
+** .gitignore                                                     :gitignore:
+
+#+BEGIN_SRC sh :tangle .gitignore
+# git ls-files --others --exclude-from=.git/info/exclude
+#./.dub/**
+.dub/**
+*
+!.gitignore
+!makefile
+!version.txt
+!./dub.json
+!tangle
+!*.org
+!*.d
+!*.txt
+!org
+!src
+!views
+!**/
+**/.#*
+#!*/
+#*~
+#\#*
+#*.\#*
+#+END_SRC
+
+** sh script to batch process emacs org babel tangle    :shell_script:tangle:
   [http://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/sdp/
@@ -429,7 +468,7 @@ emacs --batch -Q -q \
 
 * D build notes                                                       :notes:
 ** compilers                                                       :compiler:
-*** [#A] dmd
+*** [#A] dmd                                                            :dmd:
 
 #+BEGIN_SRC sh
 dmd -de -w -J./views -I./src/sdp -unittest -debug=checkdoc -debug=summary -debug=dumpdoc -of./bin/sdp ./src/sdp.d
@@ -437,7 +476,7 @@ dmd -de -w -J./views -I./src/sdp -of./bin/sdp ./src/sdp.d
 dmd -de -w -J./views -I./src/sdp -O -release -of./bin/sdp ./src/sdp.d
 #+END_SRC
 
-*** [#A] ldc2
+*** [#A] ldc2                                                          :ldc2:
 
 #+BEGIN_SRC sh
 ldc2 -de -w -J./views -I./src/sdp -unittest -d-debug=checkdoc -d-debug=summary -d-debug=dumpdoc -of=./bin/sdp ./src/sdp.d
@@ -445,15 +484,21 @@ ldc2 -de -w -J./views -I./src/sdp -of=./bin/sdp ./src/sdp.d
 ldc2 -de -w -J./views -I./src/sdp -O4 -release -of=./bin/sdp ./src/sdp.d
 #+END_SRC
 
-*** TODO gdc
+*** TODO gdc                                                            :gdc:
 
 not done
 
 #+BEGIN_SRC sh
 #+END_SRC
 
+**** +note+
+
+"nice how you can get 2x speedup without a single line of asm just by using ldc", p0nce
+"gdc might be worth a shot if your code is compatible", profan
+re: dmd "one can easily get 2x (and even more) speedup by simply switching to gdc -O2", ketmar
+
 ** build tools                                                   :build:tool:
-*** [#B] rdmd
+*** [#B] rdmd                                                          :rdmd:
 
 flags similar to dmd
 
@@ -469,7 +514,7 @@ rdmd -de -w -J./views -I./src/sdp -unittest -debug=checkdoc -debug=summary -debu
 rdmd -de -w -J./views -I./src/sdp -unittest -d-debug=checkdoc -d-debug=summary -d-debug=dumpdoc --compiler=ldc2 -of./bin/sdp ./src/sdp.d
 #+END_SRC
 
-*** [#A] dub
+*** [#A] dub                                                            :dub:
 https://github.com/dlang/dub/
 http://code.dlang.org/getting_started
 http://code.dlang.org/docs/commandline
diff --git a/org/ao_abstract_doc_source.org b/org/ao_abstract_doc_source.org
index 796d6b2..d8f2637 100644
--- a/org/ao_abstract_doc_source.org
+++ b/org/ao_abstract_doc_source.org
@@ -4507,3 +4507,43 @@ template ObjectSetter() {
   }
 }
 #+END_SRC
+
+* TODO work on
+- bespoke struct for sisu objects to replace JSON strings
+- book index *sort* fix (Aa-Zz instead of A-Za-z)
+- determine what goes in node info
+  - understand collapsed level
+- convert file utf8 for processing from to utf32
+
+- general concepts
+  - ranges
+  - templates
+  - unitest?
+
+|---------------------+------------------------------------------+------------------------+--------|
+| header              | sisu /header markup/                       | markup                 |        |
+| - metadata          |                                          |                        |        |
+| - make instructions |                                          |                        |        |
+|---------------------+------------------------------------------+------------------------+--------|
+| table of contents   | markup of headings                       | (regular content)      | output |
+|---------------------+------------------------------------------+------------------------+--------|
+| substantive content | sisu /content markup/                      | markup                 | output |
+|                     | headings (providing document structure), | (regular content)      |        |
+|                     | paragraphs, blocks                       |                        |        |
+|                     | blocks (code, poem, group, table)        |                        |        |
+|---------------------+------------------------------------------+------------------------+--------|
+| endnotes            | markup within substantive content        | markup                 | output |
+|                     | (extracted from sisu /content markup/)     | (from regular content) |        |
+|---------------------+------------------------------------------+------------------------+--------|
+| glossary            | identify special section                 | markup                 | output |
+|                     | regular /content markup/                   |                        |        |
+|---------------------+------------------------------------------+------------------------+--------|
+| bibliography        | identify section,                        | markup (special)       | output |
+|                     | special /bibliography markup/              |                        |        |
+|---------------------+------------------------------------------+------------------------+--------|
+| book index          | extracted from markup attached to        | markup                 | output |
+|                     | related substantive content objects      |                        |        |
+|                     | (special tags in sisu /content markup/)    | (from regular content) |        |
+|---------------------+------------------------------------------+------------------------+--------|
+| metadata            |                                          | (from regular header)  | output |
+|---------------------+------------------------------------------+------------------------+--------|
diff --git a/org/sdp.org b/org/sdp.org
index fe66ef3..dc56e8e 100644
--- a/org/sdp.org
+++ b/org/sdp.org
@@ -21,13 +21,14 @@ Take command line instructions and process files as instructed.
 ** TODO version.txt: set version                                    :version:
 
 #+NAME: version_txt
-#+BEGIN_SRC d
+#+BEGIN_SRC d  :tangle ../views/version.txt
+/+ obt - org generated file +/
 struct Version {
   int major;
   int minor;
   int patch;
 }
-enum ver = Version(1, 0, 0);
+enum ver = Version(0, 4, 0);
 #+END_SRC
 
 ** pre loop init
@@ -80,13 +81,13 @@ private import
 #+BEGIN_SRC d
 /+ sdp  sisu document parser +/
 import
-  compile_time_info,            // compile_time_info.d
-  ao_abstract_doc_source,       // ao_abstract_doc_source.d
-  ao_defaults,                  // ao_defaults.d
-  ao_read_source_files,         // ao_read_source_files.d
-  ao_output_debugs,             // ao_output_debugs.d
-  ao_rgx,                       // ao_rgx.d
-  ao_ansi_colors;               // ao_ansi_colors.d
+  compile_time_info,            // sdp/compile_time_info.d
+  ao_abstract_doc_source,       // sdp/ao_abstract_doc_source.d
+  ao_defaults,                  // sdp/ao_defaults.d
+  ao_read_source_files,         // sdp/ao_read_source_files.d
+  ao_output_debugs,             // sdp/ao_output_debugs.d
+  ao_rgx,                       // sdp/ao_rgx.d
+  ao_ansi_colors;               // sdp/ao_ansi_colors.d
   // std.conv;
 #+END_SRC
 
diff --git a/org/sdp_conf.org b/org/sdp_conf.org
deleted file mode 100644
index 46c9659..0000000
--- a/org/sdp_conf.org
+++ /dev/null
@@ -1,31 +0,0 @@
-* configuration tangles
-** TODO version.txt: set version                                    :version:
-
-#+BEGIN_SRC d  :tangle ../views/version.txt
-/+ obt - org generated file +/
-struct Version {
-  int major;
-  int minor;
-  int patch;
-}
-enum ver = Version(1, 0, 0);
-#+END_SRC
-
-** dub
-*** dub.json                                                :dub:description:
-
-#+BEGIN_SRC json  :tangle ../dub.json
-{
-  "name": "sdp",
-  "targetType": "executable",
-  "targetName": "sdp",
-  "targetPath": "bin",
-  "description": "sisu document parser.",
-  "authors": ["Ralph Amissah"],
-  "homepage": "http://sisudoc.org",
-  "license": "GPL-3.0",
-  "add-path": "./src/sdp",
-  "dependencies": {
-  }
-}
-#+END_SRC
diff --git a/src/sdp.d b/src/sdp.d
index 725c018..6b9ffcd 100755
--- a/src/sdp.d
+++ b/src/sdp.d
@@ -25,13 +25,13 @@ private import
   std.conv : to;
 /+ sdp  sisu document parser +/
 import
-  compile_time_info,            // compile_time_info.d
-  ao_abstract_doc_source,       // ao_abstract_doc_source.d
-  ao_defaults,                  // ao_defaults.d
-  ao_read_source_files,         // ao_read_source_files.d
-  ao_output_debugs,             // ao_output_debugs.d
-  ao_rgx,                       // ao_rgx.d
-  ao_ansi_colors;               // ao_ansi_colors.d
+  compile_time_info,            // sdp/compile_time_info.d
+  ao_abstract_doc_source,       // sdp/ao_abstract_doc_source.d
+  ao_defaults,                  // sdp/ao_defaults.d
+  ao_read_source_files,         // sdp/ao_read_source_files.d
+  ao_output_debugs,             // sdp/ao_output_debugs.d
+  ao_rgx,                       // sdp/ao_rgx.d
+  ao_ansi_colors;               // sdp/ao_ansi_colors.d
   // std.conv;
 mixin(import("version.txt"));
 mixin CompileTimeInfo;
diff --git a/views/version.txt b/views/version.txt
index 7fc1957..e61c0ba 100644
--- a/views/version.txt
+++ b/views/version.txt
@@ -1,8 +1,7 @@
-
 /+ obt - org generated file +/
 struct Version {
   int major;
   int minor;
   int patch;
 }
-enum ver = Version(1, 0, 0);
+enum ver = Version(0, 4, 0);