diff options
Diffstat (limited to 'org/doc_reform.org')
| -rw-r--r-- | org/doc_reform.org | 206 |
1 files changed, 133 insertions, 73 deletions
diff --git a/org/doc_reform.org b/org/doc_reform.org index 422d25c..6b2f87c 100644 --- a/org/doc_reform.org +++ b/org/doc_reform.org @@ -8,7 +8,7 @@ #+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 +#+PROPERTY: header-args :results silent :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) doc_reform(s) tangle(T) template(t) WEB(W) noexport(n) @@ -58,7 +58,7 @@ version (Posix) { - process file - output -** 0. sdp src/sdp :template: +** 0. doc_reform src/doc_reform :template: - process files (act according to requirements of each type) - by sourcefilename @@ -219,15 +219,13 @@ static auto rgx = Rgx(); #+NAME: doc_reform_args #+BEGIN_SRC d scope(success) { - debug(checkdoc) { - writefln( - "~ run complete, ok ~ (%s-%s.%s.%s, %s D:%s, %s %s)", - program_name, - _ver.major, _ver.minor, _ver.patch, - __VENDOR__, __VERSION__, - bits, os, - ); - } + writefln( + "~ run complete, ok ~ (%s-%s.%s.%s, %s D:%s, %s %s)", + program_name, + _ver.major, _ver.minor, _ver.patch, + __VENDOR__, __VERSION__, + bits, os, + ); } scope(failure) { debug(checkdoc) { @@ -1326,38 +1324,8 @@ writefln( * __END__ 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) | -|------------+-------------------------------------| - -consider -|-------+----------------------------------------------| -| dao | document abstraction, objects | -|-------+----------------------------------------------| -| daso | document abstraction, structure, objects | -|-------+----------------------------------------------| -| drso | document representation, structure, objects | -|-------+----------------------------------------------| -| daows | document abstraction, objects with structure | -|-------+----------------------------------------------| - ** the document notes -*** document sections -**** summary +*** document sections (table) |--------------+--------------+------+---+--------------------------------------------------+--------------------------------+---+---| | section | part | opt. | | objects | ocn | | | @@ -1398,36 +1366,71 @@ consider | | | | | - paras | | | | |--------------+--------------+------+---+--------------------------------------------------+--------------------------------+---+---| -**** on abstraction - -- abstract for downstream processing - - identify document structure and objects - - identify document structure (headings/levels/sections) - - identify objects (headings, paragraphs, tables, code blocks, verse ...) - - set document, generate common abstraction for downstream parsing - - set different _document sections_: - - _head_, toc, _body_, endnotes, glossary, bibliography, book index, blurb - - _object numbers_, heading/ chapter numbering etc, endnote numbers - - _regular ocn_ - - body objects - - glossary objects - - bibliography objects - - _special ocn_ - - non substantive text (provide special numbers) - - blurb objects - - book index - - special (_exceptions_) - - endnotes - - unify object representations - - multiple markups for same object type given single representation - - extract object attributes - - unify inline markup on objects - - inline markup made easier to identify - -- simplify downstream parsing - -*** objects -**** summary +*** document objects (table) +- check, keep up to date + +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| doc object | doc object | attributes | inline | appended | structure | delimiters | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| is_of | is_a | | | | | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| para/heading | heading | - level | - font face | - object number off | - level | - delimiter == two newlines | +| | | - object number | - endnotes | - book index meta | (document structure) | | +| | | - object number off | | | | | +| | | - dummy (toc & seg) | | | | | +| | | - tags (internal links) | | | | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | toc | - level | - font face | | | - auto generated from headings | +| | | | - links (auto) | | | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| para | para | - bullet | - font face | - object number off | | - delimiter == two newlines | +| | | - indent | - links/urls * | - book index meta | | | +| | | - object number | - images* | | | | +| | | - object number off | - endnotes | | | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | toc | - indent | - font face | | | - delimiter == two newlines | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | endnote | | - font face | | | (generated from | +| | | | | | | inline markup tags) | +| | | | | | | - delimiter == two newlines | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | bookindex | - auto indent | - font face | | | - delimiter == two newlines | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | blurb | - bullet | - font face | - object number off | | - delimiter == two newlines | +| | | - indent | - links/urls * | - book index meta | | | +| | | - object number | - images* | | | | +| | | - object number off | - endnotes | | | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| group | group | - object number | - font face | - book index meta | - para break | - delimiter tags (group) | +| | | - object number off | - links/urls * | | | | +| | | | - images* | | | | +| | | | - endnotes | | | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | block | - object number | - font face | - book index meta | - new line | - delimiter tags (block) | +| | | - object number off | - links/urls * | | | | +| | | | - images* | | | | +| | | | - endnotes | | | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | quote | - object number | - font face | - book index meta | | - delimiter tags (quote) | +| | | | - endnotes | | | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | poem (see verse) | | | - book index meta | | - delimiter tags (poem) | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| | verse (of poem) | - object number | - font face | | - new line | - (see poem delimiter) | +| | | | - endnotes | | - preceeding spaces | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| group/code | code | - syntax | | | - new line | - delimiter tags (code) | +| | | - numbered | | | - preceeding spaces | | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| +| group/table | table | - object number | | | | - delimiter tags (table) | +|--------------+------------------+-------------------------+----------------+---------------------+----------------------+--------------------------------| + +- consider special treatment for links/urls (& for images?) take them out of + document munge (for various outputs), by storing in own array (within each + object struct), and providing info on where in array to extract them from, + debating whether necessary or even worthwhile as is extra work + +**** check |-------+--------------+----------------------------+--------------------------+----------------+-----------------+----------------+------------| | | | identified by | object notes | attributes | inline | embedded | special | @@ -1468,7 +1471,35 @@ consider | | | | | - heading row | | | | |-------+--------------+----------------------------+--------------------------+----------------+-----------------+----------------+------------| -**** ocn +*** on abstraction + +- abstract for downstream processing + - identify document structure and objects + - identify document structure (headings/levels/sections) + - identify objects (headings, paragraphs, tables, code blocks, verse ...) + - set document, generate common abstraction for downstream parsing + - set different _document sections_: + - _head_, toc, _body_, endnotes, glossary, bibliography, book index, blurb + - _object numbers_, heading/ chapter numbering etc, endnote numbers + - _regular ocn_ + - body objects + - glossary objects + - bibliography objects + - _special ocn_ + - non substantive text (provide special numbers) + - blurb objects + - book index + - special (_exceptions_) + - endnotes + - unify object representations + - multiple markups for same object type given single representation + - extract object attributes + - unify inline markup on objects + - inline markup made easier to identify + +- simplify downstream parsing + +*** ocn |-------------+-----------------------+-----------------------+----------------+------| | objects | section / part | ocn described | how used | type | @@ -1502,6 +1533,35 @@ consider | | | + footnote seq. digit | anchor visible | | |-------------+-----------------------+-----------------------+----------------+------| +** 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) | +|------------+-------------------------------------| + +consider +|-------+----------------------------------------------| +| dao | document abstraction, objects | +|-------+----------------------------------------------| +| daso | document abstraction, structure, objects | +|-------+----------------------------------------------| +| drso | document representation, structure, objects | +|-------+----------------------------------------------| +| daows | document abstraction, objects with structure | +|-------+----------------------------------------------| + ** make config - _composite make_ work on composite make a unification of make instructions for each document run |