#+TITLE: doc_reform output xmls #+DESCRIPTION: documents - structuring, publishing in multiple formats & search #+FILETAGS: :doc_reform:output:xmls: #+AUTHOR: Ralph Amissah #+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] #+LANGUAGE: en #+STARTUP: indent content #+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t #+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc #+OPTIONS: author:nil email:nil creator:nil timestamp:nil #+PROPERTY: header-args :padline no :exports code :noweb yes #+EXPORT_SELECT_TAGS: export #+EXPORT_EXCLUDE_TAGS: noexport #+TAGS: assert(a) class(c) debug(d) mixin(m) doc_reform(s) tangle(T) template(t) WEB(W) noexport(n) - [[./doc_reform.org][doc_reform]] [[./][org/]] - [[./output_hub.org][output_hub]] * xml offspring (xhtml html epub) :module: ** format xhtml objects :format: *** 0. module template #+BEGIN_SRC d :tangle ../src/doc_reform/output/xmls.d module doc_reform.output.xmls; template outputXHTMLs() { <> mixin DocReformOutputRgxInit; struct outputXHTMLs { static auto rgx = Rgx(); <> <> } } #+END_SRC *** output imports #+name: output_imports #+BEGIN_SRC d import doc_reform.output; import std.digest.sha, std.file, std.outbuffer, std.zip, std.conv : to; import doc_reform.output.create_zip_file, doc_reform.output.xmls, doc_reform.output.xmls_css; #+END_SRC *** misc **** div delimiter #+name: xhtml_format_objects #+BEGIN_SRC d string div_delimit( string part, return ref string previous_part ){ string delimit = ""; string delimit_ = ""; if (part != previous_part) { switch (part) { case "head": delimit_ ~= "\n
\n" ; break; case "toc_seg": delimit_ ~= "\n
\n" ; break; case "toc_scroll": delimit_ ~= "\n
\n" ; break; case "bookindex_seg": delimit_ ~= "\n
\n" ; break; case "bookindex_scroll": delimit_ ~= "\n
\n" ; break; default: delimit_ ~= "\n
\n" ; break; } if (previous_part.length > 0) { delimit ~= "\n
"; } previous_part = part; delimit ~= delimit_; } // you also need to close the last div, introduce a footer? return delimit; } #+END_SRC **** special characters #+name: xhtml_format_objects #+BEGIN_SRC d string special_characters(O)( const O obj, 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, " "); if (!(obj.metainfo.is_a == "code")) { _txt = (_txt) .replaceAll(rgx.xhtml_line_break, "
"); } return _txt; } #+END_SRC **** special characters text #+name: xhtml_format_objects #+BEGIN_SRC d 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 **** font_face #+name: xhtml_format_objects #+BEGIN_SRC d 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 #+BEGIN_SRC d 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 ~= ""; } } } return tags; } #+END_SRC **** doc head & tails ***** metadata #+name: xhtml_format_objects #+BEGIN_SRC d auto header_metadata(M)( M doc_matters, ) { string _title="Title"; string _author="Author"; string _publisher="Publisher"; string _date="Date"; string _date_created="Date"; string _date_issued="Date"; string _date_available="Date"; string _date_valid="Date"; string _date_modified="Date"; string _language="en"; string _rights="Copyright: Copyright (C) year holder"; string _generator="doc_reform [DocReform 7.1.8 of 2016w08/5 (2016-02-26)] (n*x and D)"; string _generator_home="http://www.sisudoc.org"; string o; o = format(q"¶ ¶", _title, _author, _publisher, _date, _date_created, _date_issued, _date_available, _date_valid, _date_modified, _language, _rights, _generator, _generator_home, ); return o; } #+END_SRC ***** site info button #+name: xhtml_format_objects #+BEGIN_SRC d auto 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_nl, ""); } else { _locations = "

DocReform

\n

www.sisudoc.org

\n

sources / git

"; } string o; o = format(q"¶
%s
¶", _locations, ); return o; } #+END_SRC ***** search form #+name: xhtml_format_objects #+BEGIN_SRC d auto inline_search_form(M)( M doc_matters, ) { string _action="http://www.sisudoc.org/cgi-bin/search.cgi"; string _db="DocReform.7a.manual"; string o; o = format(q"¶

¶", _action, _db, ); return o; } #+END_SRC ***** html head & head banner #+name: xhtml_format_objects #+BEGIN_SRC d auto html_head(M)( M doc_matters, string type, ) { string o; o = format(q"¶ %s%s %s
%s %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") ? "../../../" : "../../") ~ "image/rb7.ico", ((type == "seg") ? "../../../css/html_seg.css" : "../../css/html_scroll.css"), doc_matters.src.language, site_info_button(doc_matters), inline_search_form(doc_matters), ((type == "seg") ? "" : "\n
"), ); return o; } #+END_SRC ***** epub seg head #+name: xhtml_format_objects #+BEGIN_SRC d auto 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, 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.title_full, (doc_matters.conf_make_meta.meta.creator_author.empty) ? "" : ", " ~ doc_matters.conf_make_meta.meta.creator_author, doc_matters.src.language, ); return o; } #+END_SRC ***** xhtml tail #+name: xhtml_format_objects #+BEGIN_SRC d auto tail() { string o; o = format(q"¶
¶"); return o; } #+END_SRC *** inline markup **** images #+name: xhtml_format_objects #+BEGIN_SRC d auto inline_images(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "seg", ) { string _img_pth; if (_xml_type == "epub") { _img_pth = "image/"; } else if (_xml_type == "scroll") { _img_pth = "../../image/"; } else if (_xml_type == "seg") { _img_pth = "../../../image/"; } if (_txt.match(rgx.inline_image)) { _txt = _txt.replaceAll( rgx.inline_image, ("$1 $6")); } return _txt; } #+END_SRC **** links ***** scroll, seg, epub #+name: xhtml_format_objects #+BEGIN_SRC d auto inline_links(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "seg", ) { if (obj.has.inline_links) { 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") { if (auto m = _txt.match(rgx.inline_link_hash)) { if (m.captures[3] in doc_matters.xml.tag_associations) { if (m.captures[3] == doc_matters.xml.tag_associations[(m.captures[3])][0]) { _txt = _txt.replaceFirst( rgx.inline_link_hash, "┥$1┝┤$3" ~ _suffix ~ "├" ); } else { _txt = _txt.replaceFirst( rgx.inline_link_hash, "┥$1┝┤" ~ doc_matters.xml.tag_associations[(m.captures[3])][0] ~ _suffix ~ "#" ~ "$3" ~ "├" ); } } else { writeln( "WARNING on internal document links, anchor to link not found in document, " ~ "anchor: " ~ m.captures[3] ~ " 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 #+BEGIN_SRC d auto inline_notes_scroll(M,O)( M doc_matters, const O obj, string _txt, ) { if (obj.has.inline_notes_reg) { _txt = font_face(_txt); _txt = (_txt).replaceAll( rgx.inline_notes_delimiter_al_regular_number_note, (" $1 ") ); } debug(markup_endnotes) { if (_txt.match(rgx.inline_notes_delimiter_al_regular_number_note)) { writeln(__LINE__, " (missed) markup endnote: ", obj.metainfo.is_a, ": ", obj.text); } } debug(markup) { if (_txt.match(rgx.inline_notes_delimiter_al_regular_number_note)) { writeln(__LINE__, " (missed) markup endnote: ", obj.metainfo.is_a, ": ", obj.text); } } return _txt; } #+END_SRC ***** seg #+name: xhtml_format_objects #+BEGIN_SRC d auto inline_notes_seg(M,O)( M doc_matters, const O obj, string _txt, ) { string[] _endnotes; if (obj.has.inline_notes_reg) { _txt = font_face(_txt); /+ need markup for text, and separated footnote +/ foreach(m; _txt.matchAll(rgx.inline_notes_delimiter_al_regular_number_note)) { _endnotes ~= format( "%s%s%s%s\n %s%s%s%s%s\n %s\n%s", "

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

" ); } _txt = (_txt).replaceAll( rgx.inline_notes_delimiter_al_regular_number_note, (" $1 ") ); } else if (_txt.match(rgx.inline_notes_delimiter_al_regular_number_note)) { debug(markup) { writeln(__LINE__, " endnote: ", obj.metainfo.is_a, ": ", obj.text); } } auto t = tuple( _txt, _endnotes, ); return t; } #+END_SRC **** inline markup ***** scroll #+name: xhtml_format_objects #+BEGIN_SRC d auto inline_markup_scroll(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", ) { _txt = inline_images(doc_matters, obj, _txt, _suffix, "scroll"); _txt = inline_links(doc_matters, obj, _txt, _suffix, "scroll"); _txt = inline_notes_scroll(doc_matters, obj, _txt); return _txt; } #+END_SRC ***** seg #+name: xhtml_format_objects #+BEGIN_SRC d auto inline_markup_seg(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "seg", ) { _txt = inline_images(doc_matters, obj, _txt, _suffix, _xml_type); // TODO _txt = inline_links(doc_matters, obj, _txt, _suffix, _xml_type); // TODO auto t = inline_notes_seg(doc_matters, obj, _txt); return t; } #+END_SRC *** toc **** subtoc #+name: xhtml_format_objects #+BEGIN_SRC d string lev4_heading_subtoc(M,O)( M doc_matters, const O obj, ) { 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!string; 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 #+BEGIN_SRC d auto nav_pre_next_svg(M,O)( M doc_matters, const O obj, ) { string prev, next, toc; if (obj.tags.segment_anchor_tag == "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"¶
¶", toc, prev, next, ); string _pre_next = format(q"¶
¶", 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 #+BEGIN_SRC d auto heading(M,O)( M doc_matters, const O obj, string _txt, string _xml_type = "html", ) { auto tags = _xhtml_anchor_tags(obj); string seg_anchor_tag; 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; seg_anchor_tag = (obj.tags.segment_anchor_tag.empty) ? "" : ""; heading_lev_anchor_tag = (obj.tags.heading_lev_anchor_tag.empty) ? "" : ""; if (obj.metainfo.object_number.empty) { o = format(q"¶%s
%s%s %s
¶", _horizontal_rule, obj.metainfo.heading_lev_markup, obj.metainfo.is_a, tags, heading_lev_anchor_tag, _txt, obj.metainfo.heading_lev_markup, ); } else { o = format(q"¶%s
%s%s %s
¶", _horizontal_rule, obj.metainfo.object_number, obj.metainfo.object_number, obj.metainfo.heading_lev_markup, obj.metainfo.is_a, obj.metainfo.object_number, obj.metainfo.object_number, tags, heading_lev_anchor_tag, _txt, obj.metainfo.heading_lev_markup, ); } return o; } #+END_SRC **** scroll #+name: xhtml_format_objects #+BEGIN_SRC d auto heading_scroll(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", ) { auto tags = _xhtml_anchor_tags(obj); _txt = inline_markup_scroll(doc_matters, obj, _txt, _suffix); string o = heading(doc_matters, obj, _txt); return o; } #+END_SRC **** seg #+name: xhtml_format_objects #+BEGIN_SRC d auto heading_seg(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html" ) { auto t = inline_markup_seg(doc_matters, obj, _txt, _suffix, _xml_type); _txt = t[0]; string[] _endnotes = t[1]; string o = heading(doc_matters, obj, _txt, _xml_type); auto u = tuple( o, _endnotes, ); return u; } #+END_SRC *** para **** para #+name: xhtml_format_objects #+BEGIN_SRC d auto para(M,O)( M doc_matters, const O obj, string _txt, ) { auto tags = _xhtml_anchor_tags(obj); _txt = font_face(_txt); string o; _txt = (obj.attrib.bullet) ? ("●  " ~ _txt) : _txt; if (obj.metainfo.object_number.empty) { o = format(q"¶

%s %s

¶", obj.metainfo.is_a, obj.attrib.indent_hang, obj.attrib.indent_base, tags, _txt ); } else { o = format(q"¶

%s %s

¶", obj.metainfo.object_number, obj.metainfo.object_number, obj.metainfo.is_a, obj.attrib.indent_hang, obj.attrib.indent_base, obj.metainfo.object_number, tags, _txt ); } return o; } #+END_SRC **** scroll #+name: xhtml_format_objects #+BEGIN_SRC d auto para_scroll(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", ) { auto tags = _xhtml_anchor_tags(obj); _txt = inline_markup_scroll(doc_matters, obj, _txt, _suffix); string o = para(doc_matters, obj, _txt); return o; } #+END_SRC **** seg #+name: xhtml_format_objects #+BEGIN_SRC d auto para_seg(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html", ) { auto t = inline_markup_seg(doc_matters, obj, _txt, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = para(doc_matters, obj, _txt); auto u = tuple( o, _endnotes, ); return u; } #+END_SRC *** quote **** quote #+name: xhtml_format_objects #+BEGIN_SRC d auto quote(M,O)( M doc_matters, const O obj, string _txt, ) { _txt = font_face(_txt); string o; if (obj.metainfo.object_number.empty) { o = format(q"¶

%s

¶", obj.metainfo.is_a, _txt ); } else { o = format(q"¶

%s

¶", obj.metainfo.object_number, obj.metainfo.object_number, obj.metainfo.is_a, obj.metainfo.object_number, _txt ); } return o; } #+END_SRC **** scroll #+name: xhtml_format_objects #+BEGIN_SRC d auto quote_scroll(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", ) { auto tags = _xhtml_anchor_tags(obj); _txt = inline_markup_scroll(doc_matters, obj, _txt, _suffix); string o = quote(doc_matters, obj, _txt); return o; } #+END_SRC **** seg #+name: xhtml_format_objects #+BEGIN_SRC d auto quote_seg(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html", ) { auto t = inline_markup_seg(doc_matters, obj, _txt, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = quote(doc_matters, obj, _txt); auto u = tuple( o, _endnotes, ); return u; } #+END_SRC *** group **** group #+name: xhtml_format_objects #+BEGIN_SRC d auto group(M,O)( M doc_matters, const O obj, string _txt, ) { _txt = font_face(_txt); string o; if (obj.metainfo.object_number.empty) { o = format(q"¶

%s

¶", obj.metainfo.is_a, _txt ); } else { o = format(q"¶

%s

¶", obj.metainfo.object_number, obj.metainfo.object_number, obj.metainfo.is_a, obj.metainfo.object_number, _txt ); } return o; } #+END_SRC **** scroll #+name: xhtml_format_objects #+BEGIN_SRC d auto group_scroll(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html", ) { auto tags = _xhtml_anchor_tags(obj); _txt = inline_markup_scroll(doc_matters, obj, _txt, _suffix); string o = group(doc_matters, obj, _txt); return o; } #+END_SRC **** seg #+name: xhtml_format_objects #+BEGIN_SRC d auto group_seg(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html", ) { auto t = inline_markup_seg(doc_matters, obj, _txt, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = group(doc_matters, obj, _txt); auto u = tuple( o, _endnotes, ); return u; } #+END_SRC *** block **** block #+name: xhtml_format_objects #+BEGIN_SRC d auto block(M,O)( M doc_matters, const O obj, string _txt, ) { _txt = font_face(_txt); string o; if (obj.metainfo.object_number.empty) { o = format(q"¶

%s

¶", obj.metainfo.is_a, _txt.stripRight ); } else { o = format(q"¶

%s

¶", obj.metainfo.object_number, obj.metainfo.object_number, obj.metainfo.is_a, obj.metainfo.object_number, _txt.stripRight ); } return o; } #+END_SRC **** scroll #+name: xhtml_format_objects #+BEGIN_SRC d auto block_scroll(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html", ) { auto tags = _xhtml_anchor_tags(obj); _txt = inline_markup_scroll(doc_matters, obj, _txt, _suffix); string o = block(doc_matters, obj, _txt); return o; } #+END_SRC **** seg #+name: xhtml_format_objects #+BEGIN_SRC d auto block_seg(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html", ) { auto t = inline_markup_seg(doc_matters, obj, _txt, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = block(doc_matters, obj, _txt); auto u = tuple( o, _endnotes, ); return u; } #+END_SRC *** poem verse **** verse #+name: xhtml_format_objects #+BEGIN_SRC d auto verse(M,O)( M doc_matters, const O obj, string _txt, ) { _txt = font_face(_txt); string o; if (obj.metainfo.object_number.empty) { o = format(q"¶

%s

¶", obj.metainfo.is_a, _txt ); } else { o = format(q"¶

%s

¶", obj.metainfo.object_number, obj.metainfo.object_number, obj.metainfo.is_a, obj.metainfo.object_number, _txt ); } return o; } #+END_SRC **** scroll #+name: xhtml_format_objects #+BEGIN_SRC d auto verse_scroll(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html", ) { auto tags = _xhtml_anchor_tags(obj); _txt = inline_markup_scroll(doc_matters, obj, _txt, _suffix); string o = verse(doc_matters, obj, _txt); return o; } #+END_SRC **** seg #+name: xhtml_format_objects #+BEGIN_SRC d auto verse_seg(M,O)( M doc_matters, const O obj, string _txt, string _suffix = ".html", string _xml_type = "html", ) { auto t = inline_markup_seg(doc_matters, obj, _txt, _suffix, _xml_type); _txt = t[0].to!string; string[] _endnotes = t[1]; string o = verse(doc_matters, obj, _txt); auto u = tuple( o, _endnotes, ); return u; } #+END_SRC *** code #+name: xhtml_format_objects_code #+BEGIN_SRC d auto code(M,O)( M doc_matters, const O obj, string _txt, ) { string o; if (obj.metainfo.object_number.empty) { o = format(q"¶

%s

¶", obj.metainfo.is_a, _txt ); } else { o = format(q"¶

%s

¶", obj.metainfo.object_number, obj.metainfo.object_number, obj.metainfo.is_a, obj.metainfo.object_number, _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 #+BEGIN_SRC d auto tablarize(M,O)( M doc_matters, const O obj, string _txt, ) { 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 ~= ""; } auto t = tuple( _table, _tablenote, ); return t; } #+END_SRC **** table #+name: xhtml_format_objects #+BEGIN_SRC d auto table(M,O)( M doc_matters, const O obj, string _txt, ) { auto tags = _xhtml_anchor_tags(obj); _txt = font_face(_txt); auto t = tablarize(doc_matters, obj, _txt); _txt = t[0]; string _note = t[1]; string o; o = format(q"¶

%s %s
%s

¶", obj.metainfo.object_number, obj.metainfo.object_number, obj.metainfo.is_a, obj.metainfo.object_number, tags, _txt, _note ); return o; } #+END_SRC *** endnote #+name: xhtml_format_objects #+BEGIN_SRC d auto endnote(M,O)( M doc_matters, const O obj, string _txt, ) { string o; o = format(q"¶

%s

¶", obj.metainfo.is_a, obj.attrib.indent_hang, obj.attrib.indent_base, _txt ); return o; } #+END_SRC * _html_ [#A] :module:doc_reform:output_html: ** module template #+BEGIN_SRC d :tangle ../src/doc_reform/output/html.d module doc_reform.output.html; template outputHTML() { <> mixin outputXHTMLs; <> <> <> <> } #+END_SRC ** scroll :scroll: *** ↻ loop & switch (sections & objects) format html output #+name: output_html_scroll #+BEGIN_SRC d void scroll(D,M)( const D doc_abstraction, M doc_matters, ) { mixin DocReformOutputRgxInit; auto xhtml_format = outputXHTMLs(); auto rgx = Rgx(); string[] doc_html; string[] doc; string suffix = ".html"; string previous_part = ""; string delimit = ""; foreach (part; doc_matters.xml.keys_seq.scroll) { foreach (obj; doc_abstraction[part]) { delimit = xhtml_format.div_delimit(part, previous_part); string _txt = xhtml_format.special_characters(obj, obj.text); switch (obj.metainfo.is_of_part) { case "frontmatter": assert(part == "head" || "toc_scroll"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "heading": doc_html ~= delimit ~ xhtml_format.heading_scroll(doc_matters, obj, _txt, suffix); break; case "toc": doc_html ~= xhtml_format.para_scroll(doc_matters, obj, _txt, suffix); break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } break; } break; 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(doc_matters, obj, _txt, suffix); break; case "para": doc_html ~= xhtml_format.para_scroll(doc_matters, obj, _txt, suffix); break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; case "block": switch (obj.metainfo.is_a) { case "quote": doc_html ~= xhtml_format.quote_scroll(doc_matters, obj, _txt); break; case "group": doc_html ~= xhtml_format.group_scroll(doc_matters, obj, _txt); break; case "block": doc_html ~= xhtml_format.block_scroll(doc_matters, obj, _txt); break; case "poem": break; case "verse": doc_html ~= xhtml_format.verse_scroll(doc_matters, obj, _txt, suffix); break; case "code": doc_html ~= xhtml_format.code(doc_matters, obj, _txt); break; case "table": doc_html ~= xhtml_format.table(doc_matters, obj, _txt); break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } break; } break; case "backmatter": assert(part == "endnotes" || "glossary" || "bibliography" || "bookindex_scroll" || "blurb" || "tail"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "heading": doc_html ~= delimit ~ xhtml_format.heading_scroll(doc_matters, obj, _txt, suffix); break; case "endnote": assert(part == "endnotes"); doc_html ~= xhtml_format.para_scroll(doc_matters, obj, _txt, suffix); break; case "glossary": assert(part == "glossary"); doc_html ~= xhtml_format.para_scroll(doc_matters, obj, _txt, suffix); break; case "bibliography": assert(part == "bibliography"); doc_html ~= xhtml_format.para_scroll(doc_matters, obj, _txt, suffix); break; case "bookindex": assert(part == "bookindex_scroll"); doc_html ~= xhtml_format.para_scroll(doc_matters, obj, _txt, suffix); break; case "blurb": assert(part == "blurb"); doc_html ~= xhtml_format.para_scroll(doc_matters, obj, _txt, suffix); break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } break; } break; case "comment": break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_part); writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); writeln(__FILE__, ":", __LINE__, ": ", obj.text); } break; } } } doc = xhtml_format.html_head(doc_matters, "scroll") ~ doc_html ~ xhtml_format.tail; scroll_write_output(doc_matters, doc); } #+END_SRC *** write output file #+name: output_html_scroll #+BEGIN_SRC d void scroll_write_output(M,C)( M doc_matters, C doc, ) { debug(asserts) { static assert(is(typeof(doc) == string[])); } auto pth_html = DocReformPathsHTML!()(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 #+BEGIN_SRC d void seg(D,M)( const D doc_abstraction, M doc_matters, ) { mixin DocReformOutputRgxInit; auto rgx = Rgx(); 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 = ""; foreach (part; doc_matters.xml.keys_seq.seg) { foreach (obj; doc_abstraction[part]) { delimit = xhtml_format.div_delimit(part, previous_part); string _txt = xhtml_format.special_characters(obj, obj.text); if (obj.metainfo.is_a == "heading") { assert(part == "head" || "toc_seg" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "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(doc_matters, obj, _txt, suffix, "seg"); top_level_headings[obj.metainfo.heading_lev_markup] = t[0]; break; } break; case 4: segment_filename = obj.tags.segment_anchor_tag; doc_html[segment_filename] ~= xhtml_format.html_head(doc_matters, "seg"); auto navigation_bar = xhtml_format.nav_pre_next_svg(doc_matters, obj); 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(doc_matters, obj, _txt, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html[segment_filename] ~= xhtml_format.lev4_heading_subtoc(doc_matters, obj); doc_html_endnotes[segment_filename] ~= t[1]; break; case 5: .. case 7: auto t = xhtml_format.heading_seg(doc_matters, obj, _txt, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; break; case 8: .. case 9: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); writeln(__FILE__, ":", __LINE__, ": ", obj.text); } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); } break; } } else { assert(part == "head" || "toc_seg" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "blurb" || "tail"); switch (obj.metainfo.is_of_part) { case "frontmatter": assert(part == "head" || "toc_seg"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "toc": auto t = xhtml_format.para_seg(doc_matters, obj, _txt, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; 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(doc_matters, obj, _txt, suffix, "seg"); doc_html[segment_filename] ~= t[0].to!string; doc_html_endnotes[segment_filename] ~= t[1]; break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; case "block": switch (obj.metainfo.is_a) { case "quote": auto t = xhtml_format.quote_seg(doc_matters, obj, _txt, 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(doc_matters, obj, _txt, 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(doc_matters, obj, _txt, 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(doc_matters, obj, _txt, 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(doc_matters, obj, _txt); break; case "table": doc_html[segment_filename] ~= xhtml_format.table(doc_matters, obj, _txt); doc_html_endnotes[segment_filename] ~= ""; break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } break; } break; case "backmatter": assert(part == "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "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(doc_matters, obj, _txt, suffix, "seg"); doc_html[segment_filename] ~= t[0]; break; case "glossary": assert(part == "glossary"); auto t = xhtml_format.para_seg(doc_matters, obj, _txt, 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(doc_matters, obj, _txt, suffix, "seg"); doc_html[segment_filename] ~= t[0]; doc_html_endnotes[segment_filename] ~= t[1]; break; case "bookindex": assert(part == "bookindex_seg"); auto t = xhtml_format.para_seg(doc_matters, obj, _txt, 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(doc_matters, obj, _txt, suffix, "seg"); doc_html[segment_filename] ~= t[0]; doc_html_endnotes[segment_filename] ~= t[1]; break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } break; } break; case "comment": break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_part); } break; } } } } seg_write_output(doc_matters, doc_html, doc_html_endnotes); } #+END_SRC *** write output files #+name: output_html_seg #+BEGIN_SRC d void seg_write_output(M,D,E)( M doc_matters, D doc_html, E doc_html_endnotes, ) { debug(asserts) { static assert(is(typeof(doc_html) == string[][string])); } mixin DocReformOutputRgxInit; auto rgx = Rgx(); auto pth_html = DocReformPathsHTML!()(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.xml.segnames) { 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 void css(M)( auto ref M doc_matters, ) { auto css = DocReformCss(); auto pth_html = DocReformPathsHTML!()(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_css); f = File(pth_html.fn_scroll_css, "w"); f.writeln(css.html_scroll_css); } catch (ErrnoException ex) { // Handle error } } #+END_SRC ** images :images: #+name: copy_html_images #+BEGIN_SRC d void images_cp(M)( auto ref M doc_matters, ) { { /+ (copy html images) +/ auto pth_html = DocReformPathsHTML!()(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 { writeln("WARNING image not found: ", fn_src_in); } } } } #+END_SRC * _epub_ [#B] :module:doc_reform:output_epub3: |-----------------------+--------------------------+---------------------------+----------------------------------| | 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 #+BEGIN_SRC d :tangle ../src/doc_reform/output/epub3.d module doc_reform.output.epub3; template outputEPub3() { <> mixin InternalMarkup; mixin outputXHTMLs; <> <> <> <> <> } #+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 #+BEGIN_SRC d 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 #+BEGIN_SRC d 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 #+name: output_epub3_constructs #+BEGIN_SRC d string epub3_oebps_content(D,M,P)(D doc_abstraction, M doc_matters, P parts) { auto xhtml_format = outputXHTMLs(); auto pth_epub3 = DocReformPathsEPUB!()(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_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(doc_matters.src.filename)).chompPrefix("OEBPS/"), ); content ~= " " ~ "" ~ "\n "; content ~= parts["manifest_documents"]; // TODO sort jpg & png content ~= " " ~ "" ~ "\n "; foreach (image; doc_matters.srcs.image_list) { content ~= format(q"¶ ¶", image.baseName.stripExtension, (pth_epub3.doc_oebps_image(doc_matters.src.filename)).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 (s; doc_matters.xml.keys_seq.seg) { foreach (obj; doc_abstraction[s]) { 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, 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, 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 #+BEGIN_SRC d 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(); auto rgx = Rgx(); string toc =format(" %s

Contents

\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 #+BEGIN_SRC d 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(); auto rgx = Rgx(); enum DomTags { none, open, close, close_and_open, open_still, } string toc = format(q"¶ %s%s %s %s ¶", 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.xml.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 "; break; case DomTags.close_and_open : ++counter; toc ~= "\n "; toc ~= format(q"¶ %s ¶", counter, _txt, obj.tags.segment_anchor_tag_is, hashtag, ); break; case DomTags.open : ++counter; toc ~= format(q"¶ %s ¶", counter, _txt, obj.tags.segment_anchor_tag_is, hashtag, ); break; default : break; } } } } } toc ~= format(q"¶ ¶"); return toc; } #+END_SRC ** the document contents :seg: *** ↻ loop & switch (sections & objects) format epub3 xhtml output #+name: output_epub3_xhtml_seg #+BEGIN_SRC d void outputEPub3(D,I)( const D doc_abstraction, I doc_matters, ) { mixin DocReformOutputRgxInit; auto xhtml_format = outputXHTMLs(); auto rgx = Rgx(); string[][string] doc_epub3; string[][string] doc_epub3_endnotes; string[] doc; string segment_filename; string[] top_level_headings = ["","","",""]; string[string] oepbs_content_parts; string suffix = ".xhtml"; string[] doc_parts_; foreach (part; doc_matters.xml.keys_seq.seg) { foreach (obj; doc_abstraction[part]) { string _txt = xhtml_format.special_characters(obj, obj.text); if (obj.metainfo.is_a == "heading") { assert(part == "head" || "toc_seg" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "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: doc_parts_ ~= obj.tags.segment_anchor_tag; doc_epub3[obj.tags.segment_anchor_tag] ~= xhtml_format.epub3_seg_head(doc_matters); auto t = xhtml_format.heading_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[obj.tags.segment_anchor_tag] ~= t[0]; doc_epub3_endnotes[obj.tags.segment_anchor_tag] ~= t[1]; break; } break; case 4: segment_filename = obj.tags.segment_anchor_tag; doc_epub3[segment_filename] ~= xhtml_format.epub3_seg_head(doc_matters); auto t = xhtml_format.heading_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case 5: .. case 7: auto t = xhtml_format.heading_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case 8: .. case 9: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); writeln(__FILE__, ":", __LINE__, ": ", obj.text); } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a, ": ", obj.metainfo.heading_lev_markup); } break; } } else { assert(part == "head" || "toc_seg" || "body" || "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "blurb" || "tail"); switch (obj.metainfo.is_of_part) { case "frontmatter": assert(part == "head" || "toc_seg"); switch (obj.metainfo.is_of_type) { case "para": switch (obj.metainfo.is_a) { case "toc": auto t = xhtml_format.para_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } break; } break; 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(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; case "block": switch (obj.metainfo.is_a) { case "quote": auto t = xhtml_format.quote_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0].to!string; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "group": auto t = xhtml_format.group_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0].to!string; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "block": auto t = xhtml_format.block_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0].to!string; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "poem": break; case "verse": auto t = xhtml_format.verse_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0].to!string; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "code": doc_epub3[segment_filename] ~= xhtml_format.code(doc_matters, obj, _txt); break; case "table": doc_epub3[segment_filename] ~= xhtml_format.table(doc_matters, obj, _txt); doc_epub3_endnotes[segment_filename] ~= ""; break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } break; } break; case "backmatter": assert(part == "endnotes" || "glossary" || "bibliography" || "bookindex_seg" || "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(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; break; case "glossary": assert(part == "glossary"); auto t = xhtml_format.para_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "bibliography": assert(part == "bibliography"); auto t = xhtml_format.para_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "bookindex": assert(part == "bookindex_seg"); auto t = xhtml_format.para_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; doc_epub3_endnotes[segment_filename] ~= t[1]; break; case "blurb": assert(part == "blurb"); auto t = xhtml_format.para_seg(doc_matters, obj, _txt, suffix, "epub"); doc_epub3[segment_filename] ~= t[0]; doc_epub3_endnotes[segment_filename] ~= t[1]; break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_a); } break; } break; default: if ((doc_matters.opt.action.debug_do)) { writeln(__FILE__, ":", __LINE__, ": ", obj.metainfo.is_of_type); } break; } break; case "comment": break; default: if ((doc_matters.opt.action.debug_do)) { 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"¶ ¶", obj.tags.segment_anchor_tag_is, obj.tags.segment_anchor_tag_is, ); oepbs_content_parts["spine"] ~= format(q"¶ ¶", obj.tags.segment_anchor_tag_is, ); oepbs_content_parts["guide"] ~= format(q"¶ ¶", obj.tags.segment_anchor_tag_is, obj.tags.segment_anchor_tag_is, ); } else if (obj.metainfo.heading_lev_markup > 4) { oepbs_content_parts["manifest_documents"] ~= format(q"¶ ¶", obj.tags.segment_anchor_tag_is, obj.metainfo.object_number, obj.tags.segment_anchor_tag_is, obj.metainfo.object_number, ); oepbs_content_parts["spine"] ~= format(q"¶ ¶", obj.tags.segment_anchor_tag_is, obj.metainfo.object_number, ); oepbs_content_parts["guide"] ~= format(q"¶ ¶", obj.tags.segment_anchor_tag_is, obj.metainfo.object_number, obj.tags.segment_anchor_tag_is, obj.metainfo.object_number, ); } } } } /+ epub specific documents +/ auto mimetypes = epub3_mimetypes; auto meta_inf_container_xml = epub3_container_xml; auto oebps_toc_ncx = epub2_oebps_toc_ncx(doc_abstraction, doc_matters); auto oebps_toc_nav_xhtml = epub3_oebps_toc_nav_xhtml(doc_abstraction, doc_matters); auto oebps_content_opf = epub3_oebps_content(doc_abstraction, doc_matters, oepbs_content_parts); epub3_write_output_files( doc_matters, doc_epub3, doc_epub3_endnotes, mimetypes, meta_inf_container_xml, oebps_toc_nav_xhtml, oebps_toc_ncx, oebps_content_opf, doc_parts_, ); } #+END_SRC ** write output files #+name: output_epub3_xhtml_seg #+BEGIN_SRC d void epub3_write_output_files(M,D,E,Mt,Mic,Otnx,Otn,Oc)( M doc_matters, D doc_epub3, E doc_epub3_endnotes, Mt mimetypes, Mic meta_inf_container_xml, Otnx oebps_toc_nav_xhtml, Otn oebps_toc_ncx, Oc oebps_content_opf, string[] doc_parts_, ) { debug(asserts) { static assert(is(typeof(doc_epub3) == string[][string])); static assert(is(typeof(mimetypes) == string)); static assert(is(typeof(meta_inf_container_xml) == string)); static assert(is(typeof(oebps_toc_nav_xhtml) == string)); static assert(is(typeof(oebps_toc_ncx) == string)); static assert(is(typeof(oebps_content_opf) == string)); } auto pth_epub3 = DocReformPathsEPUB!()(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 +/ try { if (!exists(pth_epub3.base)) { pth_epub3.base.mkdirRecurse; } debug(epub_output) { 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.xml.segnames_lv_0_to_4) { string fn = pth_epub3.fn_oebps_content_xhtml(doc_matters.src.filename, seg_filename); auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); debug(epub_output) { string fn_dbg = pth_epub3.dbg_fn_oebps_content_xhtml(doc_matters.src.filename, seg_filename); auto f = File(fn_dbg, "w"); } foreach (docseg; doc_epub3[seg_filename]) { debug(epub_output) { f.writeln(docseg); } zip_data.write(docseg.dup); } foreach (docseg; doc_epub3_endnotes[seg_filename]) { debug(epub_output) { f.writeln(docseg); } zip_data.write(docseg.dup); } debug(epub_output) { f.writeln(xhtml_format.tail); } 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; debug(epub_output) { string fn_dbg; } File f; { /+ mimetypes (identify zip file type) +/ debug(epub_output) { fn_dbg = pth_epub3.dbg_fn_mimetypes(doc_matters.src.filename); File(fn_dbg, "w").writeln(mimetypes); } fn = pth_epub3.fn_mimetypes(doc_matters.src.filename); auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); zip_data.write(mimetypes.dup); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_epub, zip.build()); } { /+ META-INF/container.xml (identify doc root) +/ debug(epub_output) { fn_dbg = pth_epub3.dbg_fn_dmi_container_xml(doc_matters.src.filename); File(fn_dbg, "w").writeln(meta_inf_container_xml); } fn = pth_epub3.fn_dmi_container_xml(doc_matters.src.filename); auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); zip_data.write(meta_inf_container_xml.dup); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_epub, zip.build()); } { /+ OEBPS/toc_nav.xhtml (navigation toc epub3) +/ debug(epub_output) { fn_dbg = pth_epub3.dbg_fn_oebps_toc_nav_xhtml(doc_matters.src.filename); File(fn_dbg, "w").writeln(oebps_toc_nav_xhtml); } fn = pth_epub3.fn_oebps_toc_nav_xhtml(doc_matters.src.filename); auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); zip_data.write(oebps_toc_nav_xhtml.dup); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_epub, zip.build()); } { /+ OEBPS/toc.ncx (navigation toc epub2) +/ debug(epub_output) { fn_dbg = pth_epub3.dbg_fn_oebps_toc_ncx(doc_matters.src.filename); File(fn_dbg, "w").writeln(oebps_toc_ncx); } fn = pth_epub3.fn_oebps_toc_ncx(doc_matters.src.filename); auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); zip_data.write(oebps_toc_ncx.dup); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_epub, zip.build()); } { /+ OEBPS/content.opf (doc manifest) +/ debug(epub_output) { fn_dbg = pth_epub3.dbg_fn_oebps_content_opf(doc_matters.src.filename); File(fn_dbg, "w").writeln(oebps_content_opf); } fn = pth_epub3.fn_oebps_content_opf(doc_matters.src.filename); auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); zip_data.write(oebps_content_opf.dup); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); createZipFile!()(fn_epub, zip.build()); } { /+ OEBPS/_sisu/image (images) +/ foreach (image; doc_matters.srcs.image_list) { debug(epub_output) { if (exists(doc_matters.src_path_info.image_root ~ "/" ~ image)) { (doc_matters.src_path_info.image_root ~ "/" ~ image) .copy((pth_epub3.dbg_doc_oebps_image(doc_matters.src.filename)) ~ "/" ~ image); } } } foreach (image; doc_matters.srcs.image_list) { debug(epub_output) { debug(epub_images) { writeln( doc_matters.src.image_dir_path, "/", image, " -> ", 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(doc_matters.src.filename.to!string) ~ "/" ~ 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 = DocReformCss(); debug(epub_output) { fn_dbg = pth_epub3.dbg_fn_oebps_css(doc_matters.src.filename); File(fn_dbg, "w").writeln(css.epub_css); } fn = pth_epub3.fn_oebps_css(doc_matters.src.filename); auto zip_arc_member_file = new ArchiveMember(); zip_arc_member_file.name = fn; auto zip_data = new OutBuffer(); zip_data.write(css.epub_css.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 #+name: output_epub3_xhtml_seg #+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__