Set select variables ahead of USAGE so that the
help message contains certain default values.
Added -u repo_url to `tmp/readme2index.sh` and `inc/pandoc_wrapper.sh` for
the URL of the final target repo from where HTML files will be viewed.
Add missing Copyright to `inc/pandoc_wrapper.sh`.
Require a `.winner.json` under _yyyy/dir_.
Change `tmp/readme2index.sh` VERSION from "0.3 2023-12-31"
to "0.4 2023-12-31".
Change `inc/pandoc_wrapper.sh` VERSION from "1.0 2023-12-29"
to "1.2 2023-12-31".
Improve the parameter debugging under -v 3.
Fixed various typos.
The '-p tool' and '-P optstr' will be passed as leading options on the
-b tool and -a tool command lines, not to the '-o tool' command lines.
Improve help text for readme2index.sh.
The `inc/md2html.cfg` file was updated so that the comment
about options matches the `readme2index.sh` tool usage message.
The `readme2index.sh` tool does a more consistent job of checking
options in the help message and reporting when something violates
a restriction.
In many cases the parameters (_$OPTARG_) of an option is not allowed
to contain a single-quote, nor a double-quote. We prevent use of
single-quotes and double-quotes in cases where passing such to other
tools may create a problem.
There are a few exceptions to the above mention "single-quote /
double-quote" restrictions. For example, the "-s token=value" does
NOT have such a restriction. In the case of "-s token=value", we
can allow for the single-quotes and double-quotes because the ;
(semicolon) is used as a regex separator instead.
We also better explain the cumulative nature of "-s token=value".
Some help message wording cleanup was performed.
The `inc/md2html.cfg` file was updated so that the comment
about options matches the `readme2index.sh` tool usage message.
With -N, just parse arguments and ignore the file.
Change readme2index.sh version from "0.1 2023-12-10"
to "0.2 2023-12-29". The previous change in
commit d5c4171d73
forgot to update the version number.
The `tmp/sample_getopt.sh` is now `tmp/readme2index.sh`, a tool
that goes thru the motions of multi-phase getopt processing, scanning
the `inc/md2html.cfg` for the first match, and calls various stub tools.
The `inc/md2html.cfg` has been improved to document a cleaner getopt
phase model.
Adjusted `inc/md2html.cfg` to improve the 3 phase parse process.
Added `tmp/sample_getopt.sh` as a demo of the 3 phase parse of command
line options and arguments for that a markdown to HTML tool that
uses the `inc/md2html.cfg` configuration file.
Try:
```sh
cd tmp
./sample_getopt.sh -v 3 foo
```
The `tmp/sample_getopt.sh` tool performs a somewhat complicated 3
phase getopt parse of simulated command line options and arguments
that a tool converting markdown to HTML and using the `inc/md2html.cfg`
configuration file would perform. The tool does not actually use
the `inc/md2html.cfg`, it just simulates the complex 3 phase getopt
parsing procedure.
Updated `tmp/README.md` accordingly.
As the thanks-for-fixes.md file was renamed (at my suggestion)
thanks-for-help.md I have made sure that the file referred to in the
repo is thanks-for-help and that the text regarding it also refers to
help and not fixes ('Thanks for the fixes' -> 'Thanks for the help').
Moved thanks-for-fixes.md -> thanks-for-help.md
References to thanks-for-help.md are referred to
as just the _thanks file_.
Updated links to reflect the above file change.
Links to winner files in bugs.md now start with /.
Updated the `/inc/sidenav.default.html` file
to use an improved sidenav menu that includes
a link to "How to enter the IOCCC".
Fixed reference to FAQ entry regarding 'gets()' in `bugs.md`.
Removed some trailing whitespace in `bugs.md`.
Removed some trailing whitespace in `faq.md`.
Fixed links into specific thanks file entries.
Added more info to FAQ 0.0 "How may I submit to the IOCCC?".
The temporary top level HTML files (contact.html, index.html,
judges.html, news.html, winners.html, years.html) have
a consistent set of links (w/o any bold links) that
match the revised `/inc/sidenav.default.html` sidenav menu.
These temporary top level HTML files are not yet being built
and so they do not yet use the `inc/*.html` system.
TODO: Turn contact.html, index.html, judges.html, news.html, winners.html,
and years.html into markdown files that markdown to HTML tools will generate.
Specifying a tool path of "." (dot) disables the tool for a given file.
Specifying a HTML phase name of "." (dot) disables the given HTML phase.
Improve configuration for winner level README.md files.
Made a few minor formatting improvements to inc/md2html.cfg and inc/README.md.
Adjust HTML phase names and filenames under inc.
Improve phase documentation in inc/README.md.
Added inc/md2html.cfg as an initial markdown to HTML configuration
file. The inc/md2html.cfg file is undergoing design evaluation and
thus may change. Nevertheless the comments in inc/md2html.cfg give
some hints as to how HTML files will be formed from markdown files.
Details of how this content will be used is found in part,
in the `/inc/README.md` file and in part in the tools that
will use this content.
The content of this directory will likely change soon.
This content is a placeholder.
Landon Curt Noll