From 0c4b3cb3707c3b16cd171620427e651d71182813 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 13 Dec 2019 09:09:24 -0500 Subject: present per document metadata --- org/out_metadata.org | 486 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 486 insertions(+) create mode 100644 org/out_metadata.org (limited to 'org/out_metadata.org') diff --git a/org/out_metadata.org b/org/out_metadata.org new file mode 100644 index 0000000..f48d6ac --- /dev/null +++ b/org/out_metadata.org @@ -0,0 +1,486 @@ +-*- mode: org -*- +#+TITLE: spine (doc_manifest) metadata (document harvest) +#+DESCRIPTION: documents - structuring, publishing in multiple formats & search +#+FILETAGS: :spine:output:metadata: +#+AUTHOR: Ralph Amissah +#+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] +#+COPYRIGHT: Copyright (C) 2015 - 2019 Ralph Amissah +#+LANGUAGE: en +#+STARTUP: indent content hideblocks hidestars +#+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 :cache no :noweb yes +#+EXPORT_SELECT_TAGS: export +#+EXPORT_EXCLUDE_TAGS: noexport +#+TAGS: assert(a) class(c) debug(d) mixin(m) spine(s) tangle(T) template(t) WEB(W) noexport(n) + +* document harvest _summary_ :module:spine:metadoc_show_summary: + +** _module template_ metadoc document metadata + +#+BEGIN_SRC d :tangle "../src/spine/io_out/metadata.d" +module spine.io_out.metadata; +template outputMetadata() { + void outputMetadata(T)( T doc_matters) @safe { + <> +<> +<> +<> +<> +<> + <> + <> + } +} +#+END_SRC + +** imports + +#+name: output_imports +#+BEGIN_SRC d +import std.file; +import std.format; +import spine.io_out; +mixin InternalMarkup; +string[] metadata_; +#+END_SRC + +** metadata + +#+name: output_metadata +#+BEGIN_SRC d +static auto mkup = InlineMarkup(); +if (doc_matters.opt.action.debug_do) { + writeln(doc_matters.src.filename_base); + writeln("Title: ", doc_matters.conf_make_meta.meta.title_full); + writeln(" Author: ", doc_matters.conf_make_meta.meta.creator_author); + writeln(" Published: ", doc_matters.conf_make_meta.meta.date_published); + writeln(" Copyright: ", doc_matters.conf_make_meta.meta.rights_copyright); + writeln(" License: ", doc_matters.conf_make_meta.meta.rights_license); + if (doc_matters.conf_make_meta.meta.classify_topic_register_arr.length > 0) { + foreach (topic; doc_matters.conf_make_meta.meta.classify_topic_register_arr.sort!("toUpper(a) < toUpper(b)", SwapStrategy.unstable)) { + string[] subject_tree = topic.split(mkup.sep); + if (subject_tree.length > 0) { writeln(" ", subject_tree[0]); } + if (subject_tree.length > 1) { writeln(" ", subject_tree[1]); } + if (subject_tree.length > 2) { writeln(" ", subject_tree[2]); } + if (subject_tree.length > 3) { writeln(" ", subject_tree[3]); } + if (subject_tree.length > 4) { writeln(" ", subject_tree[4]); } + } + } +} +auto pth_html = spinePathsHTML!()(doc_matters.output_path, doc_matters.src.language); +auto pth_epub = spinePathsEPUB!()(doc_matters.output_path, doc_matters.src.language); +auto pth_pod = spinePathsPods!()(doc_matters); +metadata_ ~= format(q"┃ + + + +┃"); +if (doc_matters.opt.action.harvest_link) { + metadata_ ~= format(q"┃

[ HOME ] Metadata Harvest + [ Authors ] + [ Topics ]

+
+┃"); +} else { + metadata_ ~= format(q"┃

[ HOME ] +


+┃"); +} +if (!(doc_matters.conf_make_meta.meta.title_full.empty)) { + metadata_ ~= "

Title: " ~ doc_matters.conf_make_meta.meta.title_full ~ "

"; +} else if (doc_matters.opt.action.debug_do || doc_matters.opt.action.very_verbose) { + writeln("ERROR no Title information provided in document header ", doc_matters.src.filename_base); +} +if (!(doc_matters.conf_make_meta.meta.creator_author.empty)) { + if (doc_matters.opt.action.harvest_link) { + metadata_ ~= "

Author: " + ~ doc_matters.conf_make_meta.meta.creator_author ~ "

"; + } else { + metadata_ ~= "

Author: " + ~ doc_matters.conf_make_meta.meta.creator_author ~ "

"; + } +} else if (doc_matters.opt.action.debug_do || doc_matters.opt.action.very_verbose) { + writeln("ERROR no Author information provided in document header ", doc_matters.src.filename_base); +} +metadata_ ~= "

Published: " ~ doc_matters.conf_make_meta.meta.date_published ~ "

"; +if (!(doc_matters.conf_make_meta.meta.rights_copyright.empty)) { + metadata_ ~= "

Copyright: " ~ doc_matters.conf_make_meta.meta.rights_copyright ~ "

"; +} else if (doc_matters.opt.action.debug_do || doc_matters.opt.action.very_verbose) { + writeln("WARNING no Copyright information provided in document header ", doc_matters.src.filename_base); +} +if (!(doc_matters.conf_make_meta.meta.rights_license.empty)) { + metadata_ ~= "

License: " ~ doc_matters.conf_make_meta.meta.rights_license ~ "

"; +} else if (doc_matters.opt.action.debug_do || doc_matters.opt.action.very_verbose) { + writeln("WARNING no License information provided in document header ", doc_matters.src.filename_base); +} +if (!(doc_matters.conf_make_meta.meta.notes_summary.empty)) { + metadata_ ~= "

Summary:

" ~ doc_matters.conf_make_meta.meta.notes_summary ~ "

"; +} else if (doc_matters.opt.action.debug_do) { + writeln("WARNING no summary of text provided in document header ", doc_matters.src.filename_base); +} +if (doc_matters.conf_make_meta.meta.classify_topic_register_arr.length > 0) { + metadata_ ~= "

Topics:

"; + string[] _top = ["", "", "", "", ""]; + foreach (topic; doc_matters.conf_make_meta.meta.classify_topic_register_arr.sort!("toUpper(a) < toUpper(b)", SwapStrategy.unstable)) { + string[] subject_tree = topic.split(mkup.sep); + if (subject_tree.length > 0) { + if (subject_tree[0] != _top[0]) { + _top[0] = subject_tree[0]; + if (doc_matters.opt.action.harvest_link) { + metadata_ ~= + "

" + ~ subject_tree[0] + ~ "

"; + } else { + metadata_ ~= + "

" ~ subject_tree[0] ~ "

"; + } + } + if (subject_tree.length > 1) { + if (subject_tree[1] != _top[1]) { + _top[1] = subject_tree[1]; + _top[2] = ""; _top[3] = ""; _top[4] = ""; + if (doc_matters.opt.action.harvest_link) { + metadata_ ~= + "

" + ~ subject_tree[1] + ~ "

"; + } else { + metadata_ ~= + "

" ~ subject_tree[1] ~ "

"; + } + } + if (subject_tree.length > 2) { + if (subject_tree[2] != _top[2]) { + _top[2] = subject_tree[2]; + _top[3] = ""; _top[4] = ""; + if (doc_matters.opt.action.harvest_link) { + metadata_ ~= + "

" + ~ subject_tree[2] + ~ "

"; + } else { + metadata_ ~= + "

" ~ subject_tree[2] ~ "

"; + } + } + if (subject_tree.length > 3) { + if (subject_tree[3] != _top[3]) { + _top[3] = subject_tree[3]; + _top[4] = ""; + if (doc_matters.opt.action.harvest_link) { + metadata_ ~= + "

" + ~ subject_tree[3] + ~ "

"; + } else { + metadata_ ~= + "

" ~ subject_tree[3] ~ "

"; + } + } + if (subject_tree.length > 4) { + if (subject_tree[4] != _top[4]) { + _top[4] = subject_tree[4]; + if (doc_matters.opt.action.harvest_link) { + metadata_ ~= + "

" + ~ subject_tree[4] + ~ "

"; + } else { + metadata_ ~= + "

" ~ subject_tree[4] ~ "

"; + } + } + } + } + } + } + } + } +} else if (doc_matters.opt.action.debug_do) { + writeln("WARNING no topic_register classification of text provided in document header ", doc_matters.src.filename_base); +} +metadata_ ~= "

source: " ~ doc_matters.src.filename_base ~ "

"; +metadata_ ~= "

markup source: [" + ~ " zipped pod ] " + ~ "[" + ~ " pod tree ]

"; +metadata_ ~= "

outputs: [" + ~ " html scroll ] " + ~ "[" + ~ " html seg ]" + ~ "[" + ~ " epub ]

"; +metadata_write_output(doc_matters, metadata_); +#+END_SRC + +** metadata write output + +#+name: output_metadata_write +#+BEGIN_SRC d +void metadata_write_output(M)(M doc_matters, string[] metadata_) @trusted { + 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("metadata." ~ doc_matters.src.filename), "w"); + foreach (o; metadata_) { + f.writeln(o); + } + } catch (ErrnoException ex) { + // Handle error + } + if (!(doc_matters.opt.action.quiet)) { + writeln(" ", pth_html.fn_scroll("metadata." ~ doc_matters.src.filename)); + } +} +#+END_SRC + +*** themes +**** head + +#+NAME: harvested_html_themes +#+BEGIN_SRC d +string theme_dark_0 = format(q"┃ + body { + color : #CCCCCC; + background : #000000; + background-color : #000000; + } + a:link { + color : #FFFFFF; + text-decoration : none; + } + a:visited { + color : #999999; + text-decoration : none; + } + a:hover { + color : #000000; + background-color : #555555; + } + a:hover img { + background-color : #000000; + } + a:active { + color : #888888; + text-decoration : underline; + } +┃"); +string theme_light_0 = format(q"┃ + body { + color : #000000; + background : #FFFFFF; + background-color : #FFFFFF; + } + a:link { + color : #003399; + text-decoration : none; + } + a:visited { + color : #003399; + text-decoration : none; + } + a:hover { + color : #000000; + background-color : #f9f9aa; + } + a:hover img { + background-color : #FFFFFF; + } + a:active { + color : #003399; + text-decoration : underline; + } +┃"); +#+END_SRC + +**** levels + +#+NAME: harvested_html_themes +#+BEGIN_SRC d +string theme_dark_1 = format(q"┃ + h1 { + color : #FFFFFF; + background : #000000; + } + p.letter { + color : #FFFFFF; + background : #333333; + } +┃"); +string theme_light_1 = format(q"┃ + h1 { + color : #FFFFFF; + background : #000088; + } + p.letter { + color : #FFFFFF; + background : #880000; + } +┃"); +#+END_SRC + +*** harvested topics html head + +#+NAME: harvested_topics_html_head_1 +#+BEGIN_SRC d + metadata_ ~= format(q"┃ + + + +Metadata Harvest - Topics +#+END_SRC + +#+NAME: harvested_topics_html_head_2 +#+BEGIN_SRC d + +#+END_SRC + +*** harvested html head + +#+NAME: harvested_html_head +#+BEGIN_SRC d + + + + + + + + +#+END_SRC + +*** harvested html bottom + +#+NAME: harvested_html_bottom +#+BEGIN_SRC d + ~= format(q"┃ +
+ + + + + + + + +┃") ~ "\n"; +#+END_SRC + +*** harvested topics html head theme insert + +#+NAME: harvested_topics_html_head_theme +#+BEGIN_SRC d +┃", + doc_matters.opt.action.css_theme_default ? theme_light_0 : theme_dark_0, + doc_matters.opt.action.css_theme_default ? theme_light_1 : theme_dark_1, +) ~ "\n"; +#+END_SRC -- cgit v1.2.3