From 70976daa975c9ff58d4610d475eedb96c9e694db Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Thu, 10 Oct 2024 16:54:17 -0700 Subject: [PATCH] add missing bin/index.html Recent changes to `bin/README.md` were not in the previous commit. --- bin/index.html | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/bin/index.html b/bin/index.html index 3163459bd..076127bbf 100644 --- a/bin/index.html +++ b/bin/index.html @@ -436,7 +436,7 @@ some odd need to do so.

all-jfmt.sh

-

canonically format all entry and author JSON files

+

Canonically format all entry and author JSON files

Usage:

    bin/all-jfmt.sh -v 3

Alternate usage:

@@ -478,6 +478,32 @@ the top level Makefile:

NOTE: see the FAQ on “.entry.json files” for more details on .entry.json files.

+
+

combine_author_handle.sh

+
+

Combine all author/author_handle.JSON files as single JSON file.

+

The purpose of this tool is to make looking for information across all +authors faster by temporarily forming them into a single JSON file.

+

Because jsp(1) open remembers the last copy of a given JSON member name. +As such, we change the JSON member name “winning_entry_set” into +a unique “winning_entry_set.FILENO” where FILENO is the file number. +This the JSON member value will be preserved across all files.

+

We also convert where FILENO is the file number and FILENAME is the filename:

+
   "sort_word" : "data",
+

into:

+
   "sort_word.FILENO" : [
+       {
+           "sort_word" : "data FILENAME"
+       }
+   ],
+

This will allow jsp(1) to print sort_word values.

+

We also make sure that the last item from a given file ends in a comma (“,)”, +due to the bogosity of the so-called JSON spec.

+

Usage:

+
    bin/combine_author_handle.sh > combined_author_handle.json
+

NOTE: This tool assume that all JSON files have been formatted with the +bin/jprint-wrapper.sh tool. In particular the first line is just “{:, +and the last line is just”}” and each JSON element is on its own line.

csv2entry.sh

@@ -811,7 +837,17 @@ or if not found, the JSONPath.sh(1) tool from the recently forked a bin/jval-wrapper.sh -q -T author/Anton_Algmyr.json '$.full_name' | jstrdecode -

NOTE: With jstrdecode(1) version 1.2.3 or better, one can use jstrdecode -N and not have to use -T with bin/jval-wrapper.sh.

-
+
+

manifest.csv.entry.awk

+
+

Output manifest csv from a entry’s manifest as found in its .entry.json file.

+
    awk -f bin/manifest.csv.entry.awk YYYY/dir/.entry.json
+ +

Output manifest table from a entry’s .entry.json file.

+
    awk -v github=REPO_URL -f bin/manifest.entry.json.awk YYYY/dir/.entry.json
+

This is a configuration file for the md2html tool.