Fix html.sed and related scripts

The file bin/html.sed has been fixed so that it works with
bin/md2html.sh (which has been modified and which is used via
bin/subst.entry-index.sh and output-index-inventory.sh). The script
output-index-inventory.sh was already updated to use html.sed so this
file has not been modified but the md2html.sh and subst.entry-index.sh
scripts have, along with bin/html.sed itself.

Tested make www which rebuilt several index.html files.

Updated bin/README.md as well as bin/index.html.

Testing that all the html files now are correct wrt Nu checker will have
to be done another time, however.
This commit is contained in:
Cody Boone Ferguson committed 2024-11-06 10:13:38 -08:00
1 parent fa34d80a82
commit 9787cc3a12
11 files changed
+123 -72

No files matched your search

+30 -6
View File
@@ -14,10 +14,12 @@ files and other content from the [IOCCC GitHub
repo](https://github.com/ioccc-src/temp-test-ioccc).
## [bin/](index.html) tools
## [bin/](index.html) tools options
With the exception of the `awk(1)` and `sed(1)` scripts, all the tools in this
directory support a number of options that can be used to get help, diagnose
problems, see progress etc. These options are described below.
All tools in this directory support a number of options that can be used to get
help, diagnose problems, see progress etc. These options are as follows:
### Get help / usage string of a tool
@@ -35,9 +37,9 @@ from the root directory (of the repo/website), you would do:
### Set verbosity level of a tool
If you want verbosity, say for debugging purposes or to see what is
going on more, you should use the `-v level` option. For instance if you wish to
see what is going on with the
If you want verbosity, say for debugging purposes or to see what is going on
more (than the default), you should use the `-v level` option. For instance if
you wish to see what is going on with the
[quick-readme2index.sh](index.html#quick-readme2index) tool, you might do:
@@ -412,6 +414,28 @@ Usage:
In this case the command will list all the files of the
[2020/ferguson1](../2020/ferguson1/index.html) winning entry.
<div id="html-sed">
### [html.sed](%%REPO_URL%%/bin/html.sed)
</div>
Translates certain characters in their corresponding HTML entities. For example
`<` is converted to `&lt;` and `>` is converted to `&gt;`. This is important to
satisfy html lints.
This script is used in [md2html.sh](#md2html) via
[output-index-inventory.sh](#output-index-inventory) and
[subst.entry-index.sh](#subst-entry-index).
Usage:
``` <!---sh-->
cmd | sed -f bin/html.sed
sed -f bin/html.sed file > output
sed -i -f bin/html.sed file
```
<div id="find-missing-links">
### [find-missing-links.sh](%%REPO_URL%%/bin/find-missing-links.sh)