docs.txt 0.0.2 Filling in the construction scaffolding

Additional scaffolding and placeholders are create in satisfaction of Issue #3, bringing the testing of plain and current GitHub docs/ templates to docEng.

docs/about/about.txt

@@ -0,0 +1,59 @@
+about.txt 0.0.0                      UTF-8                       dh:2021-02-15
+----|----1----|----2----|----3----|----4----|----5----|----6----|----7----|--*
+
+                           The docEng Project Site
+                           =======================
+
+     <https://github.com/orcmid/docEng/blob/master/docs/about/about.txt>
+
+                  ABOUT THE GITHUB-HOSTED DOCUMENTATION
+                  -------------------------------------
+
+    The about/ page and its subordinates address the docEng Project and
+    connections with its investigator and other contributors.
+
+MANIFEST
+
+         about.txt
+               this manifest and job-jar file
+
+         index.md
+               authoring of the <https://orcmid.github.io/docEng/about/> page.
+
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+                      Copyright 2021 Dennis E. Hamilton
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ TODO
+
+  * This will house a conventional About page focused on the docEng Project,
+    what it is about, and how things work here.  It is also an exemplar of a
+    kind of Document Engineering applied to the docEng project itself. Explain
+    that.
+
+  * Link to this page from the docs/ folder.
+
+  * Put attributions on these pages.
+
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ 0.0.0 2021-02-16T00:23Z Create placeholder and initial job jar for the
+       docEng Project documentation web site "About" section.
+
+                        *** end of about.txt ***

docs/about/index.md

@@ -0,0 +1,14 @@
+<!-- index.md  0.0.0              UTF-8                      dh:2021-02-15 -->
+<!--|----1----|----2----|----3----|----4----|----5----|----6----|----7----|-->
+<!-- source: <https://github.com/orcmid/docEng/blob/master/
+              docs/about/index.md>
+     construction structure, manifest, and job jar:
+     <https://orcmid.github.io/docEng/about/about.txt>
+     -->
+
+# DOCENG PROJECT DOCS: ABOUT PAGE
+
+## *PLACE-HOLDER*
+
+
+<!--                *** end of docs/about/index.md ***                     -->

docs/construction/construction.txt

@@ -0,0 +1,126 @@
+construction.txt 0.0.0               UTF-8                       dh:2021-02-15
+----|----1----|----2----|----3----|----4----|----5----|----6----|----7----|--*
+
+                           The docEng Project Web
+                           ======================
+
+<https://github.com/orcmid/docEng/blob/master/docs/construction/construction.txt>
+
+              GITHUB DOCENG PROJECT DOCS CONSTRUCTION MATERIAL
+              ------------------------------------------------
+
+MANIFEST
+
+  construction.txt
+              this manifest and job-jar file
+
+         index.md
+              <https://orcmid.github.io/docEng/construction/>
+              markdown source
+
+       current/
+              page that renders with the current theme, demonstrating
+              its markup provisions.
+
+         plain/
+              documentation of how current rendered when the default docs/
+              publication was employed with no explicit introduction of a
+              template.
+
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+                      Copyright 2021 Dennis E. Hamilton
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ TODO
+
+   * Find a clean way to talk about the *authored" documentation and the
+    *authoring" source that is published to be the documentation.  Need some
+    nomenclature that I don't keep tripping over.
+
+  * Identify adaptation of the infrastructure technique used on sites such
+    as miser-theory or the nfoCentrale sites in general.  Find appropriate
+    links.
+
+  * Find a theme that supports reflow.  The Pages templates do not seem to
+    provide for that.
+
+  * If a theme is customized, determine where and how that works.
+
+  * I am trusting that this material is current as of 2021-02-15:
+    <https://help.github.com/en/github/working-with-github-pages/getting-started-with-github-pages>
+
+  * The default rendering, with no template, provides reflow in the manner
+    required for docEng Project documentation.  How to ensure that with any
+    of the provided themes remains to be understood.
+
+   * Determine how I can have some kind of versioning on my .md pages and
+     have that part be private (not rendered).  It depends on the GitHub
+     Markdown and maybe some YAML control.  Must find out about that.
+
+   * Work through all of the feature cases of GitHub Markdown to see what
+     works with the default template.  Use construction/test/ or example/
+     for that.
+
+   * Create a test document (set) that demonstrates the main Markup
+     provisions.
+
+   * Create a folder (i.e., plain/ that carries captured images of the
+     current test/demo document under the default template)
+
+   * Create a version of the text ruler for the markdown pages.
+
+   * Make a template for the index.md source pages.
+
+   * Maybe it is harmonious to call this the Construction Zone ?
+
+   * Add a forensics folder on web-site and authoring, plus rouble-shooting,
+     reverse-engineering, etc.
+
+   * Could also introduce document-engineering in a sub-folder also.
+
+   * Confirm preservation with pre-HTML5 browsers, such as Internet Explorer.
+
+   * The "improve this page" and edit/master link requires being logged-in to
+     GitHub.  We need a way to suppress that.  Document this in "plain."
+
+  * The folio system is a bit different here.  There can be a counterpart in
+    how pages and their assets are in folders.  The idea of version sequences
+    does not quite work unless we take it to a lower level.  The use of insert
+    pages might have no counterpart here.  Having the effect would take
+    copying.
+
+  * GitHub, and use of Git, provides a valuable history and provenance system.
+    It requires access to such "document forensic" tools and doesn't support
+    removed prints of pages the way I have desired.
+
+  * The missing here is construction zones and also the job jar xyymmnna.htm
+    pages.  At the moment, construction structure is in the <folder>.txt files
+    like this one.  The Construction Material folder is now equivalent to the
+    Construction Zone scheme on nfoCentrale.
+
+  * Repair the substructure and content of construction/ to reside directly at
+    docs/construction/ and https://orcmid.github.io/miser/construction.
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ 0.0.0 2021-02-16T00:36Z Create placeholder and initial job jar for docEng
+       Project documentation authoring "about/construction/", morphing the
+       same page of the Miser Project.  All that experimentation with the
+       GitHub (default) templates and others is moved for continuation here.
+
+                      *** end of construction.txt ***

docs/construction/current/current.txt

@@ -0,0 +1,98 @@
+current.txt 0.0.1                    UTF-8                       dh:2021-02-15
+----|----1----|----2----|----3----|----4----|----5----|----6----|----7----|--*
+
+                           The docEng Project Site
+                           =======================
+
+<https://github.com/orcmid/docEng/blob/master/docs/construction/current/current.txt>
+
+                     MARKDOWN FEATURE CONFIRMATION PAGE
+                     ----------------------------------
+
+    Page <https://orcmid.github.io/docEng/construction/current/> shows
+    the rendering of Markdown features using the current theme.  The page
+    content is based on theme demonstrations provided by GitHub and also the
+    feature tests adapted from Hexo blog authoring/generation template tests.
+
+    Additional features for examination and demonstration/confirmation have
+    been obtained by digital forensics of generated pages.
+
+    This folder provides the authoring for that page used to confirm the
+    experience of features from one template to the next.  The first, default
+    theme is accounted for in the companion page at
+    <https://orcmid.github.io/docEng/construction/plain/>.
+
+MANIFEST
+
+       current.txt
+               this manifest and job-jar file
+
+         index.md
+               <https://orcmid.github.io/docEng/construction/current/>
+               authoring material
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+                      Copyright 2019 Dennis E. Hamilton
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ TODO
+
+  * Use the available theme demonstrations with code blocks revealing how
+    each is produced.
+
+  * If a theme is customized, determine where and how that works.
+
+  * I am trusting that this material is current as of 2019-11-20:
+    <https://help.github.com/en/github/working-with-github-pages/getting-started-with-github-pages>
+
+  * Provide default rendering with no explicit template as the first case.
+
+  * Explain that examining the source via GitHub will show a formatted
+    version and the Raw view must be chosen to see the actual "source."
+
+  * Introduce the comment markers at this level.  Not clear if provenance
+    of template matters.  If so, it should apply here.
+
+  * See what can be made of view source also.  Also the developer view.  This
+    is a little document forensics.
+
+  * The headers automatically get anchors it appears, so we can do
+    permalinks.  They also show up with link symbols on a heading mouse-over.
+    We want to be able to use these when cross-referencing within a page.  We
+    want this to be available on any themes we use.  Demonstrate along with
+    headers or immediately afterwards.
+
+  * The page-top title identifies the mini-web and links to its "root."
+
+  * Use "mini-web" to avoid confusion with sub-domain?
+
+  * The difference with rendering in publishing a mini-web, versus rendering
+    of markdown in-place in a repository view is simply the source location?
+    This should be verifiable with cross-references and local linking.
+
+  * demonstrate image squeezing along with text-flow adjustment.  This will
+    have to be captured under plain also.
+
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+ 0.0.1 2021-02-15T00:59Z Transpose this page from the same place in the
+       Miser Project docs/ and make the placeholder for docEng.
+ 0.0.0 2019-11-20-16:14 Create placeholder and initial job jar for the
+       page demonstrating Markdown features using the current (or default)
+       page template.
+
+                        *** end of current.txt ***