Files
ioccc/bin/subst.winner-navbar.awk
T
Landon Curt Noll c6e6201209 release readme2index.sh version 1.0 2024-01-14
The initial release of `bin/readme2index.sh` tool that converts
`READMD.md` and various JSON files such as `.winner.json`
as well as "author/author_handle.json" files.

Applied the `readme2index.sh` tool to generate `2020/ferguson1/index.html`.

We generated the  `2020/ferguson1/index.html` by executing:

```sh
./bin/readme2index.sh -v 3 2020/ferguson1
```

NOTE: This above tool requires **pandoc to be installed**.
See the [pandoc web site](https://pandoc.org) for how
to install.  We used _HomeBrew_ to install it,
but there is also a _macports_ process as well.

NOTE: While the above web page does have formatting issues, it is
a first attempt data driven programmatic web page generation.

Some adjustments can be made by mostly improving `ioccc.css`,
and some perhaps by modifying how `bin/pandoc_wrapper.sh`
invokes pandoc.  But probably most of the improvements can
be made by fixing and improving `ioccc.css`.

TODO: Fix and improve the `2020/ferguson1/index.html`
web page by fixing and improving `ioccc.css`.

Moved scripts and tools needed to generate HTML pages
into a new `/bin` subdirectory.

TODO: Consider getting rid of the [build-ioccc
repo](https://github.com/ioccc-src/build-ioccc) and just use the
`/bin` subdirectory.

NOTE: Some links in the `2020/ferguson1/index.html`
web page do not (yet) exist.

TODO: Once the basic format of the `2020/ferguson1/index.html` web
page is somewhat reasonable, generate `index.html` pages for other
winners.  Generate the year level `index.html' files.
Generate the top level HTML files, including the missing
`location.html` file.

Greatly simplified the `.winner.json` file format,
removing a number of fields that were not strictly needed
for generating an inventory on a `index.html` page.

Updated various versions:

* `bin/gen-author.sh` VERSION="1.3 2024-01-14"
* `bin/gen-inventory.sh` VERSION="1.0 2024-01-14"
* `bin/manifest.winner.json.awk` VERSION="1.0 2024-01-14"
* `bin/pandoc_wrapper.sh` VERSION="1.3 2024-01-14"
* `bin/readme2index.sh` VERSION="1.0 2024-01-14"
* `bin/subst.default.sh` VERSION="1.1 2024-01-14"
* `bin/subst.winner-index.sh` VERSION="1.1 2024-01-14"
* `tmp/gen_path_list.found.sh` VERSION="1.1 2024-01-14"
* `tmp/gen_winner_json.sh` VERSION="1.1 2024-01-14"

The `.winner.json` file format from winner_JSON_format_version
"0.5 2023-11-04" to "1.0 2024-01-14".

All `.winner.json` files have been updated to use the
new `.winner.json` file format.

The manifest (`tmp/manifest.numbers` and `tmp/manifest.csv`) has
updated to use the new `.winner.json` file format.

The following procedure was used to generate the
`tmp/manifest.csv` manifest file:

0. open [manifest.numbers](manifest.numbers) in numbers: modify if/as needed

NOTE: Please try to keep the [manifest.numbers](manifest.numbers) spreadsheet
      in order order.  Use Organize -> Sort -> ((Sort Now)) to sort.

NOTE: Empty fields in the [manifest.numbers](manifest.numbers) spreadsheet
      are not allowed.  By default, a cell that is empty is colored
      as a warning.

1. File -> Export To -> CSV...
    * 1a. `[ ]` Include table names (unset)
    * 1b. Text Encoding: Unicode (UTF-8)
    * 1c. Click ((Save..))

2. Save As: manifest.csv
    * 2a. Select the `tmp` directory

3. Click ((Export))
    * 3a. If needed click ((Replace))

4. Execute ./tmp/[fix_csv.sh](fix_csv.sh)

NOTE: You must run the [fix_csv.sh](fix_csv.sh) in the above
      step in order to make the CSV file usable by other tools.

NOTE: If no changes are needed in the above step, the
      original file content will be restored.

5. Execute ./tmp/[gen_path_list.found.sh](gen_path_list.found.sh)

NOTE: The above step silently performs a `make clobber` at the
      top level, and so it takes a bit of time.

NOTE: If no changes are needed in the above step, the
      original file content will be restored.

6. Execute ./tmp/[check_path_list.sh](check_path_list.sh)

NOTE: The above step prints nothing and for an exit 0, then
      all is well.  If there is a problem, such as files
      found that are not part of the manifest, or files
      in the manifest that are not found, then an error
      message will be printed and the tool will exit non-zero.
      If errors are reported, go back to step 0 and
      correct the errors.

7. Execute ./tmp/[run_all.sh](run_all.sh) ./gen_winner_json.sh

NOTE: The above step will take a few seconds to run.  It will rebuild
      all `.winner.json` files for all winners.

NOTE: If no changes are needed in the above step, the
      original file content will be restored.

8. Execute `git status` and inspect changes

NOTE: Check in changes if and as needed.

NOTE: In a number of shell scripts under `bin/*.sh`,
      and in the `bin/manifest.winner.json.awk` script
      you will find comments of the form:

```
```

This is a note that when tools such as `jnamval` (and `jval` and `jfmt`) are
ready, these gross hacks should be replaced with calls to those tools.
Until they are ready, some must be careful with the layout of JSON files.

A number of bugs and typos have been fixed.

NOTE: Fixing typos in the files touched by this comment is welcome.
      This includes scripts, data files, text files, etc.

The _inventory_order_, _display_as_, _display_via_github_.  and
_winners_text_ fields of the [manifest.numbers](manifest.numbers)
spreadsheet were just set to have some initial values.
As they impact the inventory displayed on `index.html` pages,
their content needs to be improved.

NOTE: Improving the above mentioned fields of the
      [manifest.numbers](manifest.numbers) spreadsheet is welcome.
2024-01-14 22:03:28 -08:00

151 lines
3.6 KiB
Awk
Executable File

#!/usr/bin/env awk
#
# subst.winner-navbar.awk - output substitutions for navbar on behalf of a winner
#
# usage:
#
# awk -v winner_path=YYYY/dir -f bin/subst.winner-navbar.awk YYYY/.year
#
# where:
#
# YYYY IOCCC year or mock
# dir name of winner directory under YYYY
BEGIN {
# setup
#
VERSION="1.0 2024-01-14"
process_next_line = 0; # 1 ==> we found our winner_path, now process the next line
found_winner_path = 0; # 1 ==> we found our winner_path
prev_line = ""; # the previous YYYY/dir line
topnav_phase = "mid"; # topnav name to use (-H topnav=topnav_phase)
# error if github is not set via -v github=REPO_URL
#
if (length(winner_path) == 0) {
exit 200;
}
}
# process YYYY/dir lines
#
$0 ~ /[^\/]+\/[^\/]+/ {
# split line into year (file[1]) and dir (file[2])
#
len = split($0, file, "/");
if (len != 2) {
# ERROR: invalid split of a YYYY/dir line
print "-e 'invalid split of:", $0, "expected 2 part, found:", len "'";
print "-E 201";
exit
}
year = file[1];
dir = file[2];
# if we need the line after we found our winner_path
#
if (process_next_line) {
# process the line after we found our winner_path
#
# report the previous entry for this year
print "-s 'RIGHT_LINK=../" dir "/index.html'";
print "-s 'RIGHT_TEXT=" dir "'";
process_next_line = 0;
# if we found our winner_path
#
} else if (winner_path == $0) {
# in case our our winner_path is the 1st line
#
if (NR == 1) {
# no previous line winner_path is the 1st line
topnav_phase = "first";
}
# process the previous YYYY/dir line with this match
#
if (prev_line) {
# split previous line into year (file[1]) and dir (file[2])
#
prev_len = split(prev_line, file, "/");
if (prev_len != 2) {
# ERROR: invalid split of a previous YYYY/dir line
print "-e 'invalid split of:", prev_line "expected 2 part, found:", prev_len "'";
print "-E 202";
exit
}
prev_year = file[1];
prev_dir = file[2];
if (year != prev_year) {
# ERROR: previous YYYY/dir YYYY does not match current line
print "-e 'previous line:", prev_line "year:", prev_year, "!= current line year:", year "'";
print "-E 203";
}
# report the next entry for this year
print "-s 'LEFT_LINK=../" prev_dir "/index.html'";
print "-s 'LEFT_TEXT=" prev_dir "'";
}
# process our found winner_path
#
# report up link top year index.html
print "-s 'UP_LINK=../index.html'";
print "-s 'UP_TEXT=" year "'";
process_next_line = 1;
found_winner_path = 1;
}
# save the line as the next previous line
#
prev_line = $0;
}
# report any non-YYYY/dir line
#
$0 !~ /[^\/]+\/[^\/]+/ {
# bogus line found
print "-e 'found a non-YYYY/dir line in", ARGV[1] ":", $0 "'";
print "-E 204";
exit
}
END {
# error if github is not set via -v github=REPO_URL
#
if (length(winner_path) == 0) {
print "-e 'ERROR: github variable not set, call with -v github=REPO_URL'";
print "-E 200"; # use 200 to match exit code from BEGIN
exit 200 # use 200 to match exit code from BEGIN
}
# output inventory link information
#
print "-s 'INVENTORY_LINK=#inventory'";
print "-s 'INVENTORY_TEXT=Inventory'";
# case: we did not find our winner_path
#
if (!found_winner_path) {
# ERROR: winner_path was not found
print "-e 'we did not find:", winner_path "'";
print "-E 205";
exit
} else if (process_next_line) {
# no next line winner_path is the last line
topnav_phase = "last";
}
# output the topnav phase name
#
print "-H 'topnav=" topnav_phase "'";
}