diff options
Diffstat (limited to 'org')
| -rw-r--r-- | org/default_paths.org | 56 | ||||
| -rw-r--r-- | org/default_regex.org | 6 | ||||
| -rw-r--r-- | org/doc_reform.org | 402 | ||||
| -rw-r--r-- | org/output_hub.org | 10 | ||||
| -rw-r--r-- | org/output_src_pod.org (renamed from org/output_sisupod.org) | 148 | ||||
| -rw-r--r-- | org/source_files_read.org | 10 |
6 files changed, 316 insertions, 316 deletions
diff --git a/org/default_paths.org b/org/default_paths.org index 806b0f7..5299e3d 100644 --- a/org/default_paths.org +++ b/org/default_paths.org @@ -32,9 +32,9 @@ import std.array, std.conv : to; import doc_reform.meta.rgx; <<template_paths_src>> -<<template_paths_sisupod>> -<<template_paths_sisupod_shallow>> -<<template_paths_sisupods>> +<<template_paths_pod>> +<<template_paths_pod_shallow>> +<<template_paths_pods>> #+END_SRC ** _manifest_ :manifest: @@ -49,7 +49,7 @@ template PodManifest() { ) { struct ManifestFile_ { string pod_manifest_filename() { - return "sisupod.manifest"; + return "pod.manifest"; } string pod_manifest_path() { string _manifest_path; @@ -92,8 +92,8 @@ template PodManifest() { ** _path matters (pod, manifest and source files)_ :manifest: -tree sisupod -sisupod +tree pod +pod └─ [sisudoc filename] ├── conf │ └── sisu_document_make @@ -106,7 +106,7 @@ sisupod │ │ ├── [conf] │ │ └── [image] │ └── video - └── sisupod.manifest + └── pod.manifest #+name: template_paths_src #+BEGIN_SRC d @@ -154,9 +154,9 @@ template PathMatters() { auto collection_root() { auto _collection_root = asNormalizedPath(chainPath(_manifest.pod_manifest_path, "..")).array; if (auto m = (_collection_root).match(rgx.src_pth_pod_root)) { - // consider testing for last dir in path name being sisupod, and giving warning if not + // consider testing for last dir in path name being pod, and giving warning if not } else { - writeln("WARNING, collection_root not named \"sisupod\""); + writeln("WARNING, collection_root not named \"pod\""); } return _collection_root; } @@ -269,7 +269,7 @@ template PathMatters() { filename ~ _sep ~ lng * unique per src pod used by - - sisupod (multilingual collection) + - pod (multilingual collection) - sqlite discrete index (multilingual collection) +/ string _fn; @@ -295,7 +295,7 @@ template PathMatters() { string _dir; if ( auto m = (absolute_path_to_src) - .match(regex(r"[/](?P<dir>(?:[a-zA-Z0-9._-]+))/sisupod/" ~ filename.stripExtension)) + .match(regex(r"[/](?P<dir>(?:[a-zA-Z0-9._-]+))/pod/" ~ filename.stripExtension)) ) { _dir = asNormalizedPath(path_and_fn.chainPath("../../")).array; assert(_dir == m.captures["dir"]); @@ -313,7 +313,7 @@ template PathMatters() { string _dir; if ( auto m = (absolute_path_to_src) - .match(regex(r"[/](?P<dir>(?:[a-zA-Z0-9._-]+))/sisupod/" ~ filename.stripExtension)) + .match(regex(r"[/](?P<dir>(?:[a-zA-Z0-9._-]+))/pod/" ~ filename.stripExtension)) ) { _dir = asNormalizedPath(path_and_fn.chainPath("../../")).array; } else { @@ -330,7 +330,7 @@ template PathMatters() { _dir = asNormalizedPath(m.captures["pth"]).array; } else if ( auto m = (absolute_path_to_src) - .match(regex(r"[/](?P<dir>(?:[a-zA-Z0-9._-]+))/sisupod/" ~ filename.stripExtension)) + .match(regex(r"[/](?P<dir>(?:[a-zA-Z0-9._-]+))/pod/" ~ filename.stripExtension)) ) { _dir = asNormalizedPath(path_and_fn.chainPath("../")).array; } else { @@ -376,7 +376,7 @@ template PathMatters() { string _dir; if ( auto m = (absolute_path_to_src) - .match(regex(r"[/](?P<dir>(?:[a-zA-Z0-9._-]+))/sisupod/" ~ filename.stripExtension)) + .match(regex(r"[/](?P<dir>(?:[a-zA-Z0-9._-]+))/pod/" ~ filename.stripExtension)) ) { _dir = m.captures["dir"]; } else { @@ -551,11 +551,11 @@ template ConfigFilePaths() { } #+END_SRC -** _sisupod_ (including generated bundled source) :sisupod: +** _pod_ (including generated bundled source) :pod: *** notes -tree sisupod -sisupod +tree pod +pod └── sisudoc ├── conf │ └── sisu_document_make @@ -568,7 +568,7 @@ sisupod │ │ ├── [conf] │ │ └── [image] │ └── video - └── sisupod.manifest + └── pod.manifest _replace:_ @@ -654,23 +654,23 @@ template DocReformPathsSRC() { *** pods internal, zipped, unzipped -#+name: template_paths_sisupods +#+name: template_paths_pods #+BEGIN_SRC d -template DocReformPathsSisupods() { +template DocReformPathsPods() { mixin DocReformRgxInit; static auto rgx = Rgx(); string _suffix = ".zip"; - auto DocReformPathsSisupods(Dm)(Dm doc_matters) { + auto DocReformPathsPods(Dm)(Dm doc_matters) { string _base_dir_pod = (doc_matters.output_path.length > 0) - ? doc_matters.output_path ~ "/sisupod" - : "/sisupod"; + ? doc_matters.output_path ~ "/pod" + : "/pod"; string _base_dir_doc = "sisudoc"; struct _PodPaths { string base_filename_(string fn_src) { auto pth = fn_src.baseName.stripExtension; return pth; } - string sisupod_dir_() { + string pod_dir_() { auto pth = _base_dir_pod; return pth; } @@ -678,7 +678,7 @@ template DocReformPathsSisupods() { auto pth = _base_dir_doc; return pth; } - string sisupod_filename_(string fn_src) { + string pod_filename_(string fn_src) { string pth = _base_dir_pod.chainPath(base_filename_(fn_src) ~ _suffix).array; return pth; } @@ -705,9 +705,9 @@ template DocReformPathsSisupods() { } return _pods(); } - auto sisupod_filename(string fn_src) { - auto pth_1_ = sisupod_filename_(fn_src); - auto pth_2_ = sisupod_filename_(fn_src); + auto pod_filename(string fn_src) { + auto pth_1_ = pod_filename_(fn_src); + auto pth_2_ = pod_filename_(fn_src); struct _pods { auto zpod() { return pth_1_; diff --git a/org/default_regex.org b/org/default_regex.org index 02f5c0d..c41b962 100644 --- a/org/default_regex.org +++ b/org/default_regex.org @@ -430,12 +430,12 @@ static special_markup_chars = ctRegex!(`[【】〖〗 #+BEGIN_SRC d static src_pth_sst_or_ssm = ctRegex!(`^(?P<path>[/]?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9._-]+[.](?P<extension>ss[tm]))$`); static src_pth_pod_sst_or_ssm = ctRegex!(`^(?P<podpath>[/]?(?:[a-zA-Z0-9._-]+/)*)media/text/[a-z]{2}/(?P<filename>[a-zA-Z0-9._-]+[.]ss[tm])$`); -static src_pth_contents = ctRegex!(`^(?P<path>[/]?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9._-]+)/sisupod[.]manifest$`); -static src_pth_pod_root = ctRegex!(`^(?P<podroot>(?:[/]?(?:[a-zA-Z0-9._-]+/)*)(sisupod))$`); +static src_pth_contents = ctRegex!(`^(?P<path>[/]?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9._-]+)/pod[.]manifest$`); +static src_pth_pod_root = ctRegex!(`^(?P<podroot>(?:[/]?(?:[a-zA-Z0-9._-]+/)*)(pod))$`); static src_pth_zip = ctRegex!(`^(?P<path>[/]?(?:[a-zA-Z0-9._-]+/)*)(?P<filename>[a-zA-Z0-9._-]+[.]zip)$`); static src_pth_unzip_pod = ctRegex!(`^(?P<path>media/text/[a-z]{2}/)*(?P<filename>[a-zA-Z0-9._-]+[.]ss[im])$`); static src_pth_types = - ctRegex!(`^(?P<path>[/]?[a-zA-Z0-9._-]+/)*(?P<gotfile>(?P<filename>[a-zA-Z0-9._-]+[.]ss[tm])|(?P<filelist>[a-zA-Z0-9._-]+/sisupod[.]manifest)|(?P<filezip>[a-zA-Z0-9._-]+[.]zip))$`); + ctRegex!(`^(?P<path>[/]?[a-zA-Z0-9._-]+/)*(?P<gotfile>(?P<filename>[a-zA-Z0-9._-]+[.]ss[tm])|(?P<filelist>[a-zA-Z0-9._-]+/pod[.]manifest)|(?P<filezip>[a-zA-Z0-9._-]+[.]zip))$`); static pod_content_location = ctRegex!(`^(?P<filename>[a-zA-Z0-9._-]+[.]ss[tm])(?P<languages>(?:\s+[a-z]{2}(?:,|$))+)`, "mg"); static src_fn = diff --git a/org/doc_reform.org b/org/doc_reform.org index 77b8b24..e98cdc5 100644 --- a/org/doc_reform.org +++ b/org/doc_reform.org @@ -24,7 +24,7 @@ struct Version { int minor; int patch; } -enum ver = Version(0, 1, 0); +enum ver = Version(0, 2, 0); #+END_SRC ** compilation restrictions (supported compilers) @@ -256,7 +256,7 @@ bool[string] opts = [ "parallelise" : true, "parallelise-subprocesses" : false, "quiet" : false, - "sisupod" : false, + "pod" : false, "source" : false, "sqlite-discrete" : false, "sqlite-db-create" : false, @@ -301,7 +301,7 @@ auto helpInfo = getopt(args, "parallelise", "--parallelise parallelisation", &opts["parallelise"], "parallelise-subprocesses", "--parallelise-subprocesses nested parallelisation", &opts["parallelise-subprocesses"], "quiet", "--quiet output to terminal", &opts["quiet"], - "sisupod", "--sisupod sisupod source content bundled", &opts["sisupod"], + "pod", "--pod doc reform pod source content bundled", &opts["pod"], "source", "--source markup source text content", &opts["source"], "sqlite-discrete", "--sqlite process discrete sqlite output", &opts["sqlite-discrete"], "sqlite-db-create", "--sqlite-db-create create db, create tables", &opts["sqlite-db-create"], @@ -339,7 +339,7 @@ if (helpInfo.helpWanted) { #+NAME: doc_reform_args #+BEGIN_SRC d -enum outTask { sisupod, source, sqlite, sqlite_multi, epub, html_scroll, html_seg, html_stuff } +enum outTask { pod, source, sqlite, sqlite_multi, epub, html_scroll, html_seg, html_stuff } struct OptActions { auto assertions() { return opts["assertions"]; @@ -403,8 +403,8 @@ struct OptActions { auto quiet() { return opts["quiet"]; } - auto sisupod() { - return opts["sisupod"]; + auto pod() { + return opts["pod"]; } auto source() { return opts["source"]; @@ -518,8 +518,8 @@ struct OptActions { } auto output_task_scheduler() { int[] schedule; - if (sisupod) { - schedule ~= outTask.sisupod; + if (pod) { + schedule ~= outTask.pod; } if (source) { schedule ~= outTask.source; @@ -548,7 +548,7 @@ struct OptActions { || epub || html || manifest - || sisupod + || pod || source || sqlite_discrete || sqlite_delete @@ -1171,21 +1171,21 @@ dev notes ** doc_reform glossary / terms -|------+-------------------------------------| -| doc_reform | sisu document parser | -|------+-------------------------------------| -| dmso | document markup, structure, objects | -|------+-------------------------------------| -| meta | meta document, document abstraction | -| mda | meta, meta document abstraction | -| adr | abstract document representation | -| dar | document abstract representation | -| (da) | (document abstraction) | -| | (code representation of document) | -|------+-------------------------------------| -| ao | abstract objects | -| | (code representation of objects) | -|------+-------------------------------------| +|------------+-------------------------------------| +| doc_reform | sisu document parser | +|------------+-------------------------------------| +| dmso | document markup, structure, objects | +|------------+-------------------------------------| +| meta | meta document, document abstraction | +| mda | meta, meta document abstraction | +| adr | abstract document representation | +| dar | document abstract representation | +| (da) | (document abstraction) | +| | (code representation of document) | +|------------+-------------------------------------| +| ao | abstract objects | +| | (code representation of objects) | +|------------+-------------------------------------| consider |-------+----------------------------------------------| @@ -1386,180 +1386,180 @@ provide the result as a single set of make instructions for each document parsed *** config & metadata (from instruction sources) -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | 1. document make file | 2. config file | 3. document header | 4. command line instruction | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| comment, fixed: | per dir (sisupod) | per dir | per document (sisupod) | per command instruction | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | sdl_root_config_document | sdl_root_config_local_site | | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| local site specific | | * | | *? | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | webserv | | | -| | | - url_root | | | -| | | - path | | | -| | | - images | | | -| | | - cgi | | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | webserv_cgi | | | -| | | - host | | | -| | | - base_path | | | -| | | - port | | | -| | | - user | | | -| | | - file_links | | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | processing | | | -| | | - path | | | -| | | - dir | | | -| | | - concord_max | | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | flag (configure) | | (call) | -| | | - act0 | | act0 | -| | | - act1 | | act1 | -| | | - act2 | | act2 | -| | | - act3 | | act3 | -| | | - act4 | | act4 | -| | | - act5 | | act5 | -| | | - act6 | | act6 | -| | | - act7 | | act7 | -| | | - act8 | | act8 | -| | | - act9 | | act9 | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | default | | | -| | | - papersize | | | -| | | - text_wrap | | | -| | | - emphasis | | | -| | | - language | | | -| | | - digest | | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | permission | | | -| | | - share_source | | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | program_select | | | -| | | - editor | | | -| | | - epub_viewer | | | -| | | - html_viewer | | | -| | | - odf_viewer | | | -| | | - pdf_viewer | | | -| | | - xml_viewer | | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | search | | | -| | | - flag | | | -| | | - action | | | -| | | - db | | | -| | | - title | | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| make instruction | ** | omit or override share? | ** | *? | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | make | make | make | | -| | - bold | - bold | - bold | | -| | - breaks | - breaks | - breaks | | -| | - cover_image | - cover_image | - cover_image | | -| | - css | - css | - css | | -| | - emphasis | - emphasis | - emphasis | | -| | - footer | - footer | - footer | | -| | - headings | - headings | - headings | | -| | - home_button_image | - home_button_image | - home_button_image | | -| | - home_button_text | - home_button_text | - home_button_text | | -| | - italics | - italics | - italics | | -| | - num_top | - num_top | - num_top | | -| | - auto_num_depth | - auto_num_depth | - auto_num_depth | | -| | - substitute | - substitute | - substitute | | -| | - texpdf_font | - texpdf_font | - texpdf_font | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| actions | | | | * | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | | assertions | -| | | | | concordance | -| | | | | debug | -| | | | | digest | -| | | | | docbook | -| | | | | epub | -| | | | | html | -| | | | | html-seg | -| | | | | html-scroll | -| | | | | manifest | -| | | | | ocn | -| | | | | odt | -| | | | | pdf | -| | | | | postgresql | -| | | | | qrcode | -| | | | | sisupod | -| | | | | source | -| | | | | sqlite | -| | | | | sqlite-db-create | -| | | | | sqlite-db-drop | -| | | | | text | -| | | | | verbose | -| | | | | xhtml | -| | | | | xml-dom | -| | | | | xml-sax | -| | | | | section_toc | -| | | | | section_body | -| | | | | section_endnotes | -| | | | | section_glossary | -| | | | | section_biblio | -| | | | | section_bookindex | -| | | | | section_blurb | -| | | | | backmatter | -| | | | | skip-output | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| metadata | | | * | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | classify | | -| | | | - dewey | | -| | | | - keywords | | -| | | | - loc | | -| | | | - subject | | -| | | | - topic_register | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | creator | | -| | | | - author | | -| | | | - author_email | | -| | | | - illustrator | | -| | | | - translator | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | date | | -| | | | - added_to_site | | -| | | | - available | | -| | | | - created | | -| | | | - issued | | -| | | | - modified | | -| | | | - published | | -| | | | - valid | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | identifier | | -| | | | - isbn | | -| | | | - oclc | | -| | | | - pg | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | links | | -| | | | - link | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | notes | | -| | | | - abstract | | -| | | | - description | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | original | | -| | | | - language | | -| | | | - source | | -| | | | - title | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | publisher | | -| | | | - name | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | rights | | -| | | | - copyright | | -| | | | - cover | | -| | | | - illustrations | | -| | | | - license | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| -| | | | title | | -| | | | - edition | | -| | | | - full | | -| | | | - language | | -| | | | - main | | -| | | | - note | | -| | | | - sub | | -| | | | - subtitle | | -|---------------------+--------------------------+----------------------------+------------------------+-----------------------------| +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | 1. document make file | 2. config file | 3. document header | 4. command line instruction | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| comment, fixed: | per dir (pod) | per dir | per document (pod) | per command instruction | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | sdl_root_config_document | sdl_root_config_local_site | | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| local site specific | | * | | *? | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | webserv | | | +| | | - url_root | | | +| | | - path | | | +| | | - images | | | +| | | - cgi | | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | webserv_cgi | | | +| | | - host | | | +| | | - base_path | | | +| | | - port | | | +| | | - user | | | +| | | - file_links | | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | processing | | | +| | | - path | | | +| | | - dir | | | +| | | - concord_max | | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | flag (configure) | | (call) | +| | | - act0 | | act0 | +| | | - act1 | | act1 | +| | | - act2 | | act2 | +| | | - act3 | | act3 | +| | | - act4 | | act4 | +| | | - act5 | | act5 | +| | | - act6 | | act6 | +| | | - act7 | | act7 | +| | | - act8 | | act8 | +| | | - act9 | | act9 | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | default | | | +| | | - papersize | | | +| | | - text_wrap | | | +| | | - emphasis | | | +| | | - language | | | +| | | - digest | | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | permission | | | +| | | - share_source | | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | program_select | | | +| | | - editor | | | +| | | - epub_viewer | | | +| | | - html_viewer | | | +| | | - odf_viewer | | | +| | | - pdf_viewer | | | +| | | - xml_viewer | | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | search | | | +| | | - flag | | | +| | | - action | | | +| | | - db | | | +| | | - title | | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| make instruction | ** | omit or override share? | ** | *? | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | make | make | make | | +| | - bold | - bold | - bold | | +| | - breaks | - breaks | - breaks | | +| | - cover_image | - cover_image | - cover_image | | +| | - css | - css | - css | | +| | - emphasis | - emphasis | - emphasis | | +| | - footer | - footer | - footer | | +| | - headings | - headings | - headings | | +| | - home_button_image | - home_button_image | - home_button_image | | +| | - home_button_text | - home_button_text | - home_button_text | | +| | - italics | - italics | - italics | | +| | - num_top | - num_top | - num_top | | +| | - auto_num_depth | - auto_num_depth | - auto_num_depth | | +| | - substitute | - substitute | - substitute | | +| | - texpdf_font | - texpdf_font | - texpdf_font | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| actions | | | | * | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | | assertions | +| | | | | concordance | +| | | | | debug | +| | | | | digest | +| | | | | docbook | +| | | | | epub | +| | | | | html | +| | | | | html-seg | +| | | | | html-scroll | +| | | | | manifest | +| | | | | ocn | +| | | | | odt | +| | | | | pdf | +| | | | | postgresql | +| | | | | qrcode | +| | | | | pod | +| | | | | source | +| | | | | sqlite | +| | | | | sqlite-db-create | +| | | | | sqlite-db-drop | +| | | | | text | +| | | | | verbose | +| | | | | xhtml | +| | | | | xml-dom | +| | | | | xml-sax | +| | | | | section_toc | +| | | | | section_body | +| | | | | section_endnotes | +| | | | | section_glossary | +| | | | | section_biblio | +| | | | | section_bookindex | +| | | | | section_blurb | +| | | | | backmatter | +| | | | | skip-output | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| metadata | | | * | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | classify | | +| | | | - dewey | | +| | | | - keywords | | +| | | | - loc | | +| | | | - subject | | +| | | | - topic_register | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | creator | | +| | | | - author | | +| | | | - author_email | | +| | | | - illustrator | | +| | | | - translator | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | date | | +| | | | - added_to_site | | +| | | | - available | | +| | | | - created | | +| | | | - issued | | +| | | | - modified | | +| | | | - published | | +| | | | - valid | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | identifier | | +| | | | - isbn | | +| | | | - oclc | | +| | | | - pg | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | links | | +| | | | - link | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | notes | | +| | | | - abstract | | +| | | | - description | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | original | | +| | | | - language | | +| | | | - source | | +| | | | - title | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | publisher | | +| | | | - name | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | rights | | +| | | | - copyright | | +| | | | - cover | | +| | | | - illustrations | | +| | | | - license | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| +| | | | title | | +| | | | - edition | | +| | | | - full | | +| | | | - language | | +| | | | - main | | +| | | | - note | | +| | | | - sub | | +| | | | - subtitle | | +|---------------------+--------------------------+----------------------------+---------------------+-----------------------------| diff --git a/org/output_hub.org b/org/output_hub.org index 24095b3..4d9c320 100644 --- a/org/output_hub.org +++ b/org/output_hub.org @@ -32,7 +32,7 @@ template outputHub() { mixin Msg; auto msg = Msg!()(doc_matters); static auto rgx = Rgx(); - enum outTask { sisupod, source, sqlite, sqlite_multi, epub, html_scroll, html_seg, html_stuff } + enum outTask { pod, source, sqlite, sqlite_multi, epub, html_scroll, html_seg, html_stuff } void Scheduled(D,I)(int sched, D doc_abstraction, I doc_matters) { auto msg = Msg!()(doc_matters); <<output_scheduled_task>> @@ -68,14 +68,14 @@ import doc_reform.output, doc_reform.output.html, doc_reform.output.sqlite, doc_reform.output.xmls, - doc_reform.output.source_sisupod, + doc_reform.output.source_pod, doc_reform.output.create_zip_file, doc_reform.output.paths_output; #+END_SRC #+name: output_scheduled_task #+BEGIN_SRC d -if (sched == outTask.sisupod) { +if (sched == outTask.pod) { msg.v("sisu source processing... "); DocReformPod!()(doc_matters); msg.vv("sisu source done"); @@ -110,8 +110,8 @@ if (sched == outTask.html_stuff) { ** output options *** verbose -*** output source: _sisusrc_ &/or _sisupod_ -- [[./output_sisupod.org][output_sisupod]] +*** output source: _sisusrc_ &/or _pod_ +- [[./output_pod.org][output_pod]] **** collection ***** update / populate diff --git a/org/output_sisupod.org b/org/output_src_pod.org index 9d6abe0..ee0925a 100644 --- a/org/output_sisupod.org +++ b/org/output_src_pod.org @@ -1,6 +1,6 @@ -#+TITLE: doc_reform output sisupod +#+TITLE: doc_reform output pod #+DESCRIPTION: documents - structuring, publishing in multiple formats & search -#+FILETAGS: :doc_reform:output:sisupod: +#+FILETAGS: :doc_reform:output:pod: #+AUTHOR: Ralph Amissah #+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]] #+LANGUAGE: en @@ -16,19 +16,19 @@ - [[./doc_reform.org][doc_reform]] [[./][org/]] - [[./output_hub.org][output_hub]] -* sisupod :module:doc_reform:source_sisupod: +* pod :module:doc_reform:source_pod: ** module template -#+BEGIN_SRC d :tangle ../src/doc_reform/output/source_sisupod.d -module doc_reform.output.source_sisupod; +#+BEGIN_SRC d :tangle ../src/doc_reform/output/source_pod.d +module doc_reform.output.source_pod; template DocReformPod() { <<output_imports>> void DocReformPod(T)(T doc_matters) { - <<source_sisupod_init>> + <<source_pod_init>> try { - <<source_sisupod_mkdirs>> - <<source_sisupod_copy>> - <<source_sisupod_zip>> + <<source_pod_mkdirs>> + <<source_pod_copy>> + <<source_pod_zip>> } catch (ErrnoException ex) { // Handle error @@ -55,7 +55,7 @@ import ** mkdir -#+name: source_sisupod_init +#+name: source_pod_init #+BEGIN_SRC d debug(asserts) { // static assert(is(typeof(doc_matters) == tuple)); @@ -64,68 +64,68 @@ mixin DocReformOutputRgxInit; string pwd = doc_matters.env.pwd; auto src_path_info = doc_matters.src_path_info; auto pth_sisudoc_src = doc_matters.src_path_info; -auto pths_sisupod = DocReformPathsSisupods!()(doc_matters); +auto pths_pod = DocReformPathsPods!()(doc_matters); mixin DocReformLanguageCodes; auto lang = Lang(); static auto rgx = Rgx(); assert (doc_matters.src.filename.match(rgx.src_fn)); #+END_SRC -#+name: source_sisupod_mkdirs +#+name: source_pod_mkdirs #+BEGIN_SRC d /+ create directory structure +/ -if (!exists(pths_sisupod.sisupod_dir_())) { - // used both by sisupod zipped (& sisupod filesystem (unzipped) which makes its own recursive dirs) - pths_sisupod.sisupod_dir_().mkdirRecurse; +if (!exists(pths_pod.pod_dir_())) { + // used both by pod zipped (& pod filesystem (unzipped) which makes its own recursive dirs) + pths_pod.pod_dir_().mkdirRecurse; } if (doc_matters.opt.action.source) { - if (!exists(pths_sisupod.text_root(doc_matters.src.filename).filesystem_open_zpod)) { - pths_sisupod.text_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; + if (!exists(pths_pod.text_root(doc_matters.src.filename).filesystem_open_zpod)) { + pths_pod.text_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } - if (!exists(pths_sisupod.conf_root(doc_matters.src.filename).filesystem_open_zpod)) { - pths_sisupod.conf_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; + if (!exists(pths_pod.conf_root(doc_matters.src.filename).filesystem_open_zpod)) { + pths_pod.conf_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } - if (!exists(pths_sisupod.media_root(doc_matters.src.filename).filesystem_open_zpod)) { - pths_sisupod.media_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; + if (!exists(pths_pod.media_root(doc_matters.src.filename).filesystem_open_zpod)) { + pths_pod.media_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } - if (!exists(pths_sisupod.css(doc_matters.src.filename).filesystem_open_zpod)) { - pths_sisupod.css(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; + if (!exists(pths_pod.css(doc_matters.src.filename).filesystem_open_zpod)) { + pths_pod.css(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } - if (!exists(pths_sisupod.image_root(doc_matters.src.filename).filesystem_open_zpod)) { - pths_sisupod.image_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; + if (!exists(pths_pod.image_root(doc_matters.src.filename).filesystem_open_zpod)) { + pths_pod.image_root(doc_matters.src.filename).filesystem_open_zpod.mkdirRecurse; } - if (!exists(pths_sisupod.doc_lng(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod)) { - pths_sisupod.doc_lng(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod.mkdirRecurse; + if (!exists(pths_pod.doc_lng(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod)) { + pths_pod.doc_lng(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod.mkdirRecurse; } } #+END_SRC ** copy -#+name: source_sisupod_copy +#+name: source_pod_copy #+BEGIN_SRC d -debug(sisupod) { +debug(pod) { writeln(__LINE__, ": ", doc_matters.src.filename, " -> ", - pths_sisupod.fn_doc(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod + pths_pod.fn_doc(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod ); } auto zip = new ZipArchive(); -auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; +auto fn_pod = pths_pod.pod_filename(doc_matters.src.filename).zpod; { /+ bundle images +/ foreach (image; doc_matters.srcs.image_list) { - debug(sisupodimages) { + debug(podimages) { writeln( pth_sisudoc_src.image_root.to!string, "/", image, " -> ", - pths_sisupod.image_root(doc_matters.src.filename).zpod, "/", image + pths_pod.image_root(doc_matters.src.filename).zpod, "/", image ); } auto fn_src_in = doc_matters.src.image_dir_path ~ "/" ~ image; - auto fn_src_out_sisupod_zip_base - = pths_sisupod.image_root(doc_matters.src.filename).zpod.to!string + auto fn_src_out_pod_zip_base + = pths_pod.image_root(doc_matters.src.filename).zpod.to!string ~ "/" ~ image; auto fn_src_out_filesystem - = pths_sisupod.image_root(doc_matters.src.filename).filesystem_open_zpod.to!string + = pths_pod.image_root(doc_matters.src.filename).filesystem_open_zpod.to!string ~ "/" ~ image; if (exists(fn_src_in)) { debug(io) { @@ -134,9 +134,9 @@ auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; if (doc_matters.opt.action.source) { fn_src_in.copy(fn_src_out_filesystem); } - if (doc_matters.opt.action.sisupod) { + if (doc_matters.opt.action.pod) { auto zip_arc_member_file = new ArchiveMember(); - zip_arc_member_file.name = fn_src_out_sisupod_zip_base; + zip_arc_member_file.name = fn_src_out_pod_zip_base; auto zip_data = new OutBuffer(); zip_data.write(cast(char[]) ((fn_src_in).read)); zip_arc_member_file.expandedData = zip_data.toBytes(); @@ -153,10 +153,10 @@ auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; ? doc_matters.src.conf_dir_path : pth_sisudoc_src.conf_root).to!string ~ "/" ~ "sisu_document_make"; - auto fn_src_out_sisupod_zip_base - = pths_sisupod.conf_root(doc_matters.src.filename).zpod.to!string ~ "/" ~ "sisu_document_make"; + auto fn_src_out_pod_zip_base + = pths_pod.conf_root(doc_matters.src.filename).zpod.to!string ~ "/" ~ "sisu_document_make"; auto fn_src_out_filesystem - = pths_sisupod.conf_root(doc_matters.src.filename).filesystem_open_zpod.to!string + = pths_pod.conf_root(doc_matters.src.filename).filesystem_open_zpod.to!string ~ "/" ~ "sisu_document_make"; if (exists(fn_src_in)) { debug(io) { @@ -165,9 +165,9 @@ auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; if (doc_matters.opt.action.source) { fn_src_in.copy(fn_src_out_filesystem); } - if (doc_matters.opt.action.sisupod) { + if (doc_matters.opt.action.pod) { auto zip_arc_member_file = new ArchiveMember(); - zip_arc_member_file.name = fn_src_out_sisupod_zip_base; + zip_arc_member_file.name = fn_src_out_pod_zip_base; auto zip_data = new OutBuffer(); zip_data.write((fn_src_in).readText); zip_arc_member_file.expandedData = zip_data.toBytes(); @@ -181,31 +181,31 @@ auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; } } { /+ bundle primary file +/ auto fn_src_in = doc_matters.src.file_with_absolute_path.to!string; - auto fn_src_out_sisupod_zip_base - = pths_sisupod.fn_doc(doc_matters.src.filename, doc_matters.src.language).zpod.to!string; + auto fn_src_out_pod_zip_base + = pths_pod.fn_doc(doc_matters.src.filename, doc_matters.src.language).zpod.to!string; auto fn_src_out_filesystem - = pths_sisupod.fn_doc(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod.to!string; // without root path: + = pths_pod.fn_doc(doc_matters.src.filename, doc_matters.src.language).filesystem_open_zpod.to!string; // without root path: auto fn_src_out_inside_pod - = pths_sisupod.fn_doc(doc_matters.src.filename, doc_matters.src.language).zpod.to!string; // without root path: - string[] filelist_src_out_sisupod_arr; + = pths_pod.fn_doc(doc_matters.src.filename, doc_matters.src.language).zpod.to!string; // without root path: + string[] filelist_src_out_pod_arr; string[] filelist_src_zpod_arr; if (exists(fn_src_in)) { debug(io) { writeln("(io debug) src in found: ", fn_src_in); } - filelist_src_out_sisupod_arr ~= fn_src_out_sisupod_zip_base; + filelist_src_out_pod_arr ~= fn_src_out_pod_zip_base; filelist_src_zpod_arr ~= fn_src_out_inside_pod; if (doc_matters.opt.action.source) { auto filelist - = File(pths_sisupod.fn_pod_filelist(doc_matters.src.filename).filesystem_open_zpod, "w"); + = File(pths_pod.fn_pod_filelist(doc_matters.src.filename).filesystem_open_zpod, "w"); foreach (source_pth_and_fn; filelist_src_zpod_arr) { filelist.writeln(source_pth_and_fn); } fn_src_in.copy(fn_src_out_filesystem); } - if (doc_matters.opt.action.sisupod) { + if (doc_matters.opt.action.pod) { auto zip_arc_member_file = new ArchiveMember(); - zip_arc_member_file.name = fn_src_out_sisupod_zip_base; + zip_arc_member_file.name = fn_src_out_pod_zip_base; auto zip_data = new OutBuffer(); zip_data.write((fn_src_in).readText); zip_arc_member_file.expandedData = zip_data.toBytes(); @@ -220,10 +220,10 @@ auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; } { /+ bundle insert files +/ if (doc_matters.srcs.file_insert_list.length > 0) { foreach (insert_file; doc_matters.srcs.file_insert_list) { - debug(sisupod) { + debug(pod) { writeln( insert_file, " -> ", - pths_sisupod.fn_doc_insert( + pths_pod.fn_doc_insert( doc_matters.src.filename, insert_file, doc_matters.src.language, @@ -231,14 +231,14 @@ auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; ); } auto fn_src_in = insert_file; - auto fn_src_out_sisupod_zip_base - = pths_sisupod.fn_doc_insert( + auto fn_src_out_pod_zip_base + = pths_pod.fn_doc_insert( doc_matters.src.filename, insert_file, doc_matters.src.language, ).zpod.to!string; auto fn_src_out_filesystem - = pths_sisupod.fn_doc_insert( + = pths_pod.fn_doc_insert( doc_matters.src.filename, insert_file, doc_matters.src.language, @@ -250,14 +250,14 @@ auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; if (doc_matters.opt.action.source) { fn_src_in.copy(fn_src_out_filesystem); } - if (doc_matters.opt.action.sisupod) { + if (doc_matters.opt.action.pod) { auto zip_arc_member_file = new ArchiveMember(); - zip_arc_member_file.name = fn_src_out_sisupod_zip_base; + zip_arc_member_file.name = fn_src_out_pod_zip_base; auto zip_data = new OutBuffer(); zip_data.write((fn_src_in).readText); zip_arc_member_file.expandedData = zip_data.toBytes(); zip.addMember(zip_arc_member_file); - createZipFile!()(fn_sisupod, zip.build()); + createZipFile!()(fn_pod, zip.build()); } } else { if (doc_matters.opt.action.verbose @@ -269,33 +269,33 @@ auto fn_sisupod = pths_sisupod.sisupod_filename(doc_matters.src.filename).zpod; } } { auto fn_src_in = doc_matters.src.filename; - if (doc_matters.opt.action.sisupod) { + if (doc_matters.opt.action.pod) { if (exists(doc_matters.src.file_with_absolute_path)) { - createZipFile!()(fn_sisupod, zip.build()); + createZipFile!()(fn_pod, zip.build()); } else { - writeln("WARNING check missing source file(s): ", doc_matters.opt.action.sisupod); + writeln("WARNING check missing source file(s): ", doc_matters.opt.action.pod); } - if (!(exists(fn_sisupod))) { - writeln("WARNING failed to create sisupod zip archive: ", fn_sisupod); + if (!(exists(fn_pod))) { + writeln("WARNING failed to create pod zip archive: ", fn_pod); } } } #+END_SRC -** sha256 of sisupod.zip, zip debug, read zip archive +** sha256 of pod.zip, zip debug, read zip archive -#+name: source_sisupod_copy +#+name: source_pod_copy #+BEGIN_SRC d -if (exists(fn_sisupod)) { +if (exists(fn_pod)) { try { if (doc_matters.opt.action.verbose) { - auto data = (cast(byte[]) (fn_sisupod).read); + auto data = (cast(byte[]) (fn_pod).read); writeln(doc_matters.src.filename, " >> "); - writefln("%-(%02x%) %s", data.sha256Of, fn_sisupod); + writefln("%-(%02x%) %s", data.sha256Of, fn_pod); } - debug(sisupod) { + debug(pod) { try { - auto zipped = new ZipArchive((fn_sisupod).read); + auto zipped = new ZipArchive((fn_pod).read); foreach (filename, member; zipped.directory) { auto data = zipped.expand(member); writeln("> ", filename, " length ", data.length); @@ -308,7 +308,7 @@ if (exists(fn_sisupod)) { assert( ((data).sha256Of).toHexString == "626F83A31ED82F42CF528E922C1643498A137ABA3F2E5AFF8A379EA79EA22A1E", - "\nsisupod: sha256 value for " + "\npod: sha256 value for " ~ doc_matters.src.filename ~ " has changed, is now: " ~ ((data).sha256Of).toHexString @@ -318,7 +318,7 @@ if (exists(fn_sisupod)) { assert( ((data).sha256Of).toHexString == "AAE0C87AB3F6D5F7385AEEA6EE661F56D40475CFE87AD930C78C9FE07FFB0D91", - "\nsisupod: sha256 value for " + "\npod: sha256 value for " ~ doc_matters.src.filename ~ " has changed, is now: " ~ ((data).sha256Of).toHexString diff --git a/org/source_files_read.org b/org/source_files_read.org index 9ff0cc9..ceb2c36 100644 --- a/org/source_files_read.org +++ b/org/source_files_read.org @@ -317,7 +317,7 @@ static template DocReformRawMarkupContent() { sourcefile_body_content = tu[0]; insert_file_list = tu[1].dup; images_list = tu[2].dup; - } else if (_opt_action.source || _opt_action.sisupod) { + } else if (_opt_action.source || _opt_action.pod) { auto ins = Inserts(); auto tu = ins.scan_master_src_for_insert_files_and_import_content(_opt_action, sourcefile_body_content, fn_src); @@ -573,7 +573,7 @@ if (type1["curly_code"] == 1) { markup_sourcesubfile_insert_content.length ); } - if (_opt_action.source || _opt_action.sisupod) { + if (_opt_action.source || _opt_action.pod) { _images ~= _extract_images(markup_sourcesubfile_insert_content); } auto ins = Inserts(); @@ -591,7 +591,7 @@ if (type1["curly_code"] == 1) { type1["header_make"] = 0; type1["header_meta"] = 0; contents_insert ~= line; // images to extract for image list? - if (_opt_action.source || _opt_action.sisupod) { + if (_opt_action.source || _opt_action.pod) { auto _image_linelist = _extract_images(line); if (_image_linelist.length > 0) { _images ~= _image_linelist; @@ -670,7 +670,7 @@ if (type["curly_code"] == 1) { fn_src_insert.to!string ); contents ~= contents_insert_tu[0]; // images to extract for image list? - if (_opt_action.source || _opt_action.sisupod) { + if (_opt_action.source || _opt_action.pod) { auto _image_linelist = _extract_images(contents_insert_tu[0]); if (_image_linelist.length > 0) { _images ~= _image_linelist; @@ -688,7 +688,7 @@ if (type["curly_code"] == 1) { +/ } else { contents ~= line; - if (_opt_action.source || _opt_action.sisupod) { + if (_opt_action.source || _opt_action.pod) { auto _image_linelist = _extract_images(line); if (_image_linelist.length > 0) { _images ~= _image_linelist; |