#+TITLE: sdp default paths
#+AUTHOR: Ralph Amissah
#+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]]
#+DESCRIPTION: documents - structuring, publishing in multiple formats & search
#+KEYWORDS
#+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
#+FILETAGS: :sdp:rel:path:file:
#+TAGS: assert(a) class(c) debug(d) mixin(m) sdp(s) tangle(T) template(t) WEB(W) noexport(n)
[[./sdp.org][sdp]] [[./][org/]]
* 0. source paths :module:sdp:paths_source:
** 0. module template
#+BEGIN_SRC d :tangle ../src/sdp/output/paths_source.d
/++
read configuration files
- read config files
meta_config_files.d
+/
module sdp.output.paths_source;
import std.array,
std.file,
std.path,
std.regex,
std.stdio,
std.conv : to;
import sdp.meta.rgx;
<>
<>
<>
<>
#+END_SRC
** _manifest_ :manifest:
#+name: template_paths_src
#+BEGIN_SRC d
template PodManifest() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
auto PodManifest(P)(
P _pth,
) {
struct ManifestFile_ {
auto pod_manifest_filename() {
string _manifest_file = "sisudoc.txt";
return _manifest_file;
}
auto pod_manifest_path() {
string _manifest_path;
if (isValidPath(_pth) && _pth.isDir
&& ((_pth.chainPath(pod_manifest_filename).array).isFile)) {
_manifest_path = _pth;
} else if (_pth.match(rgx.src_pth_contents)
&& (_pth.isFile)) {
_manifest_path = dirName(_pth);
} else {
// _manifest_path = "";
}
return _manifest_path;
}
auto pod_manifest_file_with_path() {
string _manifest_path_and_file = pod_manifest_path.chainPath(pod_manifest_filename).array;
return _manifest_path_and_file;
}
}
return ManifestFile_();
}
}
#+END_SRC
** _config_ :config:
#+name: template_paths_src
#+BEGIN_SRC d
template ConfigFilePaths() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
auto ConfigFilePaths(E)(
E _env,
) {
struct ConfFilePaths {
auto possible_config_path_locations() {
/+ FIX clean up conf paths ↓ +/
string _sisudoc_conf_pwd = chainPath(to!string(_env["pwd"]), "sisudoc/conf").array;
string _sisudoc_conf_pwd_a = chainPath(to!string(_env["pwd"]), "conf").array;
string _sisudoc_conf_pwd_b = chainPath(to!string(_env["pwd"]), "../conf").array;
string _sisudoc_conf_pwd_c = chainPath(to!string(_env["pwd"]), "../../conf").array;
string _sisudoc_conf_pwd_d = chainPath(to!string(_env["pwd"]), "../../../conf").array;
/+ FIX clean up conf paths ↑
(compare pwd to doc path location, and build config path)
+/
string _dot_pwd = chainPath(to!string(_env["pwd"]), ".sisu").array;
string _underscore_pwd = chainPath(to!string(_env["pwd"]), "_sisu").array;
string _dot_home = chainPath(to!string(_env["home"]), ".sisu").array;
string[] _possible_config_path_locations = [
_sisudoc_conf_pwd,
_sisudoc_conf_pwd_a,
_sisudoc_conf_pwd_b,
_sisudoc_conf_pwd_c,
_sisudoc_conf_pwd_d,
_dot_pwd,
_underscore_pwd,
_dot_home,
"/etc/sisu"
];
return _possible_config_path_locations;
}
}
return ConfFilePaths();
}
}
#+END_SRC
** _sisupod_ (including generated bundled source) :sisupod:
*** notes
tree sisupod
sisupod
└── sisudoc
├── conf
│ └── sisu_document_make
├── media
│ ├── audio
│ ├── image
│ ├── text
│ │ └── en
│ │ ...
│ │ ├── [conf]
│ │ └── [image]
│ └── video
└── sisudoc.txt
_replace:_
doc
├── en
│ └── the_wealth_of_networks.yochai_benkler.sst
└── _sisu
└── sisu_document_make
filelist for processing [things to ponder]
- the plan is to have a src manifest of related .sst or .ssm files that
can be pointed to for processing
- multilingual documents [ponder persistence for multilingual documents]
- in the case of multilingual documents, there will be multiple
source documents on list with different language codes, and to build
this list, persistence is required
- inserted documents (from master .ssm or .sst) must track document root
so inserts can be located, else not found
- consider a commandline -o --output path specifier
- steps
- auto create filelist
- for single source file
- for multilinugual source files
- process document by pointing at filelist (rather than file)
- if necessary manually create filelist (for multilinugual source)
- keep document root for document inserts (.ssi)
*** manual source
#+name: template_paths_src
#+BEGIN_SRC d
template SiSUpathsSRC() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
auto SiSUpathsSRC(D,Fn)(
D _pwd,
Fn _fn_src_and_relative_path,
) {
struct SisuSrcPaths {
auto pwd() {
return _pwd;
}
auto language() {
// use command line info as well?
string _k;
if (auto m = _fn_src_and_relative_path.match(rgx.language_code_and_filename)) {
_k = m.captures[1];
} else { /+ unknown until doc_meta read, (could provide & use command line info?) +/
_k = "xx"; // original default was "en" but is not known
}
return _k;
}
auto doc_root() {
return "sisudoc";
}
auto media_root() {
return doc_root.chainPath("media").array;
}
auto conf_root() {
return doc_root.chainPath("conf").array;
}
auto text_root() {
return media_root.chainPath("text").array;
}
auto image_root() {
return media_root.chainPath("image").array;
}
auto doc_src_fn_with_path_for_text_root_and_lng() {
return text_root.chainPath(language).array;
}
auto doc_src_with_relative_path() {
return pwd.chainPath(_fn_src_and_relative_path).array;
}
auto doc_src_fn() {
return _fn_src_and_relative_path.baseName.array;
}
}
return SisuSrcPaths();
}
}
#+END_SRC
*** pod archive base
#+name: template_paths_sisupod
#+BEGIN_SRC d
template SiSUpathsSisupod() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
string _base_dir_pod = "sisupod";
string _base_dir_doc = "sisudoc";
string _suffix = ".zip";
auto SiSUpathsSisupod()() {
struct _PathsStruct {
string base_filename(string fn_src) {
auto pth = fn_src.baseName.stripExtension;
return pth;
}
string sisupod_dir() {
auto pth = _base_dir_pod;
return pth;
}
string sisudoc_dir() {
auto pth = _base_dir_doc;
return pth;
}
string sisupod_filename(string fn_src) {
string pth = _base_dir_pod.chainPath(base_filename(fn_src) ~ _suffix).array;
return pth;
}
string base_filesystem(string fn_src) {
string pth = _base_dir_pod.chainPath(base_filename(fn_src)).array;
assert(pth == _base_dir_pod ~ "/" ~ base_filename(fn_src),
pth ~ " == " ~ _base_dir_pod ~ "/" ~ base_filename(fn_src) ~ "?");
return pth;
}
string base_pod(string fn_src) {
string pth = _base_dir_pod.chainPath(base_filename(fn_src)).array; // change this
return pth;
}
}
return _PathsStruct();
}
}
#+END_SRC
*** pods internal, zipped, unzipped
#+name: template_paths_sisupods
#+BEGIN_SRC d
template SiSUpathsSisupods() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
string _base_dir_pod = "sisupod";
string _base_dir_doc = "sisudoc";
string _suffix = ".zip";
auto SiSUpathsSisupods(Ps,Lng)(
Ps src_pth_info,
Lng lng,
) {
struct _PodPaths {
string base_filename_(string fn_src) {
auto pth = fn_src.baseName.stripExtension;
return pth;
}
string sisupod_dir_() {
auto pth = _base_dir_pod;
return pth;
}
string sisudoc_dir_() {
auto pth = _base_dir_doc;
return pth;
}
string sisupod_filename_(string fn_src) {
string pth = _base_dir_pod.chainPath(base_filename_(fn_src) ~ _suffix).array;
return pth;
}
string base_filesystem_(string fn_src) {
string pth = _base_dir_pod.chainPath(base_filename_(fn_src)).array;
assert(pth == _base_dir_pod ~ "/" ~ base_filename_(fn_src),
pth ~ " == " ~ _base_dir_pod ~ "/" ~ base_filename_(fn_src) ~ "?");
return pth;
}
string base_pod_(string fn_src) {
string pth = _base_dir_pod.chainPath(base_filename_(fn_src)).array; // change this
return pth;
}
auto base_filename(string fn_src) {
auto pth_1_ = base_filename_(fn_src);
auto pth_2_ = base_filename_(fn_src);
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
return pth_2_;
}
}
return _pods();
}
auto sisupod_filename(string fn_src) {
auto pth_1_ = sisupod_filename_(fn_src);
auto pth_2_ = sisupod_filename_(fn_src);
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
return pth_2_;
}
}
return _pods();
}
auto base(string fn_src) {
auto pth_1_ = "";
auto pth_2_ = base_filesystem_(fn_src);
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
return pth_2_;
}
}
return _pods();
}
auto pod_root(string fn_src) {
auto pth_1_ = "";
auto pth_2_ = base(fn_src).filesystem_open_zpod.chainPath("").array; // "sisudoc"
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
return pth_2_;
}
}
return _pods();
}
auto conf_root(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = "conf";
auto pth_2_ = pod_root(fn_src).filesystem_open_zpod.chainPath("conf").array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto css(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = conf_root(fn_src).zpod.chainPath("css").array;
auto pth_2_ = conf_root(fn_src).filesystem_open_zpod.chainPath("css").array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto media_root(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = "media";
auto pth_2_ = pod_root(fn_src).filesystem_open_zpod.chainPath("media").array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto text_root(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = media_root(fn_src).zpod.chainPath("text").array;
auto pth_2_ = media_root(fn_src).filesystem_open_zpod.chainPath("text").array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto doc(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = text_root(fn_src).zpod;
auto pth_2_ = text_root(fn_src).filesystem_open_zpod;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto doc_lng(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = text_root(fn_src).zpod.chainPath(lng).array;
auto pth_2_ = text_root(fn_src).filesystem_open_zpod.chainPath(lng).array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto image_root(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = media_root(fn_src).zpod.chainPath("image").array;
auto pth_2_ = media_root(fn_src).filesystem_open_zpod.chainPath("image").array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto fn_pod_filelist(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto _manifest = PodManifest!()(fn_src).pod_manifest_filename;
auto pth_1_ = _manifest;
auto pth_2_ = pod_root(fn_src).filesystem_open_zpod.chainPath(_manifest).array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto fn_doc(string fn_src) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = doc_lng(fn_src).zpod.chainPath(fn_src.baseName).array;
auto pth_2_ = doc_lng(fn_src).filesystem_open_zpod.chainPath(fn_src.baseName).array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
auto fn_doc_insert(string fn_src, string fn_insert) {
auto pod_root_ = pod_root(fn_src);
auto pth_1_ = doc_lng(fn_src).zpod.chainPath(fn_insert.baseName).array;
auto pth_2_ = doc_lng(fn_src).filesystem_open_zpod.chainPath(fn_insert.baseName).array;
struct _pods {
auto zpod() {
return pth_1_;
}
auto filesystem_open_zpod() {
assert(pod_root_.filesystem_open_zpod.chainPath(zpod).array == pth_2_);
return pth_2_;
}
}
return _pods();
}
}
return _PodPaths();
}
}
#+END_SRC
* 1. output paths :module:sdp:paths_output:
** 0. module template
#+BEGIN_SRC d :tangle ../src/sdp/output/paths_output.d
/++
default settings
+/
module sdp.output.paths_output;
import std.array,
std.path,
std.regex,
std.stdio;
import sdp.meta.rgx;
<>
<>
<>
<>
#+END_SRC
** shared out path, base directory :out:
#+name: template_paths_out
#+BEGIN_SRC d
template SiSUoutPaths() {
auto SiSUoutPaths(Ps,Lng)(
Ps src_pth_info,
Lng lng,
) {
struct _PathsStruct {
string output_root() {
return "sisugen";
}
string output_base() {
return output_root.chainPath(lng).array;
}
}
return _PathsStruct();
}
}
#+END_SRC
** _html_ :html:
#+name: template_paths_html
#+BEGIN_SRC d
template SiSUpathsHTML() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
auto SiSUpathsHTML(Ps,Lng)(
Ps src_pth_info,
Lng lng,
) {
auto out_pth = SiSUoutPaths!()(src_pth_info, lng);
string base_dir = "html";
string suffix = ".html";
struct _PathsStruct {
string base_filename(string fn_src) {
return fn_src.baseName.stripExtension;
}
string base() {
return (out_pth.output_base).chainPath(base_dir).array;
}
string image() {
return (out_pth.output_root).chainPath("image").array;
}
string css() {
return (out_pth.output_root).chainPath("css").array;
}
string fn_seg_css() {
return css.chainPath("html_seg.css").array;
}
string fn_scroll_css() {
return css.chainPath("html_scroll.css").array;
}
string seg(string fn_src) {
return base.chainPath(base_filename(fn_src)).array;
}
string fn_scroll(string fn_src) {
return base.chainPath(base_filename(fn_src) ~ suffix).array;
}
string fn_seg(string fn_src, string seg_filename) {
return seg(fn_src).chainPath(seg_filename ~ suffix).array;
}
}
return _PathsStruct();
}
}
#+END_SRC
** _epub_ :epub:
#+name: template_paths_epub
#+BEGIN_SRC d
template SiSUpathsEPUB() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
auto SiSUpathsEPUB(Ps,Lng)(
Ps src_pth_info,
Lng lng,
) {
auto out_pth = SiSUoutPaths!()(src_pth_info, lng);
string base_dir = "epub";
struct _PathsStruct {
string base() {
return (out_pth.output_base).chainPath(base_dir).array;
}
string base_filename(string fn_src) {
return fn_src.baseName.stripExtension;
}
string epub_file(string fn_src) {
return base.chainPath(base_filename(fn_src) ~ ".epub").array;
}
string dirtop() {
return "".chainPath("").array;
}
string doc_meta_inf(string fn_src) {
return dirtop.chainPath("META-INF").array;
}
string doc_oebps(string fn_src) {
return dirtop.chainPath("OEBPS").array;
}
string doc_oebps_css(string fn_src) {
return doc_oebps(fn_src).chainPath("css").array;
}
string doc_oebps_image(string fn_src) {
return doc_oebps(fn_src).chainPath("image").array;
}
string fn_mimetypes(string fn_src) {
return dirtop.chainPath("mimetypes").array;
}
string fn_dmi_container_xml(string fn_src) {
return doc_meta_inf(fn_src).chainPath("container.xml").array;
}
string fn_oebps_toc_nav_xhtml(string fn_src) {
return doc_oebps(fn_src).chainPath("toc_nav.xhtml").array;
}
string fn_oebps_toc_ncx(string fn_src) {
return doc_oebps(fn_src).chainPath("toc.ncx").array;
}
string fn_oebps_content_opf(string fn_src) {
return doc_oebps(fn_src).chainPath("content.opf").array;
}
string fn_oebps_content_xhtml(string fn_src, string seg_filename) {
return doc_oebps(fn_src).chainPath(seg_filename ~ ".xhtml").array;
}
string fn_oebps_css(string fn_src) {
return doc_oebps_css(fn_src).chainPath("epub.css").array;
}
debug(epub_output) {
string dbg_docdir(string fn_src) {
return base.chainPath(base_filename(fn_src)).array;
}
string dbg_docdir_oebps(string fn_src) {
return dbg_docdir(fn_src).chainPath("OEBPS").array;
}
string dbg_doc_meta_inf(string fn_src) {
return dbg_docdir(fn_src).chainPath("META-INF").array;
}
string dbg_doc_oebps(string fn_src) {
return dbg_docdir(fn_src).chainPath("OEBPS").array;
}
string dbg_doc_oebps_css(string fn_src) {
return dbg_doc_oebps(fn_src).chainPath("css").array;
}
string dbg_doc_oebps_image(string fn_src) {
return dbg_doc_oebps(fn_src).chainPath("image").array;
}
string dbg_fn_mimetypes(string fn_src) {
return dbg_docdir(fn_src).chainPath("mimetypes").array;
}
string dbg_fn_dmi_container_xml(string fn_src) {
return dbg_doc_meta_inf(fn_src).chainPath("container.xml").array;
}
string dbg_fn_oebps_toc_nav_xhtml(string fn_src) {
return dbg_docdir_oebps(fn_src).chainPath("toc_nav.xhtml").array;
}
string dbg_fn_oebps_toc_ncx(string fn_src) {
return dbg_docdir_oebps(fn_src).chainPath("toc.ncx").array;
}
string dbg_fn_oebps_content_opf(string fn_src) {
return dbg_docdir_oebps(fn_src).chainPath("content.opf").array;
}
string dbg_fn_oebps_content_xhtml(string fn_src, string seg_filename) {
return dbg_docdir_oebps(fn_src).chainPath(seg_filename ~ ".xhtml").array;
}
string dbg_fn_oebps_css(string fn_src) {
return dbg_doc_oebps_css(fn_src).chainPath("epub.css").array;
}
}
}
return _PathsStruct();
}
}
#+END_SRC
** _sqlite_ :sqlite:
*** discrete
#+name: template_paths_sqlite
#+BEGIN_SRC d
template SiSUpathsSQLiteDiscrete() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
auto SiSUpathsSQLiteDiscrete(Ps,Lng)(
Ps src_pth_info,
Lng lng,
) {
auto out_pth = SiSUoutPaths!()(src_pth_info, lng);
string base_dir = "sqlite";
struct _PathsStruct {
string base_filename(string fn_src) {
return fn_src.baseName.stripExtension;
}
string base() {
return (out_pth.output_base).chainPath(base_dir).array;
}
string seg(string fn_src) {
return base.chainPath(base_filename(fn_src)).array;
}
string sqlite_file(string fn_src) {
return base.chainPath(base_filename(fn_src) ~ ".sqlite").array;
}
}
return _PathsStruct();
}
}
#+END_SRC
*** TODO collection
#+name: template_paths_sqlite
#+BEGIN_SRC d
template SiSUpathsSQLite() {
mixin SiSUrgxInit;
static auto rgx = Rgx();
auto SiSUpathsSQLite(Ps,Lng)(
Ps src_pth_info,
Lng lng,
) {
auto out_pth = SiSUoutPaths!()(src_pth_info, lng);
string base_dir = "sqlite";
struct _PathsStruct {
string base_filename(string fn_src) {
return fn_src.baseName.stripExtension;
}
string base() {
return (out_pth.output_base).chainPath(base_dir).array;
}
string seg(string fn_src) {
return base.chainPath(base_filename(fn_src)).array;
}
string sqlite_file(string fn_src) {
return base.chainPath(base_filename(fn_src) ~ ".sqlite").array;
}
}
return _PathsStruct();
}
}
#+END_SRC