Given how problematic leading tabs in markdown files can be,
we have expanded all leading tabs in markdown files by:
```sh
find * -type f -name '*.md' -print |
while read -r file; do
rm -f "$file.tmp" ;
expand < "$file" > "$file.tmp" ;
mv -f -v "$file.tmp" "$file" ;
done
```
Given the previous changes to `bin/pandoc-wrapper.sh` and other recent
commits and recent pull requests, the were were **NO** changes to
any HTML files. This is a **good thing** as the expression goes.
No there are no leading tabs in any markdown files.
A check to catch any re-introduction of leading tabs
into any markdown file is on the way.
BTW: We do not have anything against leading tabs in files,
even though we have had to deal with their impact on forming
HTML from markdown files (as well as the calc source code).
It is just that this is one of those cases where tabs conflict
(sometimes caused by people wanting to change the classic
8-space tab model) with a desired outcome.
Perform `make www` to perform the above and test under macOS.
While not strictly necessary, replacing the two ASCII tab characters
in the markdown copyright comment makes it easier to detect problematic
TAB indentation within markdown files.
After this commit, only 90 markdown files have leading ASCII TAB
characters. And again, while not strictly necessary, we can consider
running expand on those 90 markdown files to see what effect that
might have on the HTML files they produce.
Replace leading ASCII TAB characters with multiples of 8 ASCII SPACE
characters (the default action of the `expand(1)` tool) might have
an negative effect on some HTML formatting where **hack-a-round**
formatting was attempted to fix broken indentation caused by
problematic ASCII TAB characters.
Think of this as a baseline for evaluating leading
TAB characters within markdown files.
TODO: Consider either using `expand(1)` to replace leading ASCII
TAB characters with multiples of 8 ASCII SPACE characters AND/OR
modifying the appropriate `bin` tool to convert leading ASCII TAB
characters into multiples of 8 ASCII SPACE characters.
Fixed internal URLs in `1992/buzzard.1/index.html`
Also fixed an internal URL in `1992/buzzard.2/buzzard.2.README.md`.
Ran `bin/readme2index.sh -v 1 1992/buzzard.1` and
`make gen_other_html` to perform the above.
The `1992/buzzard.2/buzzard.2.README.md` has been improved
so that links to files that is referenced are
directed to the proper web pages (web site or GitHub).
Links in `1992/buzzard.2/buzzard.2.README.md` markdown
files have been changed to the generated HTML files.
Changed `bin/gen-other-html.sh` VERSION from to "1.0.4 2024-04-13"
to "1.1 2024-04-20".
By default, we substitute _%%REPO_URL%%_ and _%%SITE_URL%%_
in inc files.
Changed `bin/subst.default.sh` VERSION from to "1.2.3 2024-04-13"
to "1.3 2024-04-20".
All `-s TOKEN=value` substitutions are applied to all markdown files
that are processed by `bin/md2html.sh`.
Substitutions of and **%%TOKEN%%** are performed on included HTML
content, content generated by the ‘before tool’ (-b tool), content
generated by the ‘after tool’ (-a tool), as well as the markdown
content given to the pandoc wrapper tool (-p tool).
It is an error, unless -S is given, for any phase, except HTML phases
20-29, to not substitute all **%%TOKEN%%**'s. For HTML phases 20-29, any
**%%TOKEN%%** that is not substituted are passed thru without substitution.
Update `bin/index.html` to clarify
Changed `bin/md2html.sh` VERSION from to "1.4 2024-04-18"
to "1.5 2024-04-20".
Fix the _BEFORE: 1st line of markdown file_ and _AFTER: last line
of markdown file_ HTML comments so that the true markdown file
source (not some temporary file) is identified. This prevents
`authors.html`, `location.html` and `years.html` from always changing
due to different temporary files being used on each run.
Run `make www` to perform the above.
The inc/footer.default.html now has a common Copyright and CC BY-SA
4.0 License section for all generated HTML files.
All markdown files have a similar Copyright and CC
at the bottom in the form of an HTML comment.
We used this command to find markdown files with trailing whitespace.
```sh
find . -name '*.md' -print0 | xargs -0 grep -E -l '[[:space:]][[:space:]]*$'
```
After removal, we did a `make www`.
The file buzzard.2.README.md was formatted in markdown style.
The file buzzard.2.design was turned into a markdown file,
buzzard.2.design.md, and formatted in markdown style. This one was
problematic in some ways but I think it's sorted out now. In a few
places it was not entirely clear if certain things should be in code
blocks or not but they were made to be as they were on the same line as
code (after). It doesn't appear to be a comment in the syntax of
comments that later appears, however. Another one I was not sure about
is if the author meant '{ .. .. }' to be a way to say this is code
without the {}s or if that should be part of the code. As these are not
clear there might be some mistakes.
Running make all now links first.
The README.md now has been checked for formatting and typos.
The buzzard.2.README.md file has also been checked for formatting and
typos.
Landon Curt Noll