html.mk

static html creation framework using make(1) and cpp(1)
Log | Files | Refs | README | LICENSE

commit 25accd3b0e34d251f0730392422e21e11c814c0c
parent 815889ae684b9e5ac72f8cdc693e7d210738e146
Author: Kyle Milz <krwmilz@gmail.com>
Date:   Wed, 17 Nov 2021 05:48:25 +0000

format paragraphs

Diffstat:
MREADME | 76+++++++++++++++++++++++++++++++++++-----------------------------------------
1 file changed, 35 insertions(+), 41 deletions(-)

diff --git a/README b/README @@ -61,30 +61,26 @@ It has two main features that make it useful: 4. Design ---------- -Content creators sometimes have multiple pages that include similar or -identical content. Synchronizing that content can be laborious if it -cannot be stored centrally. -A similar problem exists in C source code: header files. -This was solved with the -invention of the C preprocessor. While the C preprocessor is meant -to be used on code, it can be abused for other purposes as well. - -Not only can the C preprocessor #include other text -files verbatim, it is also a macro processor with many other useful -features. All of these features are available in -html.mk(5) source files. +Content creators sometimes have multiple pages that include similar +or identical content. Synchronizing that content can be laborious +if it cannot be stored centrally. A similar problem exists in C +source code: header files. This was solved with the invention of +the C preprocessor. While the C preprocessor is meant to be used +on code, it can be abused for other purposes as well. + +Not only can the C preprocessor #include other text files verbatim, +it is also a macro processor with many other useful features. All +of these features are available in html.mk(5) source files. Because the C preprocessor transforms input files to output files, another utility is needed to keep track of out of date file -dependencies. -The make(1) utility has this feature and can be taught -how to transform the html.mk(5) input files into output +dependencies. The make(1) utility has this feature and can be +taught how to transform the html.mk(5) input files into output files. -cpp(1) can also create dependency graphs of output files -that -make(1) can understand to efficiently rebuild out of date -output files, or targets. +cpp(1) can also create dependency graphs of output files that make(1) +can understand to efficiently rebuild out of date output files, or +targets. Content creators sometimes want images included in their pages. Including full size images into a page is a waste of resources @@ -97,37 +93,35 @@ as the page loads quickly and takes up minimal resources while if needed the user still has access to the full resolution image. -html.mk(5) uses image utilities to downsample originals -before including them into a page. The original is always available -as a link on the downsampled thumbnail. +html.mk(5) uses image utilities to downsample originals before +including them into a page. The original is always available as a +link on the downsampled thumbnail. Content creators will often organize their pages using directories. -html.mk(5) can accommodate this by using the -bsd.subdir.mk system Makefile fragment. By placing -SUBDIR variable arrays in a Makefile, -html.mk(5) will enter those directories after it is -finished in the current one. +html.mk(5) can accommodate this by using the bsd.subdir.mk system +Makefile fragment. By placing SUBDIR variable arrays in a Makefile, +html.mk(5) will enter those directories after it is finished in the +current one. Content creators sometimes want to place output files in a completely -different location than the source files. html.mk(5) -can accommodate this by using the bsd.obj.mk system -Makefile fragment. +different location than the source files. html.mk(5) can accommodate +this by using the bsd.obj.mk system Makefile fragment. -Because html.mk(5) lives beside and uses many operating -system utilities using the same documentation system makes sense. -The mdoc(7) semantic markup language provides a great -platform to write documentation in. All aspects of how to use -html.mk(5) are included in its manual. +Because html.mk(5) lives beside and uses many operating system +utilities using the same documentation system makes sense. The +mdoc(7) semantic markup language provides a great platform to write +documentation in. All aspects of how to use html.mk(5) are included +in its manual. Automated testing ensures regression free development and easy -porting to new platforms. html.mk(5) uses -perl(1) exclusively for testing because it is very -flexible and has many feature rich testing modules available. -All features and their error paths are intended to be tested. +porting to new platforms. html.mk(5) uses perl(1) exclusively for +testing because it is very flexible and has many feature rich testing +modules available. All features and their error paths are intended +to be tested. Releases are accomplished through use of an archive. When unpacked, -html.mk(5) contains an install target that -will install that release on the users machine. +html.mk(5) contains an install target that will install that release +on the users machine. 5. Testing