a text output (and skel an outline)HEADmain

- spine --text [--output=output path] [markup source]

1 files changed, 324 insertions, 0 deletions

diff --git a/org/out_skel.org b/org/out_skel.org
new file mode 100644
index 0000000..43be371
--- /dev/null
+++ b/org/out_skel.org
@@ -0,0 +1,324 @@
+-*- mode: org -*-
+#+TITLE:       sisudoc spine (doc_reform) output xmls
+#+DESCRIPTION: documents - structuring, publishing in multiple formats & search
+#+FILETAGS:    :spine:output:skel:
+#+AUTHOR:      Ralph Amissah
+#+EMAIL:       [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]]
+#+COPYRIGHT:   Copyright (C) 2015 - 2025 Ralph Amissah
+#+LANGUAGE:    en
+#+STARTUP:     content hideblocks hidestars noindent entitiespretty
+#+PROPERTY:    header-args  :exports code
+#+PROPERTY:    header-args+ :noweb yes
+#+PROPERTY:    header-args+ :results output none
+#+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/]]
+- [[./output_hub.org][output_hub]]
+
+* Skel
+** outputSkel template
+
+#+HEADER: :tangle "../src/sisudoc/io_out/skel.d"
+#+HEADER: :noweb yes
+#+BEGIN_SRC d
+<<doc_header_including_copyright_and_license>>
+module sisudoc.io_out.skel;
+@safe:
+template outputSkel() {
+  <<munge>>
+  <<the_document>>
+  void outputSkel(D,M) (
+    const D  doc_abstraction,
+          M  doc_matters,
+  ) {
+    import std.stdio;
+    import sisudoc.io_out;
+    <<skel_out>>
+    skel_out(doc_abstraction, doc_matters);
+  }
+}
+#+END_SRC
+
+** Output
+
+#+NAME: skel_out
+#+HEADER: :noweb yes
+#+BEGIN_SRC d
+void skel_out(D,M)(
+  const D  doc_abstraction,
+        M  doc_matters,
+) {
+  struct Skel {
+    string head;
+    string content;
+    string tail;
+  }
+  auto skel           = Skel();
+  skel.head           = theDocument!().skel_head(doc_matters);
+  skel.content        = theDocument!().skel_body(doc_abstraction, doc_matters);
+  skel.tail           = theDocument!().skel_tail(doc_matters);
+  auto pth_skel = spinePathsSkel(doc_matters);
+  try {
+    import std.file;
+    if (!exists(pth_skel.base_pth)) {
+      (pth_skel.base_pth).mkdirRecurse;
+    }
+  } catch (ErrnoException ex) {
+  }
+  if (doc_matters.opt.action.vox_gt_1) {
+    writeln(" ", pth_skel.skel_file);
+  }
+  // writeln(pth_skel.base_pth);
+  auto f = File(pth_skel.skel_file, "w");
+  f.writeln(skel.head);
+  f.writeln(skel.content);
+  f.writeln(skel.tail);
+}
+#+END_SRC
+
+* The Document
+** theDocument template
+
+#+NAME: the_document
+#+HEADER: :noweb yes
+#+BEGIN_SRC d
+template theDocument() {
+  import std.stdio;
+  import sisudoc.io_out;
+  <<skel_head>>
+  <<skel_body_assign_munge>>
+  <<skel_tail>>
+}
+#+END_SRC
+
+** the Document (assign munge)
+*** Head
+
+#+NAME: skel_head
+#+HEADER: :noweb yes
+#+BEGIN_SRC d
+// static auto rgx = RgxO();
+string skel_head(M)(
+        M  doc_matters,
+) {
+  return "head";
+}
+#+END_SRC
+
+*** Body munge assign
+
+#+NAME: skel_body_assign_munge
+#+HEADER: :noweb yes
+#+BEGIN_SRC d
+string skel_body(D,M)(
+  const D  doc_abstraction,
+        M  doc_matters,
+) {
+  string doc_object = "";
+  foreach (section; doc_matters.has.keys_seq.scroll) {
+    foreach (obj; doc_abstraction[section]) {
+      if (obj.metainfo.is_a == "toc")          { doc_object ~= munge!().toc(obj); }
+      if (obj.metainfo.is_a == "heading")      { doc_object ~= munge!().heading(obj); }
+      if (obj.metainfo.is_a == "para")         { doc_object ~= munge!().para(obj); }
+      if (obj.metainfo.is_a == "group")        { doc_object ~= munge!().group(obj); }
+      if (obj.metainfo.is_a == "block")        { doc_object ~= munge!().block(obj); }
+      if (obj.metainfo.is_a == "poem")         { doc_object ~= munge!().poem(obj); }
+      if (obj.metainfo.is_a == "verse")        { doc_object ~= munge!().verse(obj); }
+      if (obj.metainfo.is_a == "code")         { doc_object ~= munge!().code(obj); }
+      if (obj.metainfo.is_a == "quote")        { doc_object ~= munge!().quote(obj); }
+      if (obj.metainfo.is_a == "table")        { doc_object ~= munge!().table(obj); }
+      if (obj.metainfo.is_a == "endnote")      { doc_object ~= munge!().endnote(obj); }
+      if (obj.metainfo.is_a == "bookindex")    { doc_object ~= munge!().bookindex(obj); }
+      if (obj.metainfo.is_a == "bibliography") { doc_object ~= munge!().bibliography(obj); }
+      if (obj.metainfo.is_a == "glossary")     { doc_object ~= munge!().glossary(obj); }
+      if (obj.metainfo.is_a == "blurb")        { doc_object ~= munge!().blurb(obj); }
+      if (obj.metainfo.is_a == "comment")      { doc_object ~= munge!().comment(obj); }
+    }
+  }
+  return doc_object;
+}
+#+END_SRC
+
+*** Tail
+
+#+NAME: skel_tail
+#+HEADER: :noweb yes
+#+BEGIN_SRC d
+string skel_tail(M)(
+        M  doc_matters,
+) {
+  return "tail";
+}
+#+END_SRC
+
+* Munge
+
+#+NAME: munge
+#+HEADER: :noweb yes
+#+BEGIN_SRC d
+template munge() {
+  import std.stdio;
+  import std.conv;
+  void puts(string _obj_is) {
+    writeln(__FILE__, ":", __LINE__, ": ", _obj_is);
+  }
+  string newline = "\n";
+  string newlines = "\n\n";
+  string toc(O)(O obj) {
+    // puts(obj.metainfo.is_a);
+    // return "toc\n";
+    return obj.text ~ newline;
+  }
+  string heading(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+  }
+  string para(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+  }
+  string group(O)(O obj) {
+    /+
+      The "group" is different from the "block" mark in that "group" does not
+      preserve whitespace, the "block" mark does. The text falling within the
+      block is a single object.
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+  }
+  string block(O)(O obj) {
+    /+
+      The "block" is different from the "group" mark in that the "block" mark
+      (like the "poem" mark) preserves whitespace, the "group" mark does not.
+      The text falling within the "block" is a single object, which is different
+      from the "poem" mark where each identified verse is an object.
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+  }
+  string poem(O)(O obj) {
+    /+
+      The "poem" mark like the "block" preserves whitespace. Text followed by
+      two newlines are identified as verse and each verse is an object i.e. a
+      poem may consist of multiple verse each of which is identified as an
+      object, unlike a text "block" which is identified as a single object.
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    // return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+    return obj.text ~ newlines;
+  }
+  string verse(O)(O obj) {
+    /+
+      See description of poem, the poem is demarkated but the verse is the
+      object.
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+  }
+  string code(O)(O obj) {
+    /+
+      "Code" blocks are a single text object, in which the original text is
+      preserved.
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+  }
+  string quote(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+  }
+  string table(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newline ~ "「" ~ obj.metainfo.ocn.to!string ~ "」" ~ newlines;
+  }
+  string endnote(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newlines;
+  }
+  string bookindex(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newlines;
+  }
+  string bibliography(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newlines;
+  }
+  string glossary(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newlines;
+  }
+  string blurb(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newlines;
+  }
+  string comment(O)(O obj) {
+    /+
+    +/
+    // puts(obj.metainfo.is_a);
+    // return obj.metainfo.is_a;
+    return obj.text ~ newlines;
+  }
+}
+#+END_SRC
+
+* org includes
+** spine project VERSION
+
+#+NAME: spine_version
+#+HEADER: :noweb yes
+#+BEGIN_SRC emacs-lisp
+<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_project_version()>>
+#+END_SRC
+
+** year
+
+#+NAME: year
+#+HEADER: :noweb yes
+#+BEGIN_SRC emacs-lisp
+<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:year()>>
+#+END_SRC
+
+** document header including copyright & license
+
+#+NAME: doc_header_including_copyright_and_license
+#+HEADER: :noweb yes
+#+BEGIN_SRC emacs-lisp
+<<./sisudoc_spine_version_info_and_doc_header_including_copyright_and_license.org:spine_doc_header_including_copyright_and_license()>>
+#+END_SRC
+
+* __END__