-*- mode: org -*- #+TITLE: spine (doc_reform) output xmls #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :spine:output:xml: #+AUTHOR: Ralph Amissah #+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] #+COPYRIGHT: Copyright (C) 2015 - 2023 Ralph Amissah #+LANGUAGE: en #+STARTUP: content hideblocks hidestars noindent entitiespretty #+PROPERTY: header-args :exports code #+PROPERTY: header-args+ :noweb yes #+PROPERTY: header-args+ :results no #+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]] #+NAME: year #+BEGIN_SRC text 2023 #+END_SRC * html snippet ** _module template_ :module: #+HEADER: :tangle "../src/doc_reform/io_out/html_snippet.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> module doc_reform.io_out.html_snippet; template htmlSnippet() { import std.file, std.outbuffer, std.format, std.uri, std.conv : to; import doc_reform.io_out.rgx, doc_reform.meta.rgx_files, doc_reform.io_out.rgx_xhtml; auto format_html_blank_page_guide_home()( string css_style, string home_url, string collection_home_path ) { auto html_blank_default = format(q"┃

⟰    ≅ 

┃", css_style, home_url, collection_home_path ); 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, "
") .replaceAll(rgx.br_line_inline, "
") .replaceAll(rgx.br_line_spaced, "
\n
") .replaceAll(rgx.nbsp_char, " "); return _txt; } } #+END_SRC * xml offspring (xhtml html epub) ** format xhtml objects :format: *** _module template_ :module: #+HEADER: :tangle "../src/doc_reform/io_out/xmls.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> module doc_reform.io_out.xmls; template outputXHTMLs() { <> mixin spineRgxOut; mixin spineRgxXHTML; struct outputXHTMLs { static auto rgx = RgxO(); static auto rgx_xhtml = RgxXHTML(); <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> } } #+END_SRC *** output imports **** xml html #+NAME: output_imports_xml #+BEGIN_SRC d import std.file, std.outbuffer, std.uri, std.conv : to; import doc_reform.io_out, doc_reform.io_out.rgx, doc_reform.meta.rgx_files, doc_reform.io_out.rgx_xhtml, doc_reform.io_out.create_zip_file, doc_reform.io_out.xmls, doc_reform.io_out.xmls_css; #+END_SRC **** epub3 #+NAME: output_imports_epub #+BEGIN_SRC d import std.file, std.outbuffer, std.uri, std.zip, std.conv : to; import doc_reform.io_out, doc_reform.io_out.rgx, doc_reform.io_out.rgx_xhtml, doc_reform.io_out.create_zip_file, doc_reform.io_out.xmls, doc_reform.io_out.xmls_css; #+END_SRC *** misc **** div delimiter #+NAME: xhtml_format_objects_div_delimit #+BEGIN_SRC d @safe string div_delimit( string section, return ref string previous_section ) { string delimit = ""; string delimit_ = ""; if (section != previous_section) { switch (section) { case "head": delimit_ ~= "\n
\n" ; break; case "toc": delimit_ ~= "\n
\n" ; break; case "bookindex": delimit_ ~= "\n
\n" ; break; default: delimit_ ~= "\n
\n" ; break; } if (previous_section.length > 0) { delimit ~= "\n
"; } previous_section = section; delimit ~= delimit_; } // you also need to close the last div, introduce a footer? return delimit; } #+END_SRC **** special characters text #+NAME: xhtml_format_objects_special_characters_text #+BEGIN_SRC d @safe string special_characters_text(string _txt) { _txt = _txt .replaceAll(rgx_xhtml.ampersand, "&") // "&" .replaceAll(rgx_xhtml.quotation, """) // """ .replaceAll(rgx_xhtml.less_than, "<") // "<" .replaceAll(rgx_xhtml.greater_than, ">") // ">" .replaceAll(rgx.br_line, "
") .replaceAll(rgx.br_line_inline, "
") .replaceAll(rgx.br_line_spaced, "
\n
") .replaceAll(rgx.nbsp_char, " "); return _txt; } #+END_SRC **** special characters date #+NAME: xhtml_format_objects_special_characters_date #+BEGIN_SRC d @safe string special_characters_date(string _txt) { _txt = _txt .replaceAll(regex(r"(?:-00)+"), "") .replaceAll(rgx.br_line, "
") .replaceAll(rgx.br_line_inline, "
") .replaceAll(rgx.br_line_spaced, "
\n
") .replaceAll(rgx.nbsp_char, " "); return _txt; } #+END_SRC **** breaks indents bullets #+NAME: xhtml_format_objects_breaks_indents_bullets #+BEGIN_SRC d @safe string special_characters_breaks_indents_bullets(O)( const O obj, ) { string _txt = special_characters_text(obj.text); if (obj.metainfo.is_a == "group") { _txt = (_txt) .replaceAll(rgx.grouped_para_indent_1, "  ") .replaceAll(rgx.grouped_para_indent_2, "    ") .replaceAll(rgx.grouped_para_indent_3, "      ") .replaceAll(rgx.grouped_para_indent_4, "        ") .replaceAll(rgx.grouped_para_indent_5, "          ") .replaceAll(rgx.grouped_para_indent_6, "            ") .replaceAll(rgx.grouped_para_indent_7, "              ") .replaceAll(rgx.grouped_para_indent_8, "                ") .replaceAll(rgx.grouped_para_indent_9, "                  ") .replaceAll(rgx.grouped_para_indent_hang, "  ") .replaceAll(rgx.grouped_para_bullet, "●  ") .replaceAll(rgx.grouped_para_bullet_indent_1, "  ●  ") .replaceAll(rgx.grouped_para_bullet_indent_2, "    ●  ") .replaceAll(rgx.grouped_para_bullet_indent_3, "      ●  ") .replaceAll(rgx.grouped_para_bullet_indent_4, "        ●  ") .replaceAll(rgx.grouped_para_bullet_indent_5, "          ●  ") .replaceAll(rgx.grouped_para_bullet_indent_6, "            ●  ") .replaceAll(rgx.grouped_para_bullet_indent_7, "              ●  ") .replaceAll(rgx.grouped_para_bullet_indent_8, "                ●  ") .replaceAll(rgx.grouped_para_bullet_indent_9, "                  ●  "); } if (!(obj.metainfo.is_a == "code")) { _txt = (_txt) .replaceAll(rgx_xhtml.line_break, "
"); } return _txt; } #+END_SRC **** font_face #+NAME: xhtml_format_objects_font_face #+BEGIN_SRC d @safe string font_face(string _txt) { _txt = _txt .replaceAll(rgx.inline_emphasis, ("$1")) .replaceAll(rgx.inline_bold, ("$1")) .replaceAll(rgx.inline_underscore, ("$1")) .replaceAll(rgx.inline_italics, ("$1")) .replaceAll(rgx.inline_superscript, ("$1")) .replaceAll(rgx.inline_subscript, ("$1")) .replaceAll(rgx.inline_strike, ("$1")) .replaceAll(rgx.inline_insert, ("$1")) .replaceAll(rgx.inline_mono, ("$1")) .replaceAll(rgx.inline_cite, ("$1")); return _txt; } #+END_SRC **** anchor tags #+NAME: xhtml_format_objects_xml_anchor_tags #+BEGIN_SRC d @safe string _xhtml_anchor_tags(O)(O obj) { string tags=""; if (obj.tags.anchor_tags.length > 0) { foreach (tag; obj.tags.anchor_tags) { if (!(tag.empty)) { tags ~= ""; } } } return tags; } #+END_SRC **** doc head & tails ***** metadata #+NAME: xhtml_format_objects_header_metadata #+BEGIN_SRC d @safe string header_metadata(M)( M doc_matters, ) { string _publisher="Publisher"; // TODO string o; o = format(q"┃ ┃", special_characters_text(doc_matters.conf_make_meta.meta.title_full), special_characters_text(doc_matters.conf_make_meta.meta.creator_author), _publisher, special_characters_date(doc_matters.conf_make_meta.meta.date_published), special_characters_text(doc_matters.conf_make_meta.meta.date_created), special_characters_text(doc_matters.conf_make_meta.meta.date_issued), special_characters_text(doc_matters.conf_make_meta.meta.date_available), special_characters_text(doc_matters.conf_make_meta.meta.date_valid), special_characters_text(doc_matters.conf_make_meta.meta.date_modified), doc_matters.src.language, special_characters_text(doc_matters.conf_make_meta.meta.rights_copyright), doc_matters.opt.action.generated_by ? special_characters_text(doc_matters.generator_program.name_and_version) : "", special_characters_text(doc_matters.generator_program.url_home), ); return o; } #+END_SRC ***** site info button #+NAME: xhtml_format_objects_site_info_button #+BEGIN_SRC d @safe string site_info_button(M)( M doc_matters, ) { string _locations; if (doc_matters.conf_make_meta.make.home_button_text.length > 0) { _locations = (doc_matters.conf_make_meta.make.home_button_text) .replaceAll( rgx.inline_link, ("

$1

")) .replaceAll( rgx.br_line, "") .replaceAll( rgx.br_line_inline, ""); } else { _locations = "

spine

\n

sources / git

\n

www.sisudoc.org

"; } string o; o = format(q"┃
%s
┃", _locations, ); return o; } #+END_SRC ***** search form #+NAME: xhtml_format_objects_inline_search_form #+BEGIN_SRC d @safe string inline_search_form(M)( M doc_matters, ) { string o; string _form; if (doc_matters.opt.action.html_link_search) { o = format(q"┃
  %s %s
   %s
┃", doc_matters.conf_make_meta.conf.w_srv_cgi_action, (doc_matters.conf_make_meta.conf.w_srv_db_sqlite_filename.empty) ? "" : "\n 🔎 ", (doc_matters.conf_make_meta.conf.w_srv_db_sqlite_filename.empty) ? "" : "\n ", doc_matters.src.filename_base, doc_matters.conf_make_meta.conf.w_srv_cgi_action, (doc_matters.conf_make_meta.conf.w_srv_db_sqlite_filename.empty) ? "" : "\n ", doc_matters.src.filename_base, ); } else { o = ""; } return o; } #+END_SRC ***** html head & head banner ▣ ▤ ⁜ ☀ ፨ ፠ ※ ■ □ ▢ ▣ ▤ ▥ ▦ ▧ ▨ 〓 ⚏ ⚏ ⌘ 🫛 ⌥ ⟰ #+NAME: xhtml_format_objects_html_head #+BEGIN_SRC d @safe string html_head(M)( M doc_matters, string type, ) { string o; string metadata_links = ((doc_matters.opt.action.html_link_curate) ? format(q"┃

⟰  [ %s  ◆ %s%s ℹ ]   ≅ | 🖋 | ⌘ |

┃", (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 , // HOME index.html equivalent _cfg.www_url_doc_root, (type == "seg") ? "../" ~ doc_matters.src.filename_base ~ ".html" : "./" ~ doc_matters.src.filename_base ~ "/toc.html", (type == "seg") ? "▤" : "※", (type == "seg") ? "../../" : "../", doc_matters.src.filename_base, doc_matters.src.lng, (doc_matters.opt.action.html_link_pdf || doc_matters.opt.action.html_link_pdf_a4) ? (" □ ") : "", (doc_matters.opt.action.html_link_pdf || doc_matters.opt.action.html_link_pdf_letter) ? (" □ ") : "", (type == "seg") ? "../" : "", doc_matters.src.filename_base, (type == "seg") ? "../" : "", (type == "seg") ? "../" : "", (type == "seg") ? "../" : "", ) : ""); o = format(q"┃ %s%s %s
%s
%s
%s
┃", special_characters_text(doc_matters.conf_make_meta.meta.title_full), (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : ", " ~ special_characters_text(doc_matters.conf_make_meta.meta.creator_author), header_metadata(doc_matters), ((type == "seg") ? "../" : ""), ((type == "seg") ? "../../../css/html_seg.css" : "../../css/html_scroll.css"), doc_matters.src.language, site_info_button(doc_matters), metadata_links, inline_search_form(doc_matters), ); return o; } #+END_SRC ***** epub seg head #+NAME: xhtml_format_objects_epub3_seg_head #+BEGIN_SRC d @safe string epub3_seg_head(M)( M doc_matters, ) { string html_base = format(q"┃ ┃", ); string html_simple = format(q"┃ ┃", doc_matters.src.language, doc_matters.src.language, ); string html_strict = format(q"┃ ┃", doc_matters.src.language, doc_matters.src.language, ); string o; o = format(q"┃%s %s%s ┃", html_simple, special_characters_text(doc_matters.conf_make_meta.meta.title_full), (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : ", " ~ special_characters_text(doc_matters.conf_make_meta.meta.creator_author), special_characters_text(doc_matters.conf_make_meta.meta.title_full), (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : ", " ~ special_characters_text(doc_matters.conf_make_meta.meta.creator_author), special_characters_date(doc_matters.conf_make_meta.meta.date_published), special_characters_text(doc_matters.conf_make_meta.meta.date_created), special_characters_text(doc_matters.conf_make_meta.meta.date_issued), special_characters_text(doc_matters.conf_make_meta.meta.date_available), special_characters_text(doc_matters.conf_make_meta.meta.date_valid), special_characters_text(doc_matters.conf_make_meta.meta.date_modified), doc_matters.src.language, special_characters_text(doc_matters.conf_make_meta.meta.rights_copyright), special_characters_text(doc_matters.generator_program.name_and_version), special_characters_text(doc_matters.generator_program.url_home), doc_matters.src.language, ); return o; } #+END_SRC ***** xhtml dom tail #+NAME: xhtml_format_objects_dom_close #+BEGIN_SRC d @safe string dom_close() { string o; o = format(q"┃
┃"); return o; } #+END_SRC ***** xhtml tail #+NAME: xhtml_format_objects_tail #+HEADER: :noweb yes #+BEGIN_SRC d @safe string tail(M)(M doc_matters) { string o; o = format(q"┃
%s

%s

≅ SiSU Spine ፨ (object numbering & object search)

(web 1993, object numbering 1997, object search 2002 ...) <>

┃", special_characters_text(doc_matters.conf_make_meta.meta.rights_copyright), ((doc_matters.conf_make_meta.meta.rights_license).empty) ? "" : "
", ((doc_matters.conf_make_meta.meta.rights_license).empty) ? "" : "License: " ~ special_characters_text(doc_matters.conf_make_meta.meta.rights_license) ); return o; } #+END_SRC *** inline markup **** images #+NAME: xhtml_format_objects_inline_images #+BEGIN_SRC d @safe string inline_images(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "seg", ) { string _img_pth; switch (_xml_type) { case "epub": _img_pth = "image/"; break; case "scroll": _img_pth = format(q"┃%s/image/┃", "../.."); break; case "seg": _img_pth = format(q"┃%s/image/┃", "../../.."); break; default: break; } if (_txt.match(rgx.inline_image)) { _txt = _txt .replaceAll(rgx.inline_image, ("$1 $6")) .replaceAll( rgx.inline_link_empty, ("$1")); } return _txt; } #+END_SRC **** links ***** scroll, seg, epub #+NAME: xhtml_format_objects_inline_links #+BEGIN_SRC d @safe string inline_links(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "seg", ) { string seg_lvs; if (obj.has.inline_links) { if (obj.metainfo.is_a != "code") { _txt = replaceAll!(m => m[1] ~ "┤" ~ (replaceAll!(n => n["type"] ~ n["path"] ~ (n["file"].encodeComponent) )((obj.stow.link[m["num"].to!ulong]).to!string, rgx.uri_identify_components)) ~ "├" )(_txt, rgx.inline_link_number_only); } if ((_txt.match(rgx.mark_internal_site_lnk)) && (_xml_type == "scroll")) { // conditions reversed to avoid: gdc compiled program run segfault _txt = _txt.replaceAll( rgx.inline_seg_link, "$1"); } if (_xml_type == "seg" || _xml_type == "epub") { seg_lvs = (_xml_type == "epub") ? "seg_lv1to4" : "seg_lv4"; foreach (m; _txt.match(rgx.inline_link_hash)) { if (m.captures["hash"] in doc_matters.has.tag_associations) { if ( m.captures["hash"] == doc_matters.has.tag_associations[(m.captures["hash"])][seg_lvs] ) { _txt = _txt.replaceFirst( rgx.inline_link_hash, "┥$1┝┤$3" ~ _suffix ~ "├" ); } else { _txt = _txt.replaceFirst( rgx.inline_link_hash, "┥$1┝┤" ~ doc_matters.has.tag_associations[(m.captures["hash"])][seg_lvs] ~ _suffix ~ "#" ~ "$3" ~ "├" ); } } else { if (doc_matters.opt.action.vox_gt0) { writeln( "WARNING on internal document links, anchor to link <<" ~ m.captures["hash"] ~ ">> not found in document, " ~ "anchor: " ~ m.captures["hash"] ~ " document: " ~ doc_matters.src.filename ); } } } } _txt = _txt .replaceAll( rgx.inline_link_fn_suffix, ("$1" ~ _suffix)) .replaceAll( rgx.inline_link, ("$1")) .replaceAll( rgx.mark_internal_site_lnk, ""); } debug(markup_links) { if (_txt.match(rgx.inline_link)) { writeln(__LINE__, " (missed) markup link identified (", obj.has.inline_links, "): ", obj.metainfo.is_a, ": ", obj.text ); } } debug(markup) { if (_txt.match(rgx.inline_link)) { writeln(__LINE__, " (missed) markup link identified (", obj.has.inline_links, "): ", obj.metainfo.is_a, ": ", obj.text ); } } return _txt; } #+END_SRC **** notes ***** scroll #+NAME: xhtml_format_objects_inline_notes_scroll #+BEGIN_SRC d @safe string inline_notes_scroll(O,M)( string _txt, const O obj, M doc_matters, ) { if (obj.has.inline_notes_reg) { _txt = font_face(_txt); _txt = _txt.replaceAll( rgx.inline_notes_al_regular_number_note, (" $1 ") ); } if (obj.has.inline_notes_star) { _txt = font_face(_txt); _txt = _txt.replaceAll( rgx.inline_notes_al_special_char_note, (" $1 ") ); } debug(markup_endnotes) { if (_txt.match(rgx.inline_notes_al_regular_number_note)) { writeln(__LINE__, " (missed) markup endnote: ", obj.metainfo.is_a, ": ", obj.text); } } debug(markup) { if (_txt.match(rgx.inline_notes_al_regular_number_note)) { writeln(__LINE__, " (missed) markup endnote: ", obj.metainfo.is_a, ": ", obj.text); } } return _txt; } #+END_SRC ***** seg #+NAME: xhtml_format_objects_inline_notes_seg #+BEGIN_SRC d @safe Tuple!(string, string[]) inline_notes_seg(O,M)( string _txt, const O obj, M doc_matters, ) { string[] _endnotes; if (obj.has.inline_notes_star) { _txt = font_face(_txt); /+ need markup for text, and separated footnote +/ foreach(m; _txt.matchAll(rgx.inline_notes_al_special_char_note)) { _endnotes ~= format( "%s%s%s%s\n %s%s%s%s%s %s\n%s", "

", "", " ", m.captures[1], ".", m.captures[2], "

" ); } _txt = _txt.replaceAll( rgx.inline_notes_al_special_char_note, (" $1 ") ); } if (obj.has.inline_notes_reg) { _txt = font_face(_txt); /+ need markup for text, and separated footnote +/ foreach(m; _txt.matchAll(rgx.inline_notes_al_regular_number_note)) { _endnotes ~= format( "%s%s%s%s\n %s%s%s%s%s %s\n%s", "

", "", " ", m.captures[1], ".", m.captures[2], "

" ); } _txt = _txt.replaceAll( rgx.inline_notes_al_regular_number_note, (" $1 ") ); } else if (_txt.match(rgx.inline_notes_al_regular_number_note)) { debug(markup) { writeln(__LINE__, " endnote: ", obj.metainfo.is_a, ": ", obj.text); } } Tuple!(string, string[]) t = tuple( _txt, _endnotes, ); return t; } #+END_SRC **** inline markup ***** scroll #+NAME: xhtml_format_objects_inline_markup_scroll #+BEGIN_SRC d @safe string inline_markup_scroll(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", ) { if (obj.metainfo.dummy_heading && (obj.metainfo.is_a == "toc" || obj.metainfo.is_a == "heading")) { _txt = ""; } else { _txt = inline_images(_txt, obj, doc_matters, _suffix, "scroll"); _txt = inline_links(_txt, obj, doc_matters, _suffix, "scroll"); _txt = inline_notes_scroll(_txt, obj, doc_matters); } return _txt; } #+END_SRC ***** seg #+NAME: xhtml_format_objects_inline_markup_seg #+BEGIN_SRC d @safe Tuple!(string, string[]) inline_markup_seg(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "seg", ) { if (obj.metainfo.dummy_heading && ((_xml_type == "epub" && (obj.metainfo.is_a == "toc" || obj.metainfo.is_a == "heading")) || obj.metainfo.is_a == "heading") ) { _txt = ""; } else { _txt = inline_images(_txt, obj, doc_matters, _suffix, _xml_type); // TODO _txt = inline_links(_txt, obj, doc_matters, _suffix, _xml_type); // TODO } Tuple!(string, string[]) t = inline_notes_seg(_txt, obj, doc_matters); return t; } #+END_SRC *** toc **** subtoc #+NAME: xhtml_format_objects_lev4_heading_subtoc #+BEGIN_SRC d @safe string lev4_heading_subtoc(O,M)( const O obj, M doc_matters, ) { char[] lev4_subtoc; lev4_subtoc ~= "
\n"; foreach (subtoc; obj.tags.lev4_subtoc) { if (auto m = subtoc.match(rgx.inline_link_subtoc)) { auto indent = (m.captures[1].to!int - 3).to!string; // css assumptions based on use of em for left margin & indent auto text = m.captures[2].to!string; text = font_face(text); auto link = m.captures[3].to!string; lev4_subtoc ~= subtoc.replaceFirst(rgx.inline_link_subtoc, format(q"┃

۰ %s

┃", indent, indent, link, text, )); } } lev4_subtoc ~= "
\n"; return lev4_subtoc.to!string; } #+END_SRC **** navigation pre next svg #+NAME: xhtml_format_objects_nav_pre_next_svg #+BEGIN_SRC d @safe auto nav_pre_next_svg(O,M)( const O obj, M doc_matters, ) { string prev, next, toc; if (obj.tags.segment_anchor_tag_epub == "toc") { toc = ""; prev = ""; } else { toc = format(q"┃
┃", ); } if (obj.tags.segname_prev == "") { prev = ""; } else { prev = format(q"┃ ┃", obj.tags.segname_prev, ); } if (obj.tags.segname_next == "") { next = ""; } else { next = format(q"┃ ┃", obj.tags.segname_next, ); } string _toc_pre_next = format(q"┃
%s %s %s
┃", toc, prev, next, ); string _pre_next = format(q"┃
%s %s
┃", prev, next, ); struct bar { string toc_pre_next() { return _toc_pre_next; } string pre_next() { return _pre_next; } } return bar(); } #+END_SRC *** heading **** heading #+NAME: xhtml_format_objects_heading #+BEGIN_SRC d @safe string heading(O,M)( string _txt, const O obj, M doc_matters, string _xml_type = "html", ) { assert(obj.metainfo.is_of_part == "body" || "frontmatter" || "backmatter"); assert(obj.metainfo.is_of_section == "body" || "toc" || "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb"); assert(obj.metainfo.is_of_type == "para"); assert(obj.metainfo.is_a == "heading"); string tags = _xhtml_anchor_tags(obj); string heading_lev_anchor_tag; string _horizontal_rule = "
"; if ((_xml_type != "html") || (obj.metainfo.heading_lev_markup == 0 || obj.metainfo.heading_lev_markup > 4)) { _horizontal_rule = ""; } _txt = font_face(_txt); string o; heading_lev_anchor_tag = (obj.tags.heading_lev_anchor_tag.empty) ? "" : ""; if (_txt.empty) { o = format(q"┃%s ┃", _horizontal_rule, ); } else { o = ""; if (obj.metainfo.is_of_section == "toc") { o ~= format(q"┃
┃", special_characters_text(doc_matters.conf_make_meta.meta.rights_copyright), special_characters_text(doc_matters.conf_make_meta.meta.rights_license) ); } } if (!(obj.metainfo.identifier.empty)) { o ~= format(q"┃%s
%s%s %s
┃", _horizontal_rule, obj.metainfo.identifier, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), ((_xml_type == "epub" && obj.metainfo.heading_lev_markup == 0) ? 1 : obj.metainfo.heading_lev_markup), obj.metainfo.is_a, obj.metainfo.identifier, obj.metainfo.identifier, tags, heading_lev_anchor_tag, _txt, ((_xml_type == "epub" && obj.metainfo.heading_lev_markup == 0) ? 1 : obj.metainfo.heading_lev_markup), ); } else { o ~= format(q"┃%s
%s%s %s
┃", _horizontal_rule, ((_xml_type == "epub" && obj.metainfo.heading_lev_markup == 0) ? 1 : obj.metainfo.heading_lev_markup), obj.metainfo.is_a, tags, heading_lev_anchor_tag, _txt, ((_xml_type == "epub" && obj.metainfo.heading_lev_markup == 0) ? 1 : obj.metainfo.heading_lev_markup), ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_heading_scroll #+BEGIN_SRC d @safe string heading_scroll(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", ) { _txt = inline_markup_scroll(_txt, obj, doc_matters, _suffix); string o = heading(_txt, obj, doc_matters); return o; } #+END_SRC **** seg #+NAME: xhtml_format_objects_heading_seg #+BEGIN_SRC d @safe Tuple!(string, string[]) heading_seg(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { Tuple!(string, string[]) t = inline_markup_seg(_txt, obj, doc_matters, _suffix, _xml_type); _txt = t[0]; string[] _endnotes = t[1]; string o = heading(_txt, obj, doc_matters, _xml_type); Tuple!(string, string[]) u = tuple( o, _endnotes, ); return u; } #+END_SRC *** para **** para #+NAME: xhtml_format_objects_para #+BEGIN_SRC d @safe string para(O,M)( string _txt, const O obj, M doc_matters, ) { assert(obj.metainfo.is_of_part == "body" || "frontmatter" || "backmatter"); assert(obj.metainfo.is_of_section == "body" || "toc" || "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb"); assert(obj.metainfo.is_of_type == "para"); assert(obj.metainfo.is_a == "para" || "toc" || "endnote" || "glossary" || "bibliography" || "bookindex" || "blurb"); string tags = _xhtml_anchor_tags(obj); _txt = font_face(_txt); string o; _txt = (obj.attrib.bullet) ? ("●  " ~ _txt) : _txt; _txt = _txt.replaceFirst(rgx.inline_link_anchor, ""); if (!(obj.metainfo.identifier.empty)) { o = format(q"┃

%s %s

┃", obj.metainfo.identifier, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), obj.metainfo.is_a, obj.attrib.indent_hang, obj.attrib.indent_base, obj.metainfo.identifier, tags, _txt ); } else { o = format(q"┃

%s %s

┃", obj.metainfo.is_a, obj.attrib.indent_hang, obj.attrib.indent_base, tags, _txt ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_para_scroll #+BEGIN_SRC d @safe string para_scroll(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", ) { if (obj.metainfo.is_a == "toc" && _txt.match(rgx.inline_link_toc_to_backmatter)) { _txt = _txt.replaceAll(rgx.inline_link_toc_to_backmatter, "┤#section_$1├"); } _txt = inline_markup_scroll(_txt, obj, doc_matters, _suffix); string o = para(_txt, obj, doc_matters); return o; } #+END_SRC **** seg #+NAME: xhtml_format_objects_para_seg #+BEGIN_SRC d @safe Tuple!(string, string[]) para_seg(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { Tuple!(string, string[]) t = inline_markup_seg(_txt, obj, doc_matters, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = para(_txt, obj, doc_matters); Tuple!(string, string[]) u = tuple( o, _endnotes, ); return u; } #+END_SRC *** quote **** quote #+NAME: xhtml_format_objects_quote #+BEGIN_SRC d @safe string quote(O,M)( string _txt, const O obj, M doc_matters, ) { assert(obj.metainfo.is_of_part == "body"); assert(obj.metainfo.is_of_section == "body" || "glossary" || "bibliography" || "bookindex" || "blurb"); assert(obj.metainfo.is_of_type == "block"); assert(obj.metainfo.is_a == "quote"); _txt = font_face(_txt); string o; if (!(obj.metainfo.identifier.empty)) { o = format(q"┃

%s

┃", obj.metainfo.identifier, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), obj.metainfo.is_a, obj.metainfo.identifier, _txt ); } else { o = format(q"┃

%s

┃", obj.metainfo.is_a, _txt ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_quote_scroll #+BEGIN_SRC d @safe string quote_scroll(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", ) { _txt = inline_markup_scroll(_txt, obj, doc_matters, _suffix); string o = quote(_txt, obj, doc_matters); return o; } #+END_SRC **** seg #+NAME: xhtml_format_objects_quote_seg #+BEGIN_SRC d @safe Tuple!(string, string[]) quote_seg(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { Tuple!(string, string[]) t = inline_markup_seg(_txt, obj, doc_matters, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = quote(_txt, obj, doc_matters); Tuple!(string, string[]) u = tuple( o, _endnotes, ); return u; } #+END_SRC *** group **** group #+NAME: xhtml_format_objects_group #+BEGIN_SRC d @safe string group(O,M)( string _txt, const O obj, M doc_matters, ) { assert(obj.metainfo.is_of_part == "body"); assert(obj.metainfo.is_of_section == "body" || "glossary" || "bibliography" || "bookindex" || "blurb"); assert(obj.metainfo.is_of_type == "block"); assert(obj.metainfo.is_a == "group"); _txt = font_face(_txt); string o; if (!(obj.metainfo.identifier.empty)) { o = format(q"┃

%s

┃", obj.metainfo.identifier, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), obj.metainfo.is_a, obj.metainfo.identifier, _txt ); } else { o = format(q"┃

%s

┃", obj.metainfo.is_a, _txt ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_group_scroll #+BEGIN_SRC d @safe string group_scroll(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { _txt = inline_markup_scroll(_txt, obj, doc_matters, _suffix); string o = group(_txt, obj, doc_matters); return o; } #+END_SRC **** seg #+NAME: xhtml_format_objects_group_seg #+BEGIN_SRC d @safe Tuple!(string, string[]) group_seg(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { Tuple!(string, string[]) t = inline_markup_seg(_txt, obj, doc_matters, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = group(_txt, obj, doc_matters); Tuple!(string, string[]) u = tuple( o, _endnotes, ); return u; } #+END_SRC *** block **** block #+NAME: xhtml_format_objects_block #+BEGIN_SRC d @safe string block(O,M)( string _txt, const O obj, M doc_matters, ) { assert(obj.metainfo.is_of_part == "body"); assert(obj.metainfo.is_of_section == "body" || "glossary" || "bibliography" || "bookindex" || "blurb"); assert(obj.metainfo.is_of_type == "block"); assert(obj.metainfo.is_a == "block"); _txt = font_face(_txt); string o; if (!(obj.metainfo.identifier.empty)) { o = format(q"┃

%s

┃", obj.metainfo.identifier, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), obj.metainfo.is_a, obj.metainfo.identifier, _txt.stripRight ); } else { o = format(q"┃

%s

┃", obj.metainfo.is_a, _txt.stripRight ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_block_scroll #+BEGIN_SRC d @safe string block_scroll(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { _txt = inline_markup_scroll(_txt, obj, doc_matters, _suffix); string o = block(_txt, obj, doc_matters); return o; } #+END_SRC **** seg #+NAME: xhtml_format_objects_block_seg #+BEGIN_SRC d @safe Tuple!(string, string[]) block_seg(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { Tuple!(string, string[]) t = inline_markup_seg(_txt, obj, doc_matters, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = block(_txt, obj, doc_matters); Tuple!(string, string[]) u = tuple( o, _endnotes, ); return u; } #+END_SRC *** poem verse **** verse #+NAME: xhtml_format_objects_verse #+BEGIN_SRC d @safe string verse(O,M)( string _txt, const O obj, M doc_matters, ) { assert(obj.metainfo.is_of_part == "body"); assert(obj.metainfo.is_of_section == "body" || "glossary" || "bibliography" || "bookindex" || "blurb"); assert(obj.metainfo.is_of_type == "block"); assert(obj.metainfo.is_a == "verse"); _txt = font_face(_txt); string o; if (!(obj.metainfo.identifier.empty)) { o = format(q"┃

%s

┃", obj.metainfo.identifier, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), obj.metainfo.is_a, obj.metainfo.identifier, _txt ); } else { o = format(q"┃

%s

┃", obj.metainfo.is_a, _txt ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_verse_scroll #+BEGIN_SRC d @safe string verse_scroll(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { _txt = inline_markup_scroll(_txt, obj, doc_matters, _suffix); string o = verse(_txt, obj, doc_matters); return o; } #+END_SRC **** seg #+NAME: xhtml_format_objects_verse_seg #+BEGIN_SRC d @safe Tuple!(string, string[]) verse_seg(O,M)( string _txt, const O obj, M doc_matters, string _suffix = ".html", string _xml_type = "html", ) { Tuple!(string, string[]) t = inline_markup_seg(_txt, obj, doc_matters, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = verse(_txt, obj, doc_matters); Tuple!(string, string[]) u = tuple( o, _endnotes, ); return u; } #+END_SRC *** code #+NAME: xhtml_format_objects_code #+BEGIN_SRC d @safe string code(O,M)( string _txt, const O obj, M doc_matters, ) { assert(obj.metainfo.is_of_part == "body"); assert(obj.metainfo.is_of_section == "body"); assert(obj.metainfo.is_of_type == "block"); assert(obj.metainfo.is_a == "code"); string o; string codelines(string _txt) { string _codelines; if (obj.code_block.linenumbers) { string[] _block_lines = (_txt).split(rgx.br_linebreaks_newlines); _codelines = " 
\n";
      foreach (k, _line; _block_lines) {
        if (k == 1) {
          _codelines ~= format(q"┃    %s
┃",
            _line,
          );
        } else {
          _codelines ~= format(q"┃    %s
┃",
            _line,
          );
        }
      }
      _codelines ~= "
"; } else { _codelines = " 
\n";
      _codelines ~= _txt;
      _codelines ~= "
"; } return _codelines; } if (!(obj.metainfo.identifier.empty)) { o = format(q"┃

%s

┃", obj.metainfo.identifier, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), obj.metainfo.is_a, obj.metainfo.identifier, codelines(_txt) ); } else { o = format(q"┃

%s

┃", obj.metainfo.is_a, codelines(_txt) ); } return o; } #+END_SRC *** table **** TODO tablarize align="left|right|center" $100 "style=\"text-align:right\"" "style=\"text-align:left\"" "style=\"text-align:" ~ "right\"" #+NAME: xhtml_format_objects_tablarize #+BEGIN_SRC d @safe Tuple!(string, string) tablarize(O)( string _txt, const O obj, ) { string[] _table_rows = (_txt).split(rgx.table_delimiter_row); string[] _table_cols; string _table; string _tablenote; foreach(row_idx, row; _table_rows) { _table_cols = row.split(rgx.table_delimiter_col); _table ~= ""; foreach(col_idx, cell; _table_cols) { if ((_table_cols.length == 1) && (_table_rows.length <= row_idx+2)) { _tablenote ~= cell; } else { string _col_is = (row_idx == 0 && obj.table.heading) ? "th" : "td"; string _align = ("style=\"text-align:" ~ ((obj.table.column_aligns[col_idx] == "l") ? "left\"" : "right\"")); _table ~= "<" ~ _col_is ~ " width=\"" ~ obj.table.column_widths[col_idx].to!string ~ "%\" " ~ _align ~ ">"; _table ~= cell; _table ~= ""; } } _table ~= ""; } Tuple!(string, string) t = tuple( _table, _tablenote, ); return t; } #+END_SRC **** table #+NAME: xhtml_format_objects_table #+BEGIN_SRC d @safe string table(O,M)( string _txt, const O obj, M doc_matters, ) { assert(obj.metainfo.is_of_part == "body"); assert(obj.metainfo.is_of_section == "body"); assert(obj.metainfo.is_of_type == "block"); assert(obj.metainfo.is_a == "table"); string tags = _xhtml_anchor_tags(obj); _txt = font_face(_txt); auto t = tablarize(_txt, obj); _txt = t[0]; string _note = t[1]; string o; o = format(q"┃

%s %s
%s

┃", obj.metainfo.object_number, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), obj.metainfo.is_a, obj.metainfo.object_number, tags, _txt, _note ); return o; } #+END_SRC * _html_ [#A] :html: ** _module template_ :module: #+HEADER: :tangle "../src/doc_reform/io_out/html.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> module doc_reform.io_out.html; template outputHTML() { <> mixin outputXHTMLs; @safe void scroll(D,M)( const D doc_abstraction, M doc_matters, ) { <> <> <> <> <> <> } <> @safe void seg(D,M)( const D doc_abstraction, M doc_matters, ) { <> <> <> <> <> <> <> <> } <> <> <> } #+END_SRC ** scroll :scroll: *** ↻ loop & switch (sections & objects) format html output #+NAME: output_html_scroll_0 #+BEGIN_SRC d mixin spineRgxOut; mixin spineRgxXHTML; auto xhtml_format = outputXHTMLs(); static auto rgx = RgxO(); static auto rgx_xhtml = RgxXHTML(); string[] doc_html; string[] doc; string suffix = ".html"; string previous_section = ""; string delimit = ""; #+END_SRC **** ↻ the loops & outer switch (sections & objects) format output #+NAME: output_html_scroll_loop_parts #+BEGIN_SRC d foreach (section; doc_matters.has.keys_seq.scroll) { foreach (obj; doc_abstraction[section]) { delimit = xhtml_format.div_delimit(section, previous_section); string _txt = xhtml_format.special_characters_breaks_indents_bullets(obj); switch (obj.metainfo.is_of_part) { #+END_SRC ***** frontmatter #+NAME: output_html_scroll_is_frontmatter #+BEGIN_SRC d case "frontmatter": assert(section == "head" || "toc"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "heading": doc_html ~= delimit ~ xhtml_format.heading_scroll(_txt, obj, doc_matters, suffix); break; case "toc": doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ***** body #+NAME: output_html_scroll_is_body #+BEGIN_SRC d case "body": assert(section == "body" || "head"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "heading": doc_html ~= delimit ~ xhtml_format.heading_scroll(_txt, obj, doc_matters, suffix); break; case "para": doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; case "block": switch (obj.metainfo.is_a) { case "quote": doc_html ~= xhtml_format.quote_scroll(_txt, obj, doc_matters); break; case "group": doc_html ~= xhtml_format.group_scroll(_txt, obj, doc_matters); break; case "block": doc_html ~= xhtml_format.block_scroll(_txt, obj, doc_matters); break; case "poem": break; case "verse": doc_html ~= xhtml_format.verse_scroll(_txt, obj, doc_matters, suffix); break; case "code": doc_html ~= xhtml_format.code(_txt, obj, doc_matters); break; case "table": doc_html ~= xhtml_format.table(_txt, obj, doc_matters); break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ***** backmatter #+NAME: output_html_scroll_is_backmatter #+BEGIN_SRC d case "backmatter": assert(section == "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "heading": doc_html ~= delimit ~ xhtml_format.heading_scroll(_txt, obj, doc_matters, suffix); break; case "endnote": assert(section == "endnotes"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "glossary": assert(section == "glossary"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "bibliography": assert(section == "bibliography"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "bookindex": assert(section == "bookindex"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "blurb": assert(section == "blurb"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "tail": assert(section == "tail"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; case "comment": break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_part); writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); writeln(__FILE__, ":", __LINE__, ": ", obj.text); } } break; #+END_SRC ***** closings & post loop #+NAME: output_html_scroll_close_is_case #+BEGIN_SRC d } } } doc = xhtml_format.html_head(doc_matters, "scroll") ~ doc_html ~ xhtml_format.dom_close ~ xhtml_format.tail(doc_matters); scroll_write_output(doc, doc_matters); #+END_SRC *** write output file #+NAME: output_html_scroll_scroll_write_output #+BEGIN_SRC d @trusted void scroll_write_output(D,M)( D doc, M doc_matters, ) { debug(asserts) { static assert(is(typeof(doc) == string[])); } auto pth_html = spinePathsHTML!()(doc_matters.output_path, doc_matters.src.language); try { if (!exists(pth_html.base)) { pth_html.base.mkdirRecurse; } { auto f = File(pth_html.fn_scroll(doc_matters.src.filename), "w"); foreach (o; doc) { f.writeln(o); } } 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(format_html_blank_page_guide_home( "../../css/html_scroll.css", "https://sisudoc.org", "../../index.html", )); } } catch (ErrnoException ex) { // Handle error } if (doc_matters.opt.action.vox_gt0) { writeln(" ", pth_html.fn_scroll(doc_matters.src.filename)); } } #+END_SRC ** seg :seg: *** ↻ loop & switch (sections & objects) format html output #+NAME: output_html_seg_0 #+BEGIN_SRC d mixin spineRgxOut; mixin spineRgxXHTML; static auto rgx = RgxO(); static auto rgx_xhtml = RgxXHTML(); auto xhtml_format = outputXHTMLs(); string[][string] doc_html; string[][string] doc_html_endnotes; string[] doc; string segment_filename; string[] top_level_headings = ["","","",""]; string previous_seg_filename = ""; string suffix = ".html"; string previous_section = ""; string delimit = ""; #+END_SRC **** ↻ the loop (sections & objects) format output #+NAME: output_html_seg_loop_parts #+BEGIN_SRC d foreach (section; doc_matters.has.keys_seq.seg) { foreach (obj; doc_abstraction[section]) { delimit = xhtml_format.div_delimit(section, previous_section); string _txt = xhtml_format.special_characters_breaks_indents_bullets(obj); #+END_SRC ***** all headings #+NAME: output_html_seg_is_heading #+BEGIN_SRC d if (obj.metainfo.is_a == "heading") { assert(section == "head" || "toc" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.heading_lev_markup) { case 0: .. case 3: /+ fill buffer, and replace with new levels from 1 to 3 +/ switch (obj.metainfo.heading_lev_markup) { case 0: top_level_headings[0] = ""; top_level_headings[1] = ""; top_level_headings[2] = ""; top_level_headings[3] = ""; goto default; case 1: top_level_headings[1] = ""; top_level_headings[2] = ""; top_level_headings[3] = ""; goto default; case 2: top_level_headings[2] = ""; top_level_headings[3] = ""; goto default; case 3: top_level_headings[3] = ""; goto default; default: Tuple!(string, string[]) t = xhtml_format.heading_seg(_txt, obj, doc_matters, suffix, "seg"); top_level_headings[obj.metainfo.heading_lev_markup] = t[0]; break; } break; case 4: segment_filename = obj.tags.segment_anchor_tag_epub; doc_html[segment_filename] ~= xhtml_format.html_head(doc_matters, "seg"); auto navigation_bar = xhtml_format.nav_pre_next_svg(obj, doc_matters); doc_html[segment_filename] ~= navigation_bar.toc_pre_next; previous_seg_filename = segment_filename; foreach (top_level_heading; top_level_headings) { doc_html[segment_filename] ~= top_level_heading; } Tuple!(string, string[]) t = xhtml_format.heading_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html[segment_filename] ~= xhtml_format.lev4_heading_subtoc(obj, doc_matters); doc_html_endnotes[segment_filename] ~= t[1]; break; case 5: .. case 7: Tuple!(string, string[]) t = xhtml_format.heading_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; break; case 8: .. case 9: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); writeln(__FILE__, ":", __LINE__, ": ", obj.text); } } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); } } break; } #+END_SRC ***** non-heading #+NAME: output_html_seg_is_not_heading_switch #+BEGIN_SRC d } else { assert(section == "head" || "toc" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); Tuple!(string, string[]) t; switch (obj.metainfo.is_of_part) { #+END_SRC ****** frontmatter #+NAME: output_html_seg_is_frontmatter #+BEGIN_SRC d case "frontmatter": assert(section == "head" || "toc"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "toc": t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; #+END_SRC ****** body #+NAME: output_html_seg_is_body #+BEGIN_SRC d case "body": assert(section == "body"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "para": t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; case "block": switch (obj.metainfo.is_a) { case "quote": t = xhtml_format.quote_seg(_txt, obj, doc_matters, suffix, "seg"); goto default; case "group": t = xhtml_format.group_seg(_txt, obj, doc_matters, suffix, "seg"); goto default; case "block": t = xhtml_format.block_seg(_txt, obj, doc_matters, suffix, "seg"); goto default; case "poem": break; case "verse": t = xhtml_format.verse_seg(_txt, obj, doc_matters, suffix, "seg"); goto default; case "code": doc_html[segment_filename] ~= xhtml_format.code(_txt, obj, doc_matters); break; case "table": doc_html[segment_filename] ~= xhtml_format.table(_txt, obj, doc_matters); doc_html_endnotes[segment_filename] ~= ""; break; default: if ((obj.metainfo.is_a == "quote" || obj.metainfo.is_a == "group" || obj.metainfo.is_a == "block" || obj.metainfo.is_a == "verse" )) { doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; } else { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ****** backmatter #+NAME: output_html_seg_is_backmatter #+BEGIN_SRC d case "backmatter": assert(section == "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "endnote": assert(section == "endnotes"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0]; break; case "glossary": assert(section == "glossary"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0]; doc_html_endnotes[segment_filename] ~= t[1]; break; case "bibliography": assert(section == "bibliography"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0]; doc_html_endnotes[segment_filename] ~= t[1]; break; case "bookindex": assert(section == "bookindex"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0]; doc_html_endnotes[segment_filename] ~= t[1]; break; case "blurb": assert(section == "blurb"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0]; doc_html_endnotes[segment_filename] ~= t[1]; break; case "tail": assert(section == "tail"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0]; doc_html_endnotes[segment_filename] ~= t[1]; break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; case "comment": break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_html) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_part); } } break; } #+END_SRC ***** closings & post loop #+NAME: output_html_seg_close_is_case #+BEGIN_SRC d } } } seg_write_output(doc_html, doc_html_endnotes, doc_matters); #+END_SRC *** write output files #+NAME: output_html_seg_write_output #+BEGIN_SRC d @trusted void seg_write_output(D,E,M)( // @system? D doc_html, E doc_html_endnotes, M doc_matters, ) { debug(asserts) { static assert(is(typeof(doc_html) == string[][string])); } mixin spineRgxFiles; static auto rgx_files = RgxFiles(); auto pth_html = spinePathsHTML!()(doc_matters.output_path, doc_matters.src.language); auto xhtml_format = outputXHTMLs(); auto m = doc_matters.src.filename.matchFirst(rgx_files.src_fn); try { if (!exists(pth_html.seg(doc_matters.src.filename))) { pth_html.seg(doc_matters.src.filename).mkdirRecurse; } foreach (seg_filename; doc_matters.has.segnames_lv4) { auto f = File(pth_html.fn_seg(doc_matters.src.filename, seg_filename), "w"); foreach (docseg; doc_html[seg_filename]) { f.writeln(docseg); } foreach (docseg; doc_html_endnotes[seg_filename]) { f.writeln(docseg); } f.writeln(xhtml_format.tail(doc_matters)); } if (!exists(pth_html.fn_seg(doc_matters.src.filename, "index"))) { symlink("./toc.html", (pth_html.fn_seg(doc_matters.src.filename, "index"))); } } catch (ErrnoException ex) { // handle error } if (doc_matters.opt.action.vox_gt0) { writeln(" ", pth_html.fn_seg(doc_matters.src.filename, "toc")); } } #+END_SRC ** css :css: #+NAME: output_html_css #+BEGIN_SRC d @safe void css(M)(M doc_matters) { auto css = spineCss(doc_matters); auto pth_html = spinePathsHTML!()(doc_matters.output_path, doc_matters.src.language); try { if (!exists(pth_html.css)) { (pth_html.css).mkdirRecurse; } { auto f = File(pth_html.fn_seg_css, "w"); f.writeln(css.html_seg); f = File(pth_html.fn_scroll_css, "w"); 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(format_html_blank_page_guide_home( "./css/html_scroll.css", "https://sisudoc.org", "../index.html", )); } } catch (ErrnoException ex) { // Handle error } } #+END_SRC ** images :images: #+NAME: copy_html_images #+BEGIN_SRC d @trusted void images_cp(M)( // @system M doc_matters, ) { { /+ (copy html images) +/ auto pth_html = spinePathsHTML!()(doc_matters.output_path, doc_matters.src.language); if (!exists(pth_html.image)) { pth_html.image.mkdirRecurse; } foreach (image; doc_matters.srcs.image_list) { auto fn_src_in = doc_matters.src.image_dir_path ~ "/" ~ image; auto fn_src_out = pth_html.image ~ "/" ~ image; debug(images_html) { writeln(fn_src_in, " -> ", fn_src_out); } if (exists(fn_src_in)) { fn_src_in.copy(fn_src_out); } else { if (doc_matters.opt.action.vox_gt0) { writeln("WARNING image not found: ", fn_src_in); } } } 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(format_html_blank_page_guide_home( "../css/html_scroll.css", "https://sisudoc.org", "../index.html", )); } } } #+END_SRC * _epub_ [#B] :epub: |-----------------------+--------------------------+---------------------------+----------------------------------| | function | filename | module | variable | |-----------------------+--------------------------+---------------------------+----------------------------------| | identify doc filetype | mimetype | epub3_mimetypes | mimetypes | |-----------------------+--------------------------+---------------------------+----------------------------------| | identify doc root | META-INF/container.xml | epub3_container_xml | meta_inf_container_xml | |-----------------------+--------------------------+---------------------------+----------------------------------| | doc manifest | OEBPS/content.opf | epub3_oebps_content | oebps_content_opf | |-----------------------+--------------------------+---------------------------+----------------------------------| | doc navigation | OEBPS/toc_nav.xhtml | epub3_oebps_toc_nav_xhtml | oebps_toc_nav_xhtml | | | OEBPS/toc.ncx | epub2_oebps_toc_ncx | oebps_toc_ncx | |-----------------------+--------------------------+---------------------------+----------------------------------| | doc contents | OEBPS/[files ... ].xhtml | outputEPub3 | doc_epub3[seg_filename] | | | | | doc_epub3_endnotes[seg_filename] | |-----------------------+--------------------------+---------------------------+----------------------------------| ** _module template_ :module: #+HEADER: :tangle "../src/doc_reform/io_out/epub3.d" #+HEADER: :noweb yes #+BEGIN_SRC d <> module doc_reform.io_out.epub3; template outputEPub3() { <> mixin InternalMarkup; mixin outputXHTMLs; static auto rgx = RgxO(); static auto rgx_xhtml = RgxXHTML(); <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> <> } #+END_SRC ** special (epub) files :format: *** static **** _identify doc filetype_ (mimetype) [static] - mimetype file indicating that zip file contains an EPUB #+NAME: output_epub3_fixed_mimetypes #+BEGIN_SRC d @safe string epub3_mimetypes() { string o; o = format(q"┃application/epub+zip┃") ~ "\n"; return o; } #+END_SRC **** _identify doc root_ (META-INF/container.xml) [static] rootfile: contains document root path - identifies the root package document (so systems can find it), [unchanged from epub2] #+NAME: output_epub3_fixed_container_xml #+BEGIN_SRC d @safe string epub3_container_xml() { string o; o = format(q"┃┃") ~ "\n"; o ~= format(q"┃ ┃") ~ "\n\n"; return o; } #+END_SRC *** constructs (in dir: OEBPS) **** TODO _doc manifest_ (OEBPS/content.opf) manifest, register content: files, images etc. - manifest, listing all resources - provides the default reading order - identifies the navigation document #+HEADER: :noweb yes #+BEGIN_SRC d #+END_SRC #+NAME: epub3_package_version #+BEGIN_SRC d #+END_SRC #+NAME: output_epub3_constructs_oebps_content #+HEADER: :noweb yes #+BEGIN_SRC d @safe string epub3_oebps_content(D,M,P)(D doc_abstraction, M doc_matters, P parts) { auto xhtml_format = outputXHTMLs(); auto pth_epub3 = spinePathsEPUB!()(doc_matters.output_path, doc_matters.src.language); string _uuid = "18275d951861c77f78acd05672c9906924c59f18a2e0ba06dad95959693e9bd8"; // TODO sort uuid in doc_matters! string content = format(q"┃ <> %s main %s subtitle %s %s %s Copyright: %s %s urn:uuid:%s ┃", _uuid, xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.title_main), (doc_matters.conf_make_meta.meta.title_sub.empty) ? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.title_sub), (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.creator_author), (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.creator_author), doc_matters.src.language, // language, fix (needed in dochead metadata) (doc_matters.conf_make_meta.meta.date_published.empty) ? "" : xhtml_format.special_characters_date(doc_matters.conf_make_meta.meta.date_published), (doc_matters.conf_make_meta.meta.rights_copyright.empty) ? "" : xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.rights_copyright), _uuid, _uuid, (pth_epub3.fn_oebps_css).chompPrefix("OEBPS/"), ); content ~= parts["manifest_documents"]; // TODO sort jpg & png foreach (image; doc_matters.srcs.image_list) { content ~= format(q"┃ ┃", image.baseName.stripExtension, (pth_epub3.doc_oebps_image).chompPrefix("OEBPS/"), image, image.extension.chompPrefix("."), ); } content ~= " " ~ "" ~ "\n "; content ~= " " ~ "" ~ "\n "; content ~= parts["spine"]; content ~= " " ~ "" ~ "\n "; content ~= " " ~ "" ~ "\n "; content ~= parts["guide"]; content ~= " " ~ "" ~ "\n "; content ~= "" ~ ""; debug(epubmanifest) { foreach (section; doc_matters.has.keys_seq.seg) { // TODO foreach (obj; doc_abstraction[section]) { if (obj.metainfo.is_a == "heading") { if (obj.metainfo.heading_lev_markup == 4) { writefln( "%s~ [%s.xhtml] %s", obj.marked_up_level, obj.tags.segment_anchor_tag_epub, obj.text ); } else if (obj.metainfo.heading_lev_markup > 4) { writefln( "%s~ [%s.xhtml#%s] %s", obj.marked_up_level, obj.tags.segment_anchor_tag_epub, obj.metainfo.object_number, obj.text ); } } } } } return content; } #+END_SRC **** _doc navigation epub3_ (OEBPS/toc_nav.xhtml) epub3 navigable toc using Dom structure - toc_nav.xhtml declared as nav file in content.opf (epub3 navigation document) #+NAME: output_epub3_constructs_oebps_toc_nav_xhtml #+BEGIN_SRC d @safe string epub3_oebps_toc_nav_xhtml(D,I)(D doc_abstraction, I doc_matters) { enum DomTags { none, open, close, close_and_open, open_still, } auto markup = InlineMarkup(); static auto rgx = RgxO(); static auto rgx_xhtml = RgxXHTML(); string toc; bool _new_title_set = false; string toc_head = format(q"┃ %s

Contents

\n"; } } } } } } toc ~= _toc_nav_tail; return toc; } #+END_SRC ** the document contents :seg: *** ↻ loop & switch (sections & objects) format epub3 xhtml output #+NAME: output_epub3_xhtml_seg_output #+BEGIN_SRC d @system void outputEPub3(D,I)( const D doc_abstraction, I doc_matters, ) { mixin spineRgxOut; mixin spineRgxXHTML; auto xhtml_format = outputXHTMLs(); static auto rgx = RgxO(); static auto rgx_xhtml = RgxXHTML(); string[] doc; string segment_filename; string[] top_level_headings = ["","","",""]; string[string] oepbs_content_parts; string suffix = ".xhtml"; struct writeOut { /+ epub specific documents +/ /+ fixed output +/ string mimetypes; string meta_inf_container_xml; string oebps_toc_nav_xhtml; /+ variable output +/ string oebps_content_opf; string[][string] doc_epub3; string[][string] doc_epub3_endnotes; string[] doc_parts; } auto epubWrite = writeOut(); #+END_SRC **** ↻ the loop (sections & objects) format output #+NAME: output_epub3_xhtml_seg_output_loop #+BEGIN_SRC d foreach (section; doc_matters.has.keys_seq.seg) { foreach (obj; doc_abstraction[section]) { string _txt = xhtml_format.special_characters_breaks_indents_bullets(obj); #+END_SRC ***** all headings #+NAME: output_epub3_xhtml_seg_object_is_heading #+BEGIN_SRC d if (obj.metainfo.is_a == "heading") { assert(section == "head" || "toc" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.heading_lev_markup) { case 0: .. case 3: /+ fill buffer, and replace with new levels from 1 to 3 +/ switch (obj.metainfo.heading_lev_markup) { case 0: top_level_headings[0] = ""; top_level_headings[1] = ""; top_level_headings[2] = ""; top_level_headings[3] = ""; goto default; case 1: top_level_headings[1] = ""; top_level_headings[2] = ""; top_level_headings[3] = ""; goto default; case 2: top_level_headings[2] = ""; top_level_headings[3] = ""; goto default; case 3: top_level_headings[3] = ""; goto default; default: epubWrite.doc_parts ~= obj.tags.segment_anchor_tag_epub; epubWrite.doc_epub3[obj.tags.segment_anchor_tag_epub] ~= xhtml_format.epub3_seg_head(doc_matters); Tuple!(string, string[]) t = xhtml_format.heading_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[obj.tags.segment_anchor_tag_epub] ~= t[0]; epubWrite.doc_epub3_endnotes[obj.tags.segment_anchor_tag_epub] ~= t[1]; break; } break; case 4: segment_filename = obj.tags.segment_anchor_tag_epub; epubWrite.doc_epub3[segment_filename] ~= xhtml_format.epub3_seg_head(doc_matters); Tuple!(string, string[]) t = xhtml_format.heading_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case 5: .. case 7: Tuple!(string, string[]) t = xhtml_format.heading_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case 8: .. case 9: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); writeln(__FILE__, ":", __LINE__, ": ", obj.text); } } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); } } break; } #+END_SRC ***** non-heading #+NAME: output_epub3_xhtml_seg_object_is_not_heading #+BEGIN_SRC d } else { assert(section == "head" || "toc" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); Tuple!(string, string[]) t; switch (obj.metainfo.is_of_part) { #+END_SRC ****** frontmatter #+NAME: output_epub3_xhtml_seg_object_is_frontmatter #+BEGIN_SRC d case "frontmatter": assert(section == "head" || "toc"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "toc": t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ****** body #+NAME: output_epub3_xhtml_seg_object_is_body #+BEGIN_SRC d case "body": assert(section == "body"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "para": t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; case "block": switch (obj.metainfo.is_a) { case "quote": t = xhtml_format.quote_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0].to!string; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "group": t = xhtml_format.group_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0].to!string; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "block": t = xhtml_format.block_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0].to!string; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "poem": break; case "verse": t = xhtml_format.verse_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0].to!string; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "code": epubWrite.doc_epub3[segment_filename] ~= xhtml_format.code(_txt, obj, doc_matters); break; case "table": epubWrite.doc_epub3[segment_filename] ~= xhtml_format.table(_txt, obj, doc_matters); epubWrite.doc_epub3_endnotes[segment_filename] ~= ""; break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ****** backmatter #+NAME: output_epub3_xhtml_seg_object_is_backmatter #+BEGIN_SRC d case "backmatter": assert(section == "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "endnote": assert(section == "endnotes"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; break; case "glossary": assert(section == "glossary"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "bibliography": assert(section == "bibliography"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "bookindex": assert(section == "bookindex"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "blurb": assert(section == "blurb"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "tail": assert(section == "tail"); t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; epubWrite.doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ****** comment #+NAME: output_epub3_xhtml_seg_object_is_comment_and_close #+BEGIN_SRC d case "comment": break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_part); } } break; } } #+END_SRC ****** heading #+NAME: output_epub3_xhtml_seg_object_is_heading_set #+BEGIN_SRC d if (obj.metainfo.is_a == "heading") { // assert(obj.text.length > 0); // check assertion if (obj.metainfo.heading_lev_markup <= 4) { oepbs_content_parts["manifest_documents"] ~= format(q"┃ ┃", obj.tags.segment_anchor_tag_epub, obj.tags.segment_anchor_tag_epub, ); oepbs_content_parts["spine"] ~= format(q"┃ ┃", obj.tags.segment_anchor_tag_epub, ); oepbs_content_parts["guide"] ~= format(q"┃ ┃", obj.tags.segment_anchor_tag_epub, obj.tags.segment_anchor_tag_epub, ); } else if (obj.metainfo.heading_lev_markup > 4) { oepbs_content_parts["manifest_documents"] ~= format(q"┃ ┃", obj.tags.segment_anchor_tag_epub, obj.metainfo.object_number, obj.tags.segment_anchor_tag_epub, obj.metainfo.object_number, ); oepbs_content_parts["spine"] ~= format(q"┃ ┃", obj.tags.segment_anchor_tag_epub, obj.metainfo.object_number, ); oepbs_content_parts["guide"] ~= format(q"┃ ┃", obj.tags.segment_anchor_tag_epub, obj.metainfo.object_number, obj.tags.segment_anchor_tag_epub, obj.metainfo.object_number, ); } #+END_SRC ***** closings & post loop #+NAME: output_epub3_xhtml_seg_close_ifs_and_write #+BEGIN_SRC d } } } /+ epub specific documents +/ epubWrite.mimetypes = epub3_mimetypes; epubWrite.meta_inf_container_xml = epub3_container_xml; epubWrite.oebps_toc_nav_xhtml = doc_abstraction.epub3_oebps_toc_nav_xhtml(doc_matters); epubWrite.oebps_content_opf = doc_abstraction.epub3_oebps_content(doc_matters, oepbs_content_parts); epubWrite.epub3_write_output_files(doc_matters); } #+END_SRC ** write output files :write:zip: zip -0 file.epub mimetype && zip -r -9 file.epub META-INF OEBPS (mimetypes should be included but should not be zipped) #+NAME: output_epub3_xhtml_seg_write_output_files #+BEGIN_SRC d @system void epub3_write_output_files(W,M)( W epub_write, M doc_matters, ) { debug(asserts) { static assert(is(typeof(epub_write.doc_epub3) == string[][string])); static assert(is(typeof(epub_write.mimetypes) == string)); static assert(is(typeof(epub_write.meta_inf_container_xml) == string)); static assert(is(typeof(epub_write.oebps_toc_nav_xhtml) == string)); static assert(is(typeof(epub_write.oebps_content_opf) == string)); } static auto rgx = RgxO(); static auto rgx_xhtml = RgxXHTML(); auto pth_epub3 = spinePathsEPUB!()(doc_matters.output_path, doc_matters.src.language); auto xhtml_format = outputXHTMLs(); /+ zip file +/ auto fn_epub = pth_epub3.epub_file(doc_matters.src.filename); auto zip = new ZipArchive(); // ZipArchive zip = new ZipArchive(); /+ zip archive member files +/ void EPUBzip()(string contents, string fn) { auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); (doc_matters.opt.action.debug_do_epub) ? zip_data.write(contents.dup) : zip_data.write(contents.dup .replaceAll(rgx.spaces_line_start, "") .replaceAll(rgx.newline, " ") .strip ); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_epub, zip.build()); } try { if (!exists(pth_epub3.base)) { 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(format_html_blank_page_guide_home( "../../css/html_scroll.css", "https://sisudoc.org", "../../index.html", )); } { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { if (!exists(pth_epub3.dbg_doc_meta_inf(doc_matters.src.filename))) { pth_epub3.dbg_doc_meta_inf(doc_matters.src.filename).mkdirRecurse; } if (!exists(pth_epub3.dbg_doc_oebps_css(doc_matters.src.filename))) { pth_epub3.dbg_doc_oebps_css(doc_matters.src.filename).mkdirRecurse; } if (!exists(pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename))) { pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename).mkdirRecurse; } } } { /+ OEBPS/[segments].xhtml (the document contents) +/ foreach (seg_filename; doc_matters.has.segnames_lv_0_to_4) { string fn = pth_epub3.fn_oebps_content_xhtml(seg_filename); auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { string fn_dbg = pth_epub3.dbg_fn_oebps_content_xhtml(doc_matters.src.filename, seg_filename); auto f = File(fn_dbg, "w"); foreach (docseg; epub_write.doc_epub3[seg_filename]) { f.writeln(docseg); } foreach (docseg; epub_write.doc_epub3_endnotes[seg_filename]) { f.writeln(docseg); } f.writeln(xhtml_format.tail(doc_matters)); } } foreach (docseg; epub_write.doc_epub3[seg_filename]) { zip_data.write(docseg.dup); } foreach (docseg; epub_write.doc_epub3_endnotes[seg_filename]) { zip_data.write(docseg.dup); } zip_data.write(xhtml_format.tail(doc_matters).dup); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); /+ create the zip file +/ createZipFile!()(fn_epub, zip.build()); } } string fn; string fn_dbg; File f; { /+ mimetypes (identify zip file type) +/ { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { fn_dbg = pth_epub3.dbg_fn_mimetypes(doc_matters.src.filename); File(fn_dbg, "w").writeln(epub_write.mimetypes); } } fn = pth_epub3.fn_mimetypes; EPUBzip(epub_write.mimetypes, fn); } { /+ META-INF/container.xml (identify doc root) +/ { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { fn_dbg = pth_epub3.dbg_fn_dmi_container_xml(doc_matters.src.filename); File(fn_dbg, "w").writeln(epub_write.meta_inf_container_xml); } } fn = pth_epub3.fn_dmi_container_xml; EPUBzip(epub_write.meta_inf_container_xml, fn); } { /+ OEBPS/toc_nav.xhtml (navigation toc epub3) +/ { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { fn_dbg = pth_epub3.dbg_fn_oebps_toc_nav_xhtml(doc_matters.src.filename); File(fn_dbg, "w").writeln(epub_write.oebps_toc_nav_xhtml); } } fn = pth_epub3.fn_oebps_toc_nav_xhtml; EPUBzip(epub_write.oebps_toc_nav_xhtml, fn); } { /+ OEBPS/content.opf (doc manifest) +/ { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { fn_dbg = pth_epub3.dbg_fn_oebps_content_opf(doc_matters.src.filename); File(fn_dbg, "w").writeln(epub_write.oebps_content_opf); } } fn = pth_epub3.fn_oebps_content_opf; EPUBzip(epub_write.oebps_content_opf, fn); } { /+ OEBPS/_dr/image (images) +/ foreach (image; doc_matters.srcs.image_list) { { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { if (doc_matters.opt.action.vox_gt2) { writeln( doc_matters.src.image_dir_path, "/", image, " -> ", pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename), "/", image ); } if (exists(doc_matters.src.image_dir_path ~ "/" ~ image)) { (doc_matters.src.image_dir_path ~ "/" ~ image) .copy((pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename)) ~ "/" ~ image); } } } auto fn_src = doc_matters.src.image_dir_path ~ "/" ~ image; auto fn_out = pth_epub3.doc_oebps_image ~ "/" ~ image; if (exists(fn_src)) { { auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn_out; auto zip_data = new OutBuffer(); zip_data.write(cast(char[]) ((fn_src).read)); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_epub, zip.build()); } } } } { /+ OEBPS/epub.css +/ auto css = spineCss(doc_matters); { /+ debug +/ if (doc_matters.opt.action.debug_do_epub) { fn_dbg = pth_epub3.dbg_fn_oebps_css(doc_matters.src.filename); File(fn_dbg, "w").writeln(css.epub); } } fn = pth_epub3.fn_oebps_css; auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); zip_data.write(css.epub.dup); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_epub, zip.build()); } } catch (ErrnoException ex) { // Handle error } if (doc_matters.opt.action.vox_gt0) { writeln(" ", fn_epub); } #+END_SRC ** zip debug, read zip archive :zip: #+NAME: output_epub3_xhtml_seg_debug_extract_zip_dir #+BEGIN_SRC d debug(epub_archive) { if (exists(fn_epub)) { try { auto zipped = new ZipArchive((fn_epub).read); foreach (filename, member; zipped.directory) { auto data = zipped.expand(member); writeln(filename, " length ", data.length); } } catch (ZipException ex) { // Handle errors } } } } #+END_SRC * document header including copyright & license #+NAME: doc_header_including_copyright_and_license #+BEGIN_SRC txt /+ - Name: Spine, Doc Reform [a part of] - Description: documents, structuring, processing, publishing, search - static content generator - Author: Ralph Amissah [ralph.amissah@gmail.com] - Copyright: (C) 2015 - 2023 Ralph Amissah, All Rights Reserved. - License: AGPL 3 or later: Spine (SiSU), a framework for document structuring, publishing and search Copyright (C) Ralph Amissah This program is free software: you can redistribute it and/or modify it under the terms of the GNU AFERO General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see [https://www.gnu.org/licenses/]. If you have Internet connection, the latest version of the AGPL should be available at these locations: [https://www.fsf.org/licensing/licenses/agpl.html] [https://www.gnu.org/licenses/agpl.html] - Spine (by Doc Reform, related to SiSU) uses standard: - docReform markup syntax - standard SiSU markup syntax with modified headers and minor modifications - docReform object numbering - standard SiSU object citation numbering & system - Homepages: [https://www.doc_reform.org] [https://www.sisudoc.org] - Git [https://git.sisudoc.org/projects/?p=software/spine.git;a=summary] +/ #+END_SRC * __END__