miser

The Miser Project
Hybrid Document-Format Exemplar

miser> hybridForm>



index.html>
0.0.6 2024-04-19T19:56Z

Topic Synopsis or Overview

NOTICE: This is a work in progress. The hybridForm technique is developed in situ under the Miser Project on GitHub. On completion for this initial case, the material will be put in polished form under the docEng project. There is some urgency to applying this technique to the Miser Project first, so that continuing documentation and development can proceed using this technique. dh:2024-03-02

This topic-level folder is an exemplar, a kind of self-describing template, for topics and topical articles documenting the Miser Project on Github. This is Construction Material, but in the form of the exemplified topical content.

By topic-level is meant that this hybridForm folder is a direct sublevel of a GitHub Pages source folder. For the Miser Project, this is directly under miser/docs and published at orcmid.github.io/miser/hybridForm.

An entirely new Miser Project topic, or articles under existing topics, can be initialized by selectively copying from this folder, renaming the copies, and editing the copies to customize their content. Each file of the hybridForm/ folder incorporates instructions and checklists for customization with intended content. For a new topic, the entire hybridForm folder can be copied and renamed. Alternatively, it can be done by pirating copies from existing topics and portions of hybridForm/.

The Construction Structure and HTML-article pages depend on Microsoft Office FrontPage 2003 features. The hybridForm of Markdown pages does not. Take this into consideration before employing hybridForm methodology in other projects. Additional material and consideration of alternatives is found in the docEng project.

IMPORTANT: The customization instructions for this page are incorporated in the authored index.md form, not the published index.html form that is published via GitHub Pages. The instructions are in HTML comments.

ID Status Started Topic
hyymmnn placeholder 2024-02-11 Article placement
       
h000001 undated 2024-02-11 Topic Articles Catalog
h000000 undated 2024-02-11 Topic Diary & Job Jar

The construction structure and related text files are generally not catalogued. The curious can navigate the raw materials from the bottom-strip hard-hat logo.


I invite discussion about Miser Project topics in the Discussion section. Improvements and removal of defects in this particular documentation can be reported and addressed in the Issues section. There are also relevant projects from time to time.

Hard Hat Area You are navigating the Miser Project on Github

created 2024-02-11 by orcmid