-*- 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 - 2020 Ralph Amissah #+LANGUAGE: en #+STARTUP: content hideblocks hidestars noindent entitiespretty #+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t #+PROPERTY: header-args :exports code #+PROPERTY: header-args+ :noweb yes #+PROPERTY: header-args+ :eval no #+PROPERTY: header-args+ :results no #+PROPERTY: header-args+ :cache no #+PROPERTY: header-args+ :padline no - [[./spine.org][spine]] [[./][org/]] - [[./output_hub.org][output_hub]] * xml offspring (xhtml html epub) ** format xhtml objects :format: *** _module template_ :module: #+BEGIN_SRC d :tangle "../src/doc_reform/io_out/xmls.d" module doc_reform.io_out.xmls; template outputXHTMLs() { <<output_imports_xml>> mixin spineRgxOut; struct outputXHTMLs { static auto rgx = RgxO(); <<xhtml_format_objects_0>> <<xhtml_format_objects_1>> <<xhtml_format_objects_2>> <<xhtml_format_objects_3>> <<xhtml_format_objects_4>> <<xhtml_format_objects_5>> <<xhtml_format_objects_6>> <<xhtml_format_objects_7>> <<xhtml_format_objects_8>> <<xhtml_format_objects_9>> <<xhtml_format_objects_10>> <<xhtml_format_objects_11>> <<xhtml_format_objects_12>> <<xhtml_format_objects_13>> <<xhtml_format_objects_14>> <<xhtml_format_objects_15>> <<xhtml_format_objects_16>> <<xhtml_format_objects_17>> <<xhtml_format_objects_18>> <<xhtml_format_objects_19>> <<xhtml_format_objects_20>> <<xhtml_format_objects_21>> <<xhtml_format_objects_22>> <<xhtml_format_objects_23>> <<xhtml_format_objects_24>> <<xhtml_format_objects_25>> <<xhtml_format_objects_26>> <<xhtml_format_objects_27>> <<xhtml_format_objects_28>> <<xhtml_format_objects_29>> <<xhtml_format_objects_30>> <<xhtml_format_objects_31>> <<xhtml_format_objects_32>> <<xhtml_format_objects_33>> <<xhtml_format_objects_34>> <<xhtml_format_objects_35>> <<xhtml_format_objects_36>> <<xhtml_format_objects_37>> <<xhtml_format_objects_38>> <<xhtml_format_objects_code>> } } #+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.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.create_zip_file, doc_reform.io_out.xmls, doc_reform.io_out.xmls_css; #+END_SRC *** misc **** div delimiter #+NAME: xhtml_format_objects_0 #+BEGIN_SRC d @safe string div_delimit( string part, return ref string previous_part ) { string delimit = ""; string delimit_ = ""; if (part != previous_part) { switch (part) { case "head": delimit_ ~= "\n<div class=\"doc_title\">\n" ; break; case "toc": delimit_ ~= "\n<div class=\"doc_toc\">\n" ; break; case "bookindex": delimit_ ~= "\n<div class=\"doc_bookindex\">\n" ; break; default: delimit_ ~= "\n<div class=\"doc_" ~ part ~ "\">\n" ; break; } if (previous_part.length > 0) { delimit ~= "\n</div>"; } previous_part = part; delimit ~= delimit_; } // you also need to close the last div, introduce a footer? return delimit; } #+END_SRC **** special characters text #+NAME: xhtml_format_objects_1 #+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.nbsp_char, " "); return _txt; } #+END_SRC **** special characters #+NAME: xhtml_format_objects_2 #+BEGIN_SRC d @safe string special_characters(O)( const O obj, ) { string _txt = special_characters_text(obj.text); if (!(obj.metainfo.is_a == "code")) { _txt = (_txt) .replaceAll(rgx.xhtml_line_break, "<br />"); } return _txt; } #+END_SRC **** font_face #+NAME: xhtml_format_objects_3 #+BEGIN_SRC d @safe string font_face(string _txt) { _txt = _txt .replaceAll(rgx.inline_emphasis, ("<em>$1</em>")) .replaceAll(rgx.inline_bold, ("<b>$1</b>")) .replaceAll(rgx.inline_underscore, ("<u>$1</u>")) .replaceAll(rgx.inline_italics, ("<i>$1</i>")) .replaceAll(rgx.inline_superscript, ("<sup>$1</sup>")) .replaceAll(rgx.inline_subscript, ("<sub>$1</sub>")) .replaceAll(rgx.inline_strike, ("<del>$1</del>")) .replaceAll(rgx.inline_insert, ("<ins>$1</ins>")) .replaceAll(rgx.inline_mono, ("<tt>$1</tt>")) .replaceAll(rgx.inline_cite, ("<cite>$1</cite>")); return _txt; } #+END_SRC **** anchor tags #+NAME: xhtml_format_objects_4 #+BEGIN_SRC d @safe string _xhtml_anchor_tags(O)(O obj) { const(string[]) anchor_tags = obj.tags.anchor_tags; string tags=""; if (anchor_tags.length > 0) { foreach (tag; anchor_tags) { if (!(tag.empty)) { tags ~= "<a name=\"" ~ tag ~ "\"></a>"; } } } return tags; } #+END_SRC **** doc head & tails ***** metadata #+NAME: xhtml_format_objects_5 #+BEGIN_SRC d @safe string header_metadata(M)( M doc_matters, ) { string _publisher="Publisher"; // TODO string o; o = format(q"┃<!-- spine DocReform header metadata --> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="dc.title" content="%s" /> <meta name="dc.author" content="%s" /> <meta name="dc.publisher" content="%s" /> <meta name="dc.date" content="%s" /> <meta name="dc.date.created" content="%s" /> <meta name="dc.date.issued" content="%syear" /> <meta name="dc.date.available" content="%syear" /> <meta name="dc.date.valid" content="%syear" /> <meta name="dc.date.modified" content="%syear" /> <meta name="dc.language" content="%s" /> <meta name="dc.rights" content="%s" /> <meta name="generator" content="%s" /> <link rel="generator" href="%s" /> <!-- spine DocReform header metadata -->┃", doc_matters.conf_make_meta.meta.title_full.replaceAll(regex("\""), """), doc_matters.conf_make_meta.meta.creator_author, _publisher, doc_matters.conf_make_meta.meta.date_published, doc_matters.conf_make_meta.meta.date_created, doc_matters.conf_make_meta.meta.date_issued, doc_matters.conf_make_meta.meta.date_available, doc_matters.conf_make_meta.meta.date_valid, doc_matters.conf_make_meta.meta.date_modified, doc_matters.src.language, doc_matters.conf_make_meta.meta.rights_copyright, doc_matters.opt.action.debug_do ? "" : doc_matters.generator_program.name_and_version, doc_matters.generator_program.url_home, ); return o; } #+END_SRC ***** site info button #+NAME: xhtml_format_objects_6 #+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, ("<p class=\"tiny_left\"><a href=\"$2\">$1</a></p>")) .replaceAll( rgx.br_line, "") .replaceAll( rgx.br_nl, ""); } else { _locations = "<p class=\"tiny_left\"><a href=\"http://www.doc-reform.org\">spine</a></p>\n<p class=\"tiny_left\"><a href=\"http://git.sisudoc.org/software/spine/\">sources / git</a></p>\n<p class=\"tiny_left\"><a href=\"http://www.sisudoc.org\">www.sisudoc.org</a></p>"; } string o; o = format(q"┃<div class="flex-menu-option"> %s </div>┃", _locations, ); return o; } #+END_SRC ***** search form #+NAME: xhtml_format_objects_7 #+BEGIN_SRC d @safe string inline_search_form(M)( M doc_matters, ) { string o; string _form; if (doc_matters.opt.action.html_search_link) { o = format(q"┃ <div class="flex-menu-option"> <!-- SiSU Spine Search --> <form action="%s" target="_top" method="POST" accept-charset="UTF-8" id="search"> <font size="2"> <input type="text" name="sf" size="24" maxlength="255">%s <input type="hidden" name="sml" value="1000"> <input type="hidden" name="ec" value="on"> <input type="hidden" name="url" value="on"> <button type="submit" form="search" name="fn" value="%s">doc</button> <button type="submit" form="search">db</button> </font></form> <!-- SiSU Spine Search --> </div>┃", doc_matters.conf_make_meta.conf.w_srv_cgi_action, (doc_matters.conf_make_meta.conf.w_srv_db_sqlite.empty) ? "" : "\n <input type=\"hidden\" name=\"db\" value=\"" ~ doc_matters.conf_make_meta.conf.w_srv_db_sqlite ~ "\">", doc_matters.src.filename_base, ); } else { o = ""; } return o; } #+END_SRC ***** html head & head banner #+NAME: xhtml_format_objects_8 #+BEGIN_SRC d @safe string html_head(M)( M doc_matters, string type, ) { string o; string metadata_links = ((doc_matters.opt.action.html_harvest_link) ? format(q"┃<p class="tiny">[<a href="%smetadata.%s.html"> m </a>|<a href="%s../../authors.html"> A </a>|<a href="%s../../topics.html"> T </a>]</p>┃", (type == "seg") ? "../" : "", doc_matters.src.filename_base, (type == "seg") ? "../" : "", (type == "seg") ? "../" : "", ) : ""); o = format(q"┃<!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/plain; charset=UTF-8" /> <title> %s%s </title> <!-- metadata --> %s <!-- metadata --> <link rel="generator" href="http://www.sisudoc.org/" /> <link rel="shortcut icon" href="%s../../image/dr.ico" /> <link href="%s" rel="stylesheet" /> </head> <body lang="%s"> <a name="top" id="top"></a> <div class='delimit headband'> <div class="flex-menu-bar"> %s <div class="flex-menu-option"> %s </div>%s%s┃", doc_matters.conf_make_meta.meta.title_full, (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : ", " ~ 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), (type == "seg") ? "" : "\n</div>", ); return o; } #+END_SRC ***** epub seg head #+NAME: xhtml_format_objects_9 #+BEGIN_SRC d @safe string epub3_seg_head(M)( M doc_matters, ) { string html_base = format(q"┃<!DOCTYPE html> <html>┃", ); string html_simple = format(q"┃<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" lang="%s" xml:lang="%s">┃", doc_matters.src.language, doc_matters.src.language, ); string html_strict = format(q"┃<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" lang="%s" xml:lang="%s">┃", doc_matters.src.language, doc_matters.src.language, ); string o; o = format(q"┃%s <head> <title> %s%s </title> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta name="dc.title" content="%s" /> <meta name="dc.author" content="%s" /> <meta name="dc.publisher" content="FIX" /> <meta name="dc.date" content="%s" /> <meta name="dc.date.created" content="%s" /> <meta name="dc.date.issued" content="%s" /> <meta name="dc.date.available" content="%s" /> <meta name="dc.date.valid" content="%s" /> <meta name="dc.date.modified" content="%s" /> <meta name="dc.language" content="%s" /> <meta name="dc.rights" content="%s" /> <meta name="generator" content="%s" /> <link rel="generator" href="%s" /> <link rel="shortcut icon" href="../_dr/image/dr.ico" /> <link rel="stylesheet" href="css/epub.css" type="text/css" id="main-css" /> </head> <body lang="%s"> <a name="top" id="top"></a>┃", html_simple, doc_matters.conf_make_meta.meta.title_full.replaceAll(regex("\""), """), (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : ", " ~ doc_matters.conf_make_meta.meta.creator_author, doc_matters.conf_make_meta.meta.title_full, (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : ", " ~ doc_matters.conf_make_meta.meta.creator_author, doc_matters.conf_make_meta.meta.date_published, doc_matters.conf_make_meta.meta.date_created, doc_matters.conf_make_meta.meta.date_issued, doc_matters.conf_make_meta.meta.date_available, doc_matters.conf_make_meta.meta.date_valid, doc_matters.conf_make_meta.meta.date_modified, doc_matters.src.language, doc_matters.conf_make_meta.meta.rights_copyright, doc_matters.generator_program.name_and_version, doc_matters.generator_program.url_home, doc_matters.src.language, ); return o; } #+END_SRC ***** xhtml tail #+NAME: xhtml_format_objects_10 #+BEGIN_SRC d @safe string tail() { string o; o = format(q"┃ <a name="bottom" id="bottom"></a> <a name="end" id="end"></a> </body> </html>┃"); return o; } #+END_SRC *** inline markup **** images #+NAME: xhtml_format_objects_11 #+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<img src=\"" ~ _img_pth ~ "$3\" width=\"$4\" height=\"$5\" naturalsizeflag=\"0\" align=\"bottom\" border=\"0\" /> $6")) .replaceAll( rgx.inline_link_empty, ("$1")); } return _txt; } #+END_SRC **** links ***** scroll, seg, epub #+NAME: xhtml_format_objects_12 #+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_lv1_to_4" : "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.quiet)) { 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, ("<a href=\"$2\">$1</a>")) .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_13 #+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, ("<a href=\"#note_$1\"><note id=\"noteref_$1\"> <sup>$1</sup> </note></a>") ); } if (obj.has.inline_notes_star) { _txt = font_face(_txt); _txt = _txt.replaceAll( rgx.inline_notes_al_special_char_note, ("<a href=\"#note_$1\"><note id=\"noteref_$1\"> <sup>$1</sup> </note></a>") ); } 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_14 #+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", "<p class=\"endnote\">", "<a href=\"#noteref_", m.captures[1], "\">", "<note id=\"note_", m.captures[1], "\"> <sup>", m.captures[1], ".</sup></note></a>", m.captures[2], "</p>" ); } _txt = _txt.replaceAll( rgx.inline_notes_al_special_char_note, ("<a href=\"#note_$1\"><note id=\"noteref_$1\"> <sup>$1</sup> </note></a>") ); } 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", "<p class=\"endnote\">", "<a href=\"#noteref_", m.captures[1], "\">", "<note id=\"note_", m.captures[1], "\"> <sup>", m.captures[1], ".</sup></note></a>", m.captures[2], "</p>" ); } _txt = _txt.replaceAll( rgx.inline_notes_al_regular_number_note, ("<a href=\"#note_$1\"><note id=\"noteref_$1\"> <sup>$1</sup> </note></a>") ); } 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_15 #+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_16 #+BEGIN_SRC d @safe auto 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_17 #+BEGIN_SRC d @safe string lev4_heading_subtoc(O,M)( const O obj, M doc_matters, ) { char[] lev4_subtoc; lev4_subtoc ~= " <div class=\"nav\">\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"┃ <p class="minitoc" indent="h%si%s"> ۰ <a href="%s">%s</a> </p> ┃", indent, indent, link, text, )); } } lev4_subtoc ~= " </div>\n"; return lev4_subtoc.to!string; } #+END_SRC **** navigation pre next svg #+NAME: xhtml_format_objects_18 #+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"┃<a href="toc.html" target="_top"> <div class="toc-button menu"> <svg viewbox="0 0 100 100"> <path d="M4,10h24c1.104,0,2-0.896,2-2s-0.896-2-2-2H4C2.896,6,2,6.896,2,8S2.896,10,4,10z M28,14H4c-1.104,0-2,0.896-2,2 s0.896,2,2,2h24c1.104,0,2-0.896,2-2S29.104,14,28,14z M28,22H4c-1.104,0-2,0.896-2,2s0.896,2,2,2h24c1.104,0,2-0.896,2-2 S29.104,22,28,22z" /> </svg> </div> </a>┃", ); } if (obj.tags.segname_prev == "") { prev = ""; } else { prev = format(q"┃<a href="%s.html" target="_top"> <div class="prev-next-button previous"> <svg viewbox="0 0 100 100"> <path class="arrow" d="M 50,0 L 60,10 L 20,50 L 60,90 L 50,100 L 0,50 Z" transform=" translate(15,0)" /> </svg> </div> </a>┃", obj.tags.segname_prev, ); } if (obj.tags.segname_next == "") { next = ""; } else { next = format(q"┃<a href="%s.html" target="_top"> <div class="prev-next-button next"> <svg viewbox="0 0 100 100"> <path class="arrow" d="M 50,0 L 60,10 L 20,50 L 60,90 L 50,100 L 0,50 Z" transform="translate(85,100) rotate(180)" /> </svg> </div> </a>┃", obj.tags.segname_next, ); } string _toc_pre_next = format(q"┃ <div class="nav-bar"> %s %s %s </div> </div> </div>┃", toc, prev, next, ); string _pre_next = format(q"┃ <div class="nav-bar"> %s %s </div> </div> </div>┃", 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_19 #+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 = "<hr />"; 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) ? "" : "<a name=\"" ~ obj.tags.heading_lev_anchor_tag ~ "\"></a>"; if (_txt.empty) { o = format(q"┃%s ┃", _horizontal_rule, ); } else if (!(obj.metainfo.identifier.empty)) { o = format(q"┃%s <div class="substance"> <label class="ocn"><a href="#%s" class="lnkocn">%s</a></label> <h%s class="%s" id="%s"><a name="%s"></a>%s%s %s </h%s> </div>┃", _horizontal_rule, obj.metainfo.identifier, (doc_matters.opt.action.ocn_off) ? "" : ((obj.metainfo.object_number.empty) ? "" : obj.metainfo.identifier), obj.metainfo.heading_lev_markup, obj.metainfo.is_a, obj.metainfo.identifier, obj.metainfo.identifier, tags, heading_lev_anchor_tag, _txt, obj.metainfo.heading_lev_markup, ); } else { o = format(q"┃%s <div class="substance"> <h%s class="%s">%s%s %s </h%s> </div>┃", _horizontal_rule, obj.metainfo.heading_lev_markup, obj.metainfo.is_a, tags, heading_lev_anchor_tag, _txt, obj.metainfo.heading_lev_markup, ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_20 #+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_21 #+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", ) { auto 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_22 #+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, "<a name=\"$1\"></a>"); if (!(obj.metainfo.identifier.empty)) { o = format(q"┃ <div class="substance"> <label class="ocn"><a href="#%s" class="lnkocn">%s</a></label> <p class="%s" indent="h%si%s" id="%s">%s %s </p> </div>┃", 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"┃ <div class="substance"> <p class="%s" indent="h%si%s">%s %s </p> </div>┃", obj.metainfo.is_a, obj.attrib.indent_hang, obj.attrib.indent_base, tags, _txt ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_23 #+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_24 #+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", ) { auto 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_25 #+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"┃ <div class="substance"> <label class="ocn"><a href="#%s" class="lnkocn">%s</a></label> <p class="%s" id="%s"> %s </p> </div>┃", 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"┃ <div class="substance"> <p class="%s"> %s </p> </div>┃", obj.metainfo.is_a, _txt ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_26 #+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_27 #+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", ) { auto 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_28 #+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"┃ <div class="substance"> <label class="ocn"><a href="#%s" class="lnkocn">%s</a></label> <p class="%s" id="%s"> %s </p> </div>┃", 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"┃ <div class="substance"> <p class="%s"> %s </p> </div>┃", obj.metainfo.is_a, _txt ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_29 #+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_30 #+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", ) { auto 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_31 #+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"┃ <div class="substance"> <label class="ocn"><a href="#%s" class="lnkocn">%s</a></label> <p class="%s" id="%s">%s</p> </div>┃", 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"┃ <div class="substance"> <p class="%s">%s</p> </div>┃", obj.metainfo.is_a, _txt.stripRight ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_32 #+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_33 #+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", ) { auto 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_34 #+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"┃ <div class="substance"> <label class="ocn"><a href="#%s" class="lnkocn">%s</a></label> <p class="%s" id="%s">%s</p> </div>┃", 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"┃ <div class="substance"> <p class="%s">%s</p> </div>┃", obj.metainfo.is_a, _txt ); } return o; } #+END_SRC **** scroll #+NAME: xhtml_format_objects_35 #+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_36 #+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", ) { auto 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_newlines_linebreaks); _codelines = " <pre class=\"codeline\">\n"; foreach (k, _line; _block_lines) { if (k == 1) { _codelines ~= format(q"┃ <span class="tr first-row"><span class="th"></span><codeline>%s</codeline></span> ┃", _line, ); } else { _codelines ~= format(q"┃ <span class="tr"><span class="th"></span><codeline>%s</codeline></span> ┃", _line, ); } } _codelines ~= " </pre>"; } else { _codelines = " <pre class=\"codeline\">\n"; _codelines ~= _txt; _codelines ~= " </pre>"; } return _codelines; } if (!(obj.metainfo.identifier.empty)) { o = format(q"┃ <div class="substance"> <label class="ocn"><a href="#%s" class="lnkocn">%s</a></label> <p class="%s" id="%s">%s</p> </div>┃", 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"┃ <div class="substance"> <p class="%s">%s</p> </div>┃", obj.metainfo.is_a, codelines(_txt) ); } return o; } #+END_SRC *** table **** TODO tablarize align="left|right|center" <td align="right">$100</td> "style=\"text-align:right\"" "style=\"text-align:left\"" "style=\"text-align:" ~ "right\"" #+NAME: xhtml_format_objects_37 #+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 ~= "<tr>"; 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 ~= "</" ~ _col_is ~ ">"; } } _table ~= "</tr>"; } Tuple!(string, string) t = tuple( _table, _tablenote, ); return t; } #+END_SRC **** table #+NAME: xhtml_format_objects_38 #+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"┃ <div class="substance"> <label class="ocn"><a href="#%s" class="lnkocn">%s</a></label> <p class="%s" id="%s">%s <table summary="normal text css" width="95%%" border="0" cellpadding="2" align="center"> %s </table> %s </p> </div>┃", 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: #+BEGIN_SRC d :tangle "../src/doc_reform/io_out/html.d" module doc_reform.io_out.html; template outputHTML() { <<output_imports_xml>> mixin outputXHTMLs; <<output_html_scroll_0>> <<output_html_scroll_1>> <<output_html_scroll_2>> <<output_html_scroll_3>> <<output_html_scroll_4>> <<output_html_scroll_5>> <<output_html_scroll_6>> <<output_html_seg_0>> <<output_html_seg_1>> <<output_html_seg_2>> <<output_html_seg_3>> <<output_html_seg_4>> <<output_html_seg_5>> <<output_html_seg_6>> <<output_html_seg_7>> <<output_html_seg_8>> <<output_html_css>> <<copy_html_images>> } #+END_SRC ** scroll :scroll: *** ↻ loop & switch (sections & objects) format html output #+NAME: output_html_scroll_0 #+BEGIN_SRC d @safe void scroll(D,M)( const D doc_abstraction, M doc_matters, ) { mixin spineRgxOut; auto xhtml_format = outputXHTMLs(); static auto rgx = RgxO(); string[] doc_html; string[] doc; string suffix = ".html"; string previous_part = ""; string delimit = ""; #+END_SRC **** ↻ the loops & outer switch (sections & objects) format output #+NAME: output_html_scroll_1 #+BEGIN_SRC d foreach (part; doc_matters.has.keys_seq.scroll) { foreach (obj; doc_abstraction[part]) { delimit = xhtml_format.div_delimit(part, previous_part); string _txt = xhtml_format.special_characters(obj); switch (obj.metainfo.is_of_part) { #+END_SRC ***** frontmatter #+NAME: output_html_scroll_2 #+BEGIN_SRC d case "frontmatter": assert(part == "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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ***** body #+NAME: output_html_scroll_3 #+BEGIN_SRC d case "body": assert(part == "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 && doc_matters.opt.action.verbose) { 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ***** backmatter #+NAME: output_html_scroll_4 #+BEGIN_SRC d case "backmatter": assert(part == "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(part == "endnotes"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "glossary": assert(part == "glossary"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "bibliography": assert(part == "bibliography"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "bookindex": assert(part == "bookindex"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; case "blurb": assert(part == "blurb"); doc_html ~= xhtml_format.para_scroll(_txt, obj, doc_matters, suffix); break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; case "comment": break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { 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_5 #+BEGIN_SRC d } } } doc = xhtml_format.html_head(doc_matters, "scroll") ~ doc_html ~ xhtml_format.tail; scroll_write_output(doc, doc_matters); } #+END_SRC *** write output file #+NAME: output_html_scroll_6 #+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); } } catch (ErrnoException ex) { // Handle error } if (!(doc_matters.opt.action.quiet)) { 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 @safe void seg(D,M)( const D doc_abstraction, M doc_matters, ) { mixin spineRgxOut; static auto rgx = RgxO(); 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_part = ""; string delimit = ""; #+END_SRC **** ↻ the loop (sections & objects) format output #+NAME: output_html_seg_1 #+BEGIN_SRC d foreach (part; doc_matters.has.keys_seq.seg) { foreach (obj; doc_abstraction[part]) { delimit = xhtml_format.div_delimit(part, previous_part); string _txt = xhtml_format.special_characters(obj); #+END_SRC ***** all headings #+NAME: output_html_seg_2 #+BEGIN_SRC d if (obj.metainfo.is_a == "heading") { assert(part == "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: auto 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; } auto 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: auto 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 && doc_matters.opt.action.verbose) { 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); } } break; } #+END_SRC ***** non-heading #+NAME: output_html_seg_3 #+BEGIN_SRC d } else { assert(part == "head" || "toc" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.is_of_part) { #+END_SRC ****** frontmatter #+NAME: output_html_seg_4 #+BEGIN_SRC d case "frontmatter": assert(part == "head" || "toc"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "toc": auto 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; #+END_SRC ****** body #+NAME: output_html_seg_5 #+BEGIN_SRC d case "body": assert(part == "body"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "para": auto 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; case "block": switch (obj.metainfo.is_a) { case "quote": auto t = xhtml_format.quote_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; break; case "group": auto t = xhtml_format.group_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; break; case "block": auto t = xhtml_format.block_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; break; case "poem": break; case "verse": auto t = xhtml_format.verse_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; break; 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: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ****** backmatter #+NAME: output_html_seg_6 #+BEGIN_SRC d case "backmatter": assert(part == "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "endnote": assert(part == "endnotes"); auto t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "seg"); doc_html[segment_filename] ~= t[0]; break; case "glossary": assert(part == "glossary"); auto 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(part == "bibliography"); auto 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(part == "bookindex"); auto 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(part == "blurb"); auto 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; case "comment": break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_part); } } break; } #+END_SRC ***** closings & post loop #+NAME: output_html_seg_7 #+BEGIN_SRC d } } } seg_write_output(doc_html, doc_html_endnotes, doc_matters); } #+END_SRC *** write output files #+NAME: output_html_seg_8 #+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 spineRgxOut; static auto rgx = RgxO(); auto pth_html = spinePathsHTML!()(doc_matters.output_path, doc_matters.src.language); auto xhtml_format = outputXHTMLs(); auto m = doc_matters.src.filename.matchFirst(rgx.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); } } catch (ErrnoException ex) { // handle error } if (!(doc_matters.opt.action.quiet)) { 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); } 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.quiet)) { writeln("WARNING image not found: ", fn_src_in); } } } } } #+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: #+BEGIN_SRC d :tangle "../src/doc_reform/io_out/epub3.d" module doc_reform.io_out.epub3; template outputEPub3() { <<output_imports_epub>> mixin InternalMarkup; mixin outputXHTMLs; <<output_epub3_fixed_0>> <<output_epub3_fixed_1>> <<output_epub3_constructs_0>> <<output_epub3_constructs_1>> <<output_epub3_constructs_2>> <<output_epub3_xhtml>> <<output_epub3_xhtml_seg_0>> <<output_epub3_xhtml_seg_1>> <<output_epub3_xhtml_seg_2>> <<output_epub3_xhtml_seg_3>> <<output_epub3_xhtml_seg_4>> <<output_epub3_xhtml_seg_5>> <<output_epub3_xhtml_seg_6>> <<output_epub3_xhtml_seg_7>> <<output_epub3_xhtml_seg_8>> <<output_epub3_xhtml_seg_9>> <<output_epub3_css>> } #+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_0 #+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_1 #+BEGIN_SRC d @safe string epub3_container_xml() { string o; o = format(q"┃<?xml version='1.0' encoding='utf-8'?>┃") ~ "\n"; o ~= format(q"┃<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container"> <rootfiles> <rootfile full-path="OEBPS/content.opf" media-type="application/oebps-package+xml" /> </rootfiles>┃") ~ "\n</container>\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 #+NAME: output_epub3_constructs_0 #+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"┃ <?xml version='1.0' encoding='utf-8'?> <package xmlns="http://www.idpf.org/2007/opf" version="2.0" unique-identifier="EPB-UUID"> <metadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:dc="http://purl.org/dc/elements/1.1/" unique-identifier="urn:uuid:%s" version="2.0"> <!-- <dc:title id="title">%s</dc:title> --> <dc:title id="title">%s</dc:title> <meta refines="#title" property="title-type">main</meta> <dc:title id="subtitle">%s</dc:title> <meta refines="#subtitle" property="title-type">subtitle</meta> <dc:creator file-as="%s" id="aut">%s</dc:creator> <dc:language>%s</dc:language> <dc:date id="published">%s</dc:date> <dc:rights>Copyright: %s</dc:rights> <dc:identifier scheme="URI">%s</dc:identifier> <dc:identifier id="bookid">urn:uuid:%s</dc:identifier> <!-- <dc:identifier id="EPB-UUID">urn:uuid:%s</dc:identifier> --> </metadata> <manifest> <!-- NCX epub2 navigation --> <item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml" /> <!-- CSS Style Sheets --> <link rel="stylesheet" href="%s" type="text/css" id="main-css" /> <!-- nav epub3 navigation --> <item id="nav" href="toc_nav.xhtml" media-type="application/xhtml+xml" properties="nav" /> ┃", _uuid, xhtml_format.special_characters_text(doc_matters.conf_make_meta.meta.title_full), 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_text(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, _uuid, (pth_epub3.fn_oebps_css).chompPrefix("OEBPS/"), ); content ~= " " ~ "<!-- Content Documents -->" ~ "\n "; content ~= parts["manifest_documents"]; // TODO sort jpg & png content ~= " " ~ "<!-- Images -->" ~ "\n "; foreach (image; doc_matters.srcs.image_list) { content ~= format(q"┃ <item id="%s" href="%s/%s" media-type="image/%s" /> ┃", image.baseName.stripExtension, (pth_epub3.doc_oebps_image).chompPrefix("OEBPS/"), image, image.extension.chompPrefix("."), ); } content ~= " " ~ "</manifest>" ~ "\n "; content ~= " " ~ "<spine toc=\"ncx\">" ~ "\n "; content ~= parts["spine"]; content ~= " " ~ "</spine>" ~ "\n "; content ~= " " ~ "<guide>" ~ "\n "; content ~= parts["guide"]; content ~= " " ~ "</guide>" ~ "\n "; content ~= "" ~ "</package>"; debug(epubmanifest) { foreach (part; doc_matters.has.keys_seq.seg) { // TODO foreach (obj; doc_abstraction[part]) { 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_1 #+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(); string toc =format("<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:epub=\"http://www.idpf.org/2007/ops\"> <head> <title>%s</title> </head> <body> <section epub:type=\"frontmatter toc\"> <header> <h1>Contents</h1> </header> <nav epub:type=\"toc\" id=\"toc\">\n", doc_matters.conf_make_meta.meta.title_full, ); foreach (sect; doc_matters.has.keys_seq.seg) { foreach (obj; doc_abstraction[sect]) { if (obj.metainfo.is_a == "heading") { string _txt = obj.text.replaceAll(rgx.inline_notes_al_gen, "").strip; foreach_reverse (n; 0 .. 7) { string k = n.to!string; switch (obj.metainfo.dom_structure_collapsed_tags_status[n]) { case DomTags.close : toc ~= markup.indent_by_spaces_provided((n + 1), " ") ~ "</li>" ~ "\n"; toc ~= markup.indent_by_spaces_provided(n, " ") ~ "</ol>" ~ "\n"; break; case DomTags.close_and_open : toc ~= markup.indent_by_spaces_provided((n + 1), " ") ~ "</li>" ~ "\n"; if (obj.metainfo.heading_lev_markup < 4) { toc ~= markup.indent_by_spaces_provided((n + 1), " ") ~ "<li>" ~ "\n" ~ markup.indent_by_spaces_provided((n + 2), " ") ~ "<a href=\"" ~ obj.tags.segment_anchor_tag_epub ~ ".xhtml" ~ "\">" ~ _txt ~ "</a>" ~ "\n"; } else { string hashtag =(obj.metainfo.heading_lev_markup == 4) ? "" : ("#" ~ obj.metainfo.ocn.to!string); toc ~= markup.indent_by_spaces_provided((n + 1), " ") ~ "<li>" ~ "\n" ~ markup.indent_by_spaces_provided((n + 2), " ") ~ "<a href=\"" ~ obj.tags.segment_anchor_tag_epub ~ ".xhtml" ~ hashtag ~ "\">" ~ _txt ~ "</a>" ~ "\n"; } break; case DomTags.open : toc ~= markup.indent_by_spaces_provided(n, " ") ~ "<ol>" ~ "\n"; if (obj.metainfo.heading_lev_markup < 4) { toc ~= markup.indent_by_spaces_provided((n + 1), " ") ~ "<li>" ~ "\n" ~ markup.indent_by_spaces_provided((n + 2), " ") ~ "<a href=\"" ~ obj.tags.segment_anchor_tag_epub ~ ".xhtml" ~ "\">" ~ _txt ~ "</a>" ~ "\n"; } else { string hashtag =(obj.metainfo.heading_lev_markup == 4) ? "" : ("#" ~ obj.metainfo.ocn.to!string); toc ~= markup.indent_by_spaces_provided((n + 1), " ") ~ "<li>" ~ "\n" ~ markup.indent_by_spaces_provided((n + 2), " ") ~ "<a href=\"" ~ obj.tags.segment_anchor_tag_epub ~ ".xhtml" ~ hashtag ~ "\">" ~ _txt ~ "</a>" ~ "\n"; } break; default : break; } } } } } toc ~="</nav> </section> </body> </html>\n"; return toc; } #+END_SRC **** TODO _doc navigation epub2_ (OEBPS/toc.ncx) navigable toc using Dom structure - toc.ncx (epub2 navigation document) - (replaced in epub3 by a declared xhtml nav file, in our case toc_nav.xhtml) #+NAME: output_epub3_constructs_2 #+BEGIN_SRC d @safe string epub2_oebps_toc_ncx(D,I)(D doc_abstraction, I doc_matters) { int counter = 0; string _uuid = "18275d951861c77f78acd05672c9906924c59f18a2e0ba06dad95959693e9bd8"; // TODO shared elsewhere auto markup = InlineMarkup(); static auto rgx = RgxO(); enum DomTags { none, open, close, close_and_open, open_still, } string toc = format(q"┃<?xml version='1.0' encoding='utf-8'?> <ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1"> <head> <!-- four required metadata items (for all NCX documents, (including the relaxed constraints of OPS 2.0) --> <title>%s%s</title> <link rel="stylesheet" href="css/epub.css" type="text/css" id="main-css" /> <meta name="dtb:uid" content="urn:uuid:%s" /> <!-- <meta name="epub-creator" content="spine http://www.jus.uio.no/sisu (this copy)" /> --> <meta name="dtb:depth" content="%s" /> <meta name="dtb:totalPageCount" content="0" /> <meta name="dtb:maxPageNumber" content="0" /> </head> <docTitle> <text>%s</text> </docTitle> <docAuthor> <text>%s</text> </docAuthor> <navMap>┃", doc_matters.conf_make_meta.meta.title_full, // title (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : " by " ~ doc_matters.conf_make_meta.meta.creator_author, // author _uuid, // uuid "3", // content depth doc_matters.conf_make_meta.meta.title_full, // title (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : doc_matters.conf_make_meta.meta.creator_author, // author ); foreach (sect; doc_matters.has.keys_seq.seg) { foreach (obj; doc_abstraction[sect]) { if (obj.metainfo.is_a == "heading") { string _txt = obj.text.replaceAll(rgx.inline_notes_al_gen, "").strip; string hashtag =(obj.metainfo.heading_lev_markup <= 4) ? "" : ("#" ~ obj.metainfo.ocn.to!string); foreach_reverse (k; 0 .. 7) { switch (obj.metainfo.dom_structure_markedup_tags_status[k]) { case DomTags.close : toc ~= "\n </navPoint>"; break; case DomTags.close_and_open : ++counter; toc ~= "\n </navPoint>"; toc ~= format(q"┃ <navPoint class="chapter" id="navpoint" playOrder="%s"> <navLabel> <text>%s</text> </navLabel> <content src="%s.xhtml%s" />┃", counter, _txt, obj.tags.segment_anchor_tag_epub, hashtag, ); break; case DomTags.open : ++counter; toc ~= format(q"┃ <navPoint class="chapter" id="navpoint" playOrder="%s"> <navLabel> <text>%s</text> </navLabel> <content src="%s.xhtml%s" />┃", counter, _txt, obj.tags.segment_anchor_tag_epub, hashtag, ); break; default : break; } } } } } toc ~= format(q"┃ </navPoint> </navPoint> </navPoint> </navMap> </ncx>┃"); return toc; } #+END_SRC ** the document contents :seg: *** ↻ loop & switch (sections & objects) format epub3 xhtml output #+NAME: output_epub3_xhtml_seg_0 #+BEGIN_SRC d @system void outputEPub3(D,I)( const D doc_abstraction, I doc_matters, ) { mixin spineRgxOut; auto xhtml_format = outputXHTMLs(); static auto rgx = RgxO(); 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_ncx; 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_1 #+BEGIN_SRC d foreach (part; doc_matters.has.keys_seq.seg) { foreach (obj; doc_abstraction[part]) { string _txt = xhtml_format.special_characters(obj); #+END_SRC ***** all headings #+NAME: output_epub3_xhtml_seg_2 #+BEGIN_SRC d if (obj.metainfo.is_a == "heading") { assert(part == "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); auto 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); auto 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: auto 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 && doc_matters.opt.action.verbose) { 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); } } break; } #+END_SRC ***** non-heading #+NAME: output_epub3_xhtml_seg_3 #+BEGIN_SRC d } else { assert(part == "head" || "toc" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.is_of_part) { #+END_SRC ****** frontmatter #+NAME: output_epub3_xhtml_seg_4 #+BEGIN_SRC d case "frontmatter": assert(part == "head" || "toc"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "toc": auto 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ****** body #+NAME: output_epub3_xhtml_seg_5 #+BEGIN_SRC d case "body": assert(part == "body"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "para": auto 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; case "block": switch (obj.metainfo.is_a) { case "quote": auto 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": auto 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": auto 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": auto 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; #+END_SRC ****** backmatter #+NAME: output_epub3_xhtml_seg_6 #+BEGIN_SRC d case "backmatter": assert(part == "endnotes" || "glossary" || "bibliography" || "bookindex" || "blurb" || "tail"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "endnote": assert(part == "endnotes"); auto t = xhtml_format.para_seg(_txt, obj, doc_matters, suffix, "epub"); epubWrite.doc_epub3[segment_filename] ~= t[0]; break; case "glossary": assert(part == "glossary"); auto 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(part == "bibliography"); auto 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(part == "bookindex"); auto 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(part == "blurb"); auto 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 && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } } break; } break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } } break; } break; case "comment": break; default: { /+ debug +/ if (doc_matters.opt.action.debug_do && doc_matters.opt.action.verbose) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_part); } } break; } } if (obj.metainfo.is_a == "heading") { assert(obj.text.length > 0); if (obj.metainfo.heading_lev_markup <= 4) { oepbs_content_parts["manifest_documents"] ~= format(q"┃ <item id="%s.xhtml" href="%s.xhtml" media-type="application/xhtml+xml" /> ┃", obj.tags.segment_anchor_tag_epub, obj.tags.segment_anchor_tag_epub, ); oepbs_content_parts["spine"] ~= format(q"┃ <itemref idref="%s.xhtml" linear="yes" /> ┃", obj.tags.segment_anchor_tag_epub, ); oepbs_content_parts["guide"] ~= format(q"┃ <reference type="%s" href="%s" /> ┃", 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"┃ <item id="%s.xhtml#%s" href="%s.xhtml#%s" media-type="application/xhtml+xml" /> ┃", 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"┃ <itemref idref="%s.xhtml#%s" linear="yes" /> ┃", obj.tags.segment_anchor_tag_epub, obj.metainfo.object_number, ); oepbs_content_parts["guide"] ~= format(q"┃ <reference type="%s#%s" href="%s#%s" /> ┃", 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_7 #+BEGIN_SRC d } } } /+ epub specific documents +/ epubWrite.mimetypes = epub3_mimetypes; epubWrite.meta_inf_container_xml = epub3_container_xml; epubWrite.oebps_toc_ncx = doc_abstraction.epub2_oebps_toc_ncx(doc_matters); 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: #+NAME: output_epub3_xhtml_seg_8 #+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_toc_ncx) == string)); static assert(is(typeof(epub_write.oebps_content_opf) == string)); } static auto rgx = RgxO(); 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) ? 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; } { /+ debug +/ if (doc_matters.opt.action.debug_do) { 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) { 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); } } 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.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) { 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) { 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) { 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/toc.ncx (navigation toc epub2) +/ { /+ debug +/ if (doc_matters.opt.action.debug_do) { fn_dbg = pth_epub3.dbg_fn_oebps_toc_ncx(doc_matters.src.filename); File(fn_dbg, "w").writeln(epub_write.oebps_toc_ncx); } } fn = pth_epub3.fn_oebps_toc_ncx; EPUBzip(epub_write.oebps_toc_ncx, fn); } { /+ OEBPS/content.opf (doc manifest) +/ { /+ debug +/ if (doc_matters.opt.action.debug_do) { 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) { if (doc_matters.opt.action.very_verbose) { 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) { 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.quiet)) { writeln(" ", fn_epub); } #+END_SRC ** zip debug, read zip archive :zip: #+NAME: output_epub3_xhtml_seg_9 #+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 * __END__