html links and metadata, fixes & cosmetic work

5 files changed, 82 insertions, 26 deletions

diff --git a/src/doc_reform/io_out/epub3.d b/src/doc_reform/io_out/epub3.d
index c94863b..c0916f9 100644
--- a/src/doc_reform/io_out/epub3.d
+++ b/src/doc_reform/io_out/epub3.d
@@ -639,8 +639,14 @@ template outputEPub3() {
         pth_epub3.base.mkdirRecurse;
       }
       if (!exists(pth_epub3.base ~ "/index.html")) {
+        import doc_reform.io_out.html_snippet;
+        mixin htmlSnippet;
         auto f = File(pth_epub3.base ~"/index.html", "w");
-        f.writeln("");
+        f.writeln(format_html_blank_page_guide_home(
+          "../../css/html_scroll.css",
+          "https://sisudoc.org",
+          "../../index.html",
+        ));
       }
       { /+ debug +/
         if (doc_matters.opt.action.debug_do_epub) {
diff --git a/src/doc_reform/io_out/html.d b/src/doc_reform/io_out/html.d
index 9e108c6..5f1f11c 100644
--- a/src/doc_reform/io_out/html.d
+++ b/src/doc_reform/io_out/html.d
@@ -228,9 +228,9 @@ template outputHTML() {
       }
     }
     doc = xhtml_format.html_head(doc_matters, "scroll")
-      ~ doc_html
-      ~ xhtml_format.dom_close
-      ~ xhtml_format.tail(doc_matters);
+    ~ doc_html
+    ~ xhtml_format.dom_close
+    ~ xhtml_format.tail(doc_matters);
     scroll_write_output(doc, doc_matters);
   }
   @trusted void scroll_write_output(D,M)(
@@ -252,8 +252,14 @@ template outputHTML() {
         }
       }
       if (!exists(pth_html.base ~ "/index.html")) {
+        import doc_reform.io_out.html_snippet;
+        mixin htmlSnippet;
         auto f = File(pth_html.base ~"/index.html", "w");
-        f.writeln("");
+        f.writeln(format_html_blank_page_guide_home(
+          "../../css/html_scroll.css",
+          "https://sisudoc.org",
+          "../../index.html",
+        ));
       }
     } catch (ErrnoException ex) {
       // Handle error
@@ -563,8 +569,14 @@ template outputHTML() {
         f.writeln(css.html_scroll);
       }
       if (!exists(pth_html.css ~ "/index.html")) {
+        import doc_reform.io_out.html_snippet;
+        mixin htmlSnippet;
         auto f = File(pth_html.css ~"/index.html", "w");
-        f.writeln("");
+        f.writeln(format_html_blank_page_guide_home(
+          "./css/html_scroll.css",
+          "https://sisudoc.org",
+          "../index.html",
+        ));
       }
     } catch (ErrnoException ex) {
       // Handle error
@@ -593,8 +605,14 @@ template outputHTML() {
         }
       }
       if (!exists(pth_html.image ~ "/index.html")) {
+        import doc_reform.io_out.html_snippet;
+        mixin htmlSnippet;
         auto f = File(pth_html.image ~"/index.html", "w");
-        f.writeln("");
+        f.writeln(format_html_blank_page_guide_home(
+          "../css/html_scroll.css",
+          "https://sisudoc.org",
+          "../index.html",
+        ));
       }
     }
   }
diff --git a/src/doc_reform/io_out/html_snippet.d b/src/doc_reform/io_out/html_snippet.d
index fea78a8..8dbb949 100644
--- a/src/doc_reform/io_out/html_snippet.d
+++ b/src/doc_reform/io_out/html_snippet.d
@@ -83,4 +83,20 @@ template htmlSnippet() {
     );
     return html_blank_default;
   }
+  @safe string special_characters_text(string _txt) {
+    mixin spineRgxOut;
+    mixin spineRgxXHTML;
+    static auto rgx = RgxO();
+    static auto rgx_xhtml = RgxXHTML();
+    _txt = _txt
+      .replaceAll(rgx_xhtml.ampersand,    "&")  // "&"
+      .replaceAll(rgx_xhtml.quotation,    """) // """
+      .replaceAll(rgx_xhtml.less_than,    "<")   // "<"
+      .replaceAll(rgx_xhtml.greater_than, ">")   // ">"
+      .replaceAll(rgx.br_line,            "<br />")
+      .replaceAll(rgx.br_line_inline,     "<br />")
+      .replaceAll(rgx.br_line_spaced,     "<br />\n<br />")
+      .replaceAll(rgx.nbsp_char,          " ");
+    return _txt;
+  }
 }
diff --git a/src/doc_reform/io_out/metadata.d b/src/doc_reform/io_out/metadata.d
index 2686d15..e5e1c02 100644
--- a/src/doc_reform/io_out/metadata.d
+++ b/src/doc_reform/io_out/metadata.d
@@ -338,8 +338,14 @@ string theme_light_1 = format(q"┃
           }
         }
         if (!exists(pth_html.base ~ "/index.html")) {
+          import doc_reform.io_out.html_snippet;
+          mixin htmlSnippet;
           auto f = File(pth_html.base ~"/index.html", "w");
-          f.writeln("");
+          f.writeln(format_html_blank_page_guide_home(
+            "../../css/html_scroll.css",
+            "https://sisudoc.org",
+            "../../index.html",
+          ));
         }
       } catch (ErrnoException ex) {
         // Handle error
@@ -349,13 +355,15 @@ string theme_light_1 = format(q"┃
       }
     }
     static auto mkup = InlineMarkup();
+    import doc_reform.io_out.html_snippet;
+    mixin htmlSnippet;
     if (doc_matters.opt.action.debug_do) {
       writeln(doc_matters.src.filename_base);
       writeln("Title:       ", doc_matters.conf_make_meta.meta.title_full);
       writeln("  Author:    ", doc_matters.conf_make_meta.meta.creator_author);
       writeln("  Published: ", doc_matters.conf_make_meta.meta.date_published);
       writeln("  Copyright: ", doc_matters.conf_make_meta.meta.rights_copyright);
-      writeln("  License:   ", doc_matters.conf_make_meta.meta.rights_license);
+      writeln("  License:   ", special_characters_text(doc_matters.conf_make_meta.meta.rights_license));
       if (doc_matters.conf_make_meta.meta.classify_topic_register_arr.length > 0) {
         foreach (topic; doc_matters.conf_make_meta.meta.classify_topic_register_arr.sort!("toUpper(a) < toUpper(b)", SwapStrategy.unstable)) {
           string[] subject_tree = topic.split(mkup.sep);
@@ -410,44 +418,52 @@ string theme_light_1 = format(q"┃
     }
     metadata_ ~= "<p class=\"lev1\">Published: "   ~ doc_matters.conf_make_meta.meta.date_published   ~ "</p>";
     if (!(doc_matters.conf_make_meta.meta.rights_copyright.empty)) {
-      metadata_ ~= "<p class=\"lev1\">Copyright: "   ~ doc_matters.conf_make_meta.meta.rights_copyright ~ "</p>";
+      metadata_ ~= "<p class=\"lev1\">Copyright: "   ~ special_characters_text(doc_matters.conf_make_meta.meta.rights_copyright) ~ "</p>";
     } else if (doc_matters.opt.action.debug_do || doc_matters.opt.action.vox_gt2) {
       writeln("WARNING no Copyright information provided in document header ", doc_matters.src.filename_base);
     }
     if (!(doc_matters.conf_make_meta.meta.rights_license.empty)) {
-      metadata_ ~= "<p class=\"lev1\">License:   "   ~ doc_matters.conf_make_meta.meta.rights_license   ~ "</p>";
+      metadata_ ~= "<p class=\"lev1\">License:   "   ~ special_characters_text(doc_matters.conf_make_meta.meta.rights_license) ~ "</p>";
     } else if (doc_matters.opt.action.debug_do || doc_matters.opt.action.vox_gt2) {
       writeln("WARNING no License information provided in document header ", doc_matters.src.filename_base);
     }
     if (!(doc_matters.conf_make_meta.meta.notes_summary.empty)) {
-      metadata_ ~= "<hr /><p class=\"lev0\">Summary:</p><p class=\"lev1\">"   ~ doc_matters.conf_make_meta.meta.notes_summary   ~ "</p>";
+      metadata_ ~= "<hr /><p class=\"lev0\">Summary:</p><p class=\"lev1\">"   ~ special_characters_text(doc_matters.conf_make_meta.meta.notes_summary) ~ "</p>";
     } else if (doc_matters.opt.action.debug_do) {
       writeln("WARNING no summary of text provided in document header ", doc_matters.src.filename_base);
     }
     metadata_ ~= "<hr /><p class=\"lev1\">source: "      ~ doc_matters.src.filename_base ~ "</p>";
     if (doc_matters.opt.action.html_link_markup_source) {
-      metadata_ ~= "<p class=\"lev1\">● markup source: [<a href=\"../../" ~ pth_pod.internal_base ~ "/" ~ doc_matters.src.filename_base ~ ".zip\">"
-                   ~ "&nbsp;zipped&nbsp;pod&nbsp;</a>] "
-                   ~ "[<a href=\"../../" ~ pth_pod.internal_base ~ "/" ~ doc_matters.src.filename_base ~ "/\">"
-                   ~ "&nbsp;pod&nbsp;tree&nbsp;</a>]";
+      metadata_ ~= "<p class=\"lev1\">●&nbsp;&nbsp;markup source:&nbsp;&nbsp;the&nbsppod&nbsp[<a href=\"../../" ~ pth_pod.internal_base ~ "/" ~ doc_matters.src.filename_base ~ ".zip\">"
+                   ~ "&nbsp;🫛&nbsp;zipped&nbsp;</a>|&nbsp;"
+                   ~ "<a href=\"../../" ~ pth_pod.internal_base ~ "/" ~ doc_matters.src.filename_base ~ "/\">"
+                   ~ "&nbsp;🫛&nbsp;tree&nbsp;</a>]&nbsp;";
     }
-    metadata_ ~= "<p class=\"lev1\">● outputs: [<a href=\""    ~ doc_matters.src.filename_base ~ ".html\">"
-                 ~ "&nbsp;▤&nbsp;html&nbsp;scroll&nbsp;</a>] "
-                 ~ "[<a href=\""    ~ doc_matters.src.filename_base ~ "/toc.html\">"
-                 ~ "&nbsp;※&nbsp;html&nbsp;seg&nbsp;</a>]"
+    metadata_ ~= "<p class=\"lev1\">●&nbsp;&nbsp;outputs:&nbsp;&nbsp;[&nbsp;html:&nbsp;<a href=\""    ~ doc_matters.src.filename_base ~ ".html\">"
+                 ~ "&nbsp;▤&nbsp;scroll&nbsp;</a>&nbsp;"
+                 ~ "|<a href=\""    ~ doc_matters.src.filename_base ~ "/toc.html\">"
+                 ~ "&nbsp;※&nbsp;seg&nbsp;</a>]&nbsp;&nbsp;&nbsp;"
                  ~ "[<a href=\"../../" ~ pth_epub.internal_base ~ "/" ~ doc_matters.src.filename_base ~ "." ~ doc_matters.src.language ~ ".epub\">"
-                 ~ "&nbsp;◆&nbsp;epub&nbsp;</a>]";
+                 ~ "&nbsp;◆&nbsp;epub&nbsp;</a>]&nbsp;&nbsp;&nbsp;";
     if ((doc_matters.opt.action.html_link_pdf) || (doc_matters.opt.action.html_link_pdf_a4)) {
+      metadata_ ~=  "[&nbsp;pdf:&nbsp;<a href=\"../../pdf/"
+                 ~ doc_matters.src.filename_base
+                 ~ "." ~ doc_matters.src.language ~ ".a4.portrait.pdf\">"
+                 ~ "&nbsp;□&nbsp;a4&nbsp;</a>&nbsp"
+                 ~ "|<a href=\"../../pdf/"
+                 ~ doc_matters.src.filename_base
+                 ~ "." ~ doc_matters.src.language ~ ".letter.portrait.pdf\">"
+                 ~ "&nbsp;□&nbsp;U.S.&nbsp;letter&nbsp;</a>]&nbsp";
+    } else if (doc_matters.opt.action.html_link_pdf_a4) {
       metadata_ ~=  "[<a href=\"../../pdf/"
                  ~ doc_matters.src.filename_base
                  ~ "." ~ doc_matters.src.language ~ ".a4.portrait.pdf\">"
-                 ~ "&nbsp;□&nbsp;pdf&nbsp;(a4)&nbsp;</a>]";
-    }
-    if ((doc_matters.opt.action.html_link_pdf) || (doc_matters.opt.action.html_link_pdf_letter)) {
+                 ~ "&nbsp;□&nbsp;pdf&nbsp;(a4)&nbsp;</a>]&nbsp";
+    } else if (doc_matters.opt.action.html_link_pdf_letter) {
       metadata_ ~=  "[<a href=\"../../pdf/"
                  ~ doc_matters.src.filename_base
                  ~ "." ~ doc_matters.src.language ~ ".letter.portrait.pdf\">"
-                 ~ "&nbsp;□&nbsp;pdf&nbsp;(U.S.&nbsp;letter)&nbsp;</a>]";
+                 ~ "&nbsp;□&nbsp;pdf&nbsp;(U.S.&nbsp;letter)&nbsp;</a>]&nbsp";
     }
     metadata_ ~=  "</p>";
     if (doc_matters.conf_make_meta.meta.classify_topic_register_arr.length > 0) {
diff --git a/src/doc_reform/io_out/xmls.d b/src/doc_reform/io_out/xmls.d
index c38844c..4fd4e1b 100644
--- a/src/doc_reform/io_out/xmls.d
+++ b/src/doc_reform/io_out/xmls.d
@@ -320,7 +320,7 @@ template outputXHTMLs() {
     ) {
       string o;
       string metadata_links = ((doc_matters.opt.action.html_link_curate)
-        ? format(q"┃<p class="small"><a href="%s">⟰&nbsp;</a>&nbsp;[<a href="%s">&nbsp;%s&nbsp;</a><a href="%sepub/%s.%s.epub">&nbsp;◆&nbsp;</a>%s%s<a href="%smetadata.%s.html">&nbsp;⌘•&nbsp;</a>]&nbsp;&nbsp;<a href="%s../../index.html">&nbsp;≅&nbsp;</a>|<a href="%s../../authors.html">&nbsp;&#x1F58B;&nbsp;</a>|<a href="%s../../topics.html">&nbsp;⌘&nbsp;</a>|</p>┃",
+        ? format(q"┃<p class="small"><a href="%s">⟰&nbsp;</a>&nbsp;[<a href="%s">&nbsp;%s&nbsp;</a><a href="%sepub/%s.%s.epub">&nbsp;◆&nbsp;</a>%s%s<a href="%smetadata.%s.html">&nbsp;ℹ&nbsp;</a>]&nbsp;&nbsp;<a href="%s../../index.html">&nbsp;≅&nbsp;</a>|<a href="%s../../authors.html">&nbsp;&#x1F58B;&nbsp;</a>|<a href="%s../../topics.html">&nbsp;⌘&nbsp;</a>|</p>┃",
             (doc_matters.opt.action.webserver_url_doc_root.length > 0)
               ? doc_matters.opt.action.webserver_url_doc_root
               : doc_matters.conf_make_meta.conf.w_srv_data_root_url