improve markdown to HTML tools, build location.html, authors.html, years.html
Renamed `.winner.json` to `.entry.json` as per recent decisions made for issue #2156. JSON element _winner_JSON_format_version_ renamed to _entry_JSON_format_version_ in `.winner.json`. Changed _entry_JSON_format_version_ from "1.0 2024-01-14" to "1.1 2024-02-11". JSON element _winner_id_ renamed to _entry_id_ in `.entry.json` JSON element _winner_text renamed to _entry_text_ in `.entry.json` JSON element _winner_id_ renamed to _entry_id_ in `author/author_handle.json` files. Changed _author_JSON_format_version_ from "1.0 2023-06-10" to "1.1 2024-02-11". Renamed `tmp/gen_winner_json.sh` to `tmp/gen_entry_json.sh`. Renamed `tmp/example.dot_winner.json` to `tmp/example.dot_entry.json`. Renamed `tmp/winner_id.txt` to `tmp/entry_id.txt`. Renamed `tmp/winner_dir.txt` to `tmp/entry_dir.txt`. Moved outdated `tmp/awards_check.sh` into `tmp/OLD_manifest/awards_check.sh`. Moved outdated `tmp/awards_check.sh` into `tmp/OLD_manifest/awards_check.sh`. Moved outdated `tmp/src/winner_name` into `tmp/OLD_manifest/winner_name`. Moved outdated `tmp/sql` into `tmp/OLD_manifest/sql`. Moved outdated `tmp/template-footer.html` into `tmp/OLD_manifest/template-footer.html`. Moved outdated `tmp/template-header.html` into `tmp/OLD_manifest/template-header.html`. Moved outdated `tmp/template-top.html` into `tmp/OLD_manifest/template-top.html`. Moved outdated `tmp/test.html` into `tmp/OLD_manifest/test.html`. Moved outdated `tmp/fake.gen_index.sh` into `tmp/OLD_manifest/fake.gen_index.sh`. Moved outdated `tmp/old-ioccc.css` into `tmp/OLD_manifest/old-ioccc.css`. Removed winner_name from `tmp/src/Makefile`. Updated `tmp/example.dot_entry.json` to reflect the above JSON changes. Updated `tmp/manifest.numbers` to reflect the above JSON changes. Updated `tmp/README.md` to reflect the above JSON changes. Sorted `tmp/README.md` by existing `tmp` filenames. Updated all `.entry.json` files to reflect the above JSON changes. Updated all `author/author_handle.json` files to reflect the above JSON changes. Added new tool `bin/gen-location.sh` to form the top level file `location.html` from `author/author_handle.json` files! Added new tool `bin/gen-years.sh` to form the top level file `years.html` using `.top`, `.year` and `.entry.json' files! Added new tool `bin/gen-authors.sh` to form a new top level file `/authors.html` from `author/author_handle.json` and related `.entry.json' files! The old `winners.html` file now redirects to the new `authors.html` file. Renamed `bin/gen-author.sh` to `bin/output-index-author.sh`. Renamed `bin/subst.winner-index.sh` to `subst.entry-index.sh`. Renamed `bin/subst.winner-index.awk` to `subst.entry-index.awk`. Renamed `bin/manifest.entry.json.awk` to `bin/manifest.entry.json.awk`. Renamed `bin/gen-inventory.sh` to `bin/output-index-inventory.sh`. Renamed `bin/sort.gitignore` to `bin/sort.gitignore.sh`. Renamed `bin/sgi` to `bin/sgi.sh`. The core logic of converting markdown to HTML has been generalized into a new `bin/md2html.sh` tool. The `bin/readme2index.sh` tool now calls the new `bin/md2html.sh` tool to form entry's `index.html` files. The `bin/quick-readme2index.sh` tool now calls the new `bin/md2html.sh` tool, unless the `index.html` is newer than both `.entry.json` and `README.md`, to form entry `index.html` files. Increased, slightly, the speed of the `bin/quick-readme2index.sh` tool with the entry's `index.html` file does not need to be updated. The `bin/quick-readme2index.sh` tool will touch the `index.html` file, even if the `bin/md2html.sh` tool determines that the `index.html` file did not change, so that the `index.html` file will not appear out of date with respect to `.entry.json`. Slightly improved the look and feel of `index.html` files for entries. The logic of `bin/all-run.sh` has been improved. The initial processing, from first bash version check, thru the -N test, serves as the model for the `bin/readme2index.sh` tool and the `bin/quick-readme2index.sh` tool. There tools now share a common set of command line options. Changed the format of `inc/md2html.cfg` so that for a given "_file_glob_" match, options follow, one per line. The "_file_glob_" is on a line by itself. The option lines that follow must be intended: ``` [12][0-9][0-9][0-9]/README.md -H topnav=year -o bin/subst.default.sh -o bin/subst.year.sh ``` Added "-D ./" to top level markdown files in `inc/md2html.cfg`. The above intending is performed with 1 or more whitespace characters, although we use a leading tab "convention" out of deference to Makefile formats. :-) Once a new "_file_glob_" is found, the set of any previous option lines is said to have ended. The general argument processing logic now makes used of shell arrays. Added checks in the `bin/md2html.sh` tool to disallow a "_file_glob_" of . (dot) as this is used internally to help the shell process the new `inc/md2html.cfg` format. Changed `bin/all-run.sh` VERSION from "1.1.2 2024-01-20" to "1.3 2024-02-11". Changed `bin/output-index-author.sh` VERSION from "1.3.1 2024-01-16" to "1.4 2024-02-11". Changed `bin/pandoc-wrapper.sh` VERSION from "1.3.2 2024-01-19" to "1.4 2024-02-05". Changed `bin/quick-readme2index.sh` VERSION from "1.0 2024-01-20" to "1.1 2024-02-11". Changed `bin/readme2index.sh` VERSION from "1.1.1 2024-01-20" to "1.2 2024-02-11". Changed `bin/subst.default.sh` VERSION from "1.1.1 2024-01-16" to "1.2 2024-02-05". Changed `bin/subst.entry-index.sh` VERSION from "1.1.1 2024-01-16 to "1.2 2024-02-11". Changed `bin/output-index-inventory.sh` VERSION from "1.0.1 2024-01-16" to "1.1 2024-02-11". Changed `bin/manifest.entry.json.awk` from "1.0 2024-01-14" to "1.1 2024-02-11". Changed `bin/sort.gitignore.sh` from "1.0 2024-02-01" to "1.1 2024-02-11". Changed substitution symbol _%%DOCROOT_URL_SLASH%%_ to _%%DOCROOT_SLASH%%_ in various "inc/*.html" files. Moved setting of symbol _%%DOCROOT_SLASH%%_ from `bin/subst.entry-index.sh` to `bin/subst.default.sh`. Changed the variable _$DOCROOT_URL_SLASH_ to _$DOCROOT_SLASH_, in bin tools that use it, to be more descriptive. Removed `-P pandoc_opts` from `bin/*.sh` command lines. The PANDOC_WRAPPER_OPTSTR value is only used in `bin/pandoc-wrapper.sh`. Removed `-B optstr` and `-A optstr` from the `bin/md2html.sh` command line. Removed `[-O tool=optstr ..]` from the `bin/md2html.sh` command line. Removed old use of `-U top_url` from command lines. Add `-w site_url` as sort of a "replacement" for the old `-U top_url`. Added a new `-U URL` to `bin/gen-author.sh`, `bin/output-index-inventory.sh`, `bin/md2html.sh`, `bin/subst.default.sh`, and `bin/subst.entry-index.sh` to allow for the Nu HTML check can use the encoded absolute URL of the HTML page. Added `-t tagline` to most command lines. Added `-T md2html.sh` to most command lines. Added `-D docroot/` to most command lines to set DOCROOT_SLASH. The DOCROOT_SLASH value defaults to "../../" for most in tools, suitable for HTML files under a `YYYY/dir` directory, except for `bin/gen-location.sh` and `gen-entries-html.sh` (as this produces a top level HTML file) and `bin/md2html.sh` (forms files at any level) who use "./" instead. In the case of `bin/output-index-inventory.sh`, `bin/quick-readme2index.sh`, `bin/readme2index.sh`, and `bin/all-run.sh` Helped make the use of exit code in bin tools a bit more consistent. Fixed a number of typos in the bin tools. Added comments for lower level tools such as `manifest.entry.json.awk`, `bin/subst.default.sh`, `bin/subst.entry-index.sh`, and bin/`manifest.entry.json.awk` to indicate how they are usually invoked by other tools. Changed the comments that a new `bin/md2html.sh` tool (that was the `bin/readme2index.sh` tool) would add to a entry's `index.html` file. No longer will it add the tool version number to the comment. Thus, a change in tool version will not force all entry `index.html` files to be modified. Now both the tool adds two comments, one is the _tagline_ to indicate how the markdown content was generated, and one for the new `bin/md2html.sh` tool. For example: ``` <!-- The original markdown content was formed by the tool: bin/quick-readme2index.sh --> <!-- The HTML was converted from markdown by the tool: bin/md2html.sh --> ``` Improve the debugging, especially in regards to changing important exported shell variables, in `bin/md2html.sh`. Other bin tools have their exported shell variables improved somewhat as well. The `bin/README.md` now describes the general _converting markdown to HTML_ procedure including _getopt phases_ and _HTML phases_. Content from `inc/md2html.cfg` and `bin/readme2index.sh` that related to this topic has been centralized into the `bin/README.md` file. Improved formatting of the `bin/README.md` file. Updated it as needed according to the above. Sorted `2011/.year`, `2018/.year`, and `2019/.year` to be in dictionary order. Adjusted ${WINNERS} in year Makefile to use dictionary order so that `make genpath` will produce `.year` files in dictionary order. FYI: We tested this massive set of changes as best as we could. Nevertheless we might have missing something in the JSON changes, `.entry.json` renames, manifest updates, code comments, etc.
This commit is contained in:
Landon Curt Noll committed
1 parent
b23ab491ca
commit
aedb017223
897 files changed
+29985
-27475
No files matched your search
@@ -68,7 +68,7 @@ other inconsistencies with the original entry?](#faq4_3)
|
||||
- [6.4 - Why do you sometimes use the first person plural?](#faq6_4)
|
||||
- [6.5 - What is an author handle?](#faq6_5)
|
||||
- [6.6 - What is a author_handle.json file and how are they used?](#faq6_6)
|
||||
- [6.7 - What is a winner_id?](#faq6_7)
|
||||
- [6.7 - What is a entry_id?](#faq6_7)
|
||||
- [6.8 - What is the purpose of the .top, .year and .path files?](#faq6_8)
|
||||
|
||||
|
||||
@@ -2357,24 +2357,24 @@ As of _Thu Nov 30 23:51:12 UTC 2023_, the contents was as follows:
|
||||
"github" : "@mame",
|
||||
"affiliation" : null,
|
||||
"winning_entry_set" : [
|
||||
{ "winner_id" : "2012_endoh1" },
|
||||
{ "winner_id" : "2012_endoh2" },
|
||||
{ "winner_id" : "2013_endoh1" },
|
||||
{ "winner_id" : "2013_endoh2" },
|
||||
{ "winner_id" : "2013_endoh3" },
|
||||
{ "winner_id" : "2013_endoh4" },
|
||||
{ "winner_id" : "2014_endoh1" },
|
||||
{ "winner_id" : "2014_endoh2" },
|
||||
{ "winner_id" : "2015_endoh1" },
|
||||
{ "winner_id" : "2015_endoh2" },
|
||||
{ "winner_id" : "2015_endoh3" },
|
||||
{ "winner_id" : "2015_endoh4" },
|
||||
{ "winner_id" : "2018_endoh1" },
|
||||
{ "winner_id" : "2018_endoh2" },
|
||||
{ "winner_id" : "2019_endoh" },
|
||||
{ "winner_id" : "2020_endoh1" },
|
||||
{ "winner_id" : "2020_endoh2" },
|
||||
{ "winner_id" : "2020_endoh3" }
|
||||
{ "entry_id" : "2012_endoh1" },
|
||||
{ "entry_id" : "2012_endoh2" },
|
||||
{ "entry_id" : "2013_endoh1" },
|
||||
{ "entry_id" : "2013_endoh2" },
|
||||
{ "entry_id" : "2013_endoh3" },
|
||||
{ "entry_id" : "2013_endoh4" },
|
||||
{ "entry_id" : "2014_endoh1" },
|
||||
{ "entry_id" : "2014_endoh2" },
|
||||
{ "entry_id" : "2015_endoh1" },
|
||||
{ "entry_id" : "2015_endoh2" },
|
||||
{ "entry_id" : "2015_endoh3" },
|
||||
{ "entry_id" : "2015_endoh4" },
|
||||
{ "entry_id" : "2018_endoh1" },
|
||||
{ "entry_id" : "2018_endoh2" },
|
||||
{ "entry_id" : "2019_endoh" },
|
||||
{ "entry_id" : "2020_endoh1" },
|
||||
{ "entry_id" : "2020_endoh2" },
|
||||
{ "entry_id" : "2020_endoh3" }
|
||||
]
|
||||
}
|
||||
```
|
||||
@@ -2433,7 +2433,7 @@ See [FAQ 6.5](#faq6_5) for more information about an author handles.
|
||||
|
||||
Normally the _author_handle_ _JSON value_ should **NOT** be changed
|
||||
**unless there is a strong reason to do so**. If the _JSON value_
|
||||
changes, then all of the `.winner.json` files for all of this authors
|
||||
changes, then all of the `.entry.json` files for all of this authors
|
||||
winning IOCCC entries should also be changed. The _author_handle_
|
||||
_JSON value_ must match the basename (without the leading path and
|
||||
without the trailing `.json`) of the `author_handle.json` file. So
|
||||
@@ -2785,25 +2785,25 @@ NOTE: The _JSON null_ is **NOT** enclosed in quotes!
|
||||
|
||||
|
||||
##### winning_entry_set
|
||||
##### winner_id
|
||||
##### entry_id
|
||||
|
||||
```json
|
||||
"winning_entry_set" : [
|
||||
{ "winner_id" : "2012_endoh1" },
|
||||
{ "winner_id" : "2012_endoh2" },
|
||||
{ "winner_id" : "2013_endoh1" },
|
||||
{ "entry_id" : "2012_endoh1" },
|
||||
{ "entry_id" : "2012_endoh2" },
|
||||
{ "entry_id" : "2013_endoh1" },
|
||||
...
|
||||
{ "winner_id" : "2020_endoh1" },
|
||||
{ "winner_id" : "2020_endoh2" },
|
||||
{ "winner_id" : "2020_endoh3" }
|
||||
{ "entry_id" : "2020_endoh1" },
|
||||
{ "entry_id" : "2020_endoh2" },
|
||||
{ "entry_id" : "2020_endoh3" }
|
||||
]
|
||||
```
|
||||
|
||||
The `winning_entry_set` _JSON member_ holds _JSON array_ containing one or more `winner_id` _JSON member_s.
|
||||
The `winning_entry_set` _JSON member_ holds _JSON array_ containing one or more `entry_id` _JSON member_s.
|
||||
|
||||
There **MUST** be one and only one `winning_entry_set` and the _JSON value_ **MUST**
|
||||
be a non-empty _JSON array_. Each value in that _JSON array_ **MUST** must contain
|
||||
a _JSON member_ whose _JSON name_ **MUST** be "_winner_id_" and those _JSON value_
|
||||
a _JSON member_ whose _JSON name_ **MUST** be "_entry_id_" and those _JSON value_
|
||||
is a valid winner ID.
|
||||
|
||||
Due to the nature of the _So-called JSON spec_, the last value of the `winning_entry_set`
|
||||
@@ -2815,20 +2815,20 @@ See [FAQ 5.5](#faq5_5) for information about how to update
|
||||
and/or correct IOCCC author information.
|
||||
|
||||
|
||||
### <a name="faq6_7"></a><a name="author_json"></a>FAQ 6.7: What is a winner_id?
|
||||
### <a name="faq6_7"></a><a name="author_json"></a>FAQ 6.7: What is a entry_id?
|
||||
|
||||
A `winner_id` is a string that identifies a winning entry of the IOCCC.
|
||||
A `entry_id` is a string that identifies a winning entry of the IOCCC.
|
||||
|
||||
A `winner_id` is a 4-digit year, followed by an underscore, followed by a directory name.
|
||||
A `entry_id` is a 4-digit year, followed by an underscore, followed by a directory name.
|
||||
|
||||
For example, the `winner_id` associated with Cody Boone Ferguson's 2nd winning IOCCC entry
|
||||
For example, the `entry_id` associated with Cody Boone Ferguson's 2nd winning IOCCC entry
|
||||
of 2020 is found under the following directory:
|
||||
|
||||
```
|
||||
2020/ferguson2
|
||||
```
|
||||
|
||||
The `winner_id` for that winning entry is:
|
||||
The `entry_id` for that winning entry is:
|
||||
|
||||
```
|
||||
2020_ferguson2
|
||||
|
||||
Reference in new issue
Block a user