From 93d32d32e0308ce3444cd5c93db44a1d5d6647a1 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Sun, 21 Apr 2024 14:00:12 -0700 Subject: [PATCH] improve location.html Add request for help for the "ZZ - Unknown location" authors. Add "Jump to: top" near the bottom. Changed `bin/gen-location.sh` VERSION from to "1.3 2024-04-16" to "1.4 2024-04-21". Improved FAQ 5.5, asking for help for ZZ location authors and making better references to FAQ 6.10 about pull requests. Run `make gen_location gen_top_html` to perform the above. --- bin/gen-location.sh | 20 +++++++++- faq.html | 12 ++++-- faq.md | 17 +++++++-- location.html | 89 ++++++++++++++++++++++++++++++++++++++++++++- 4 files changed, 129 insertions(+), 9 deletions(-) diff --git a/bin/gen-location.sh b/bin/gen-location.sh index b5e8bf7f5..75d9ec410 100755 --- a/bin/gen-location.sh +++ b/bin/gen-location.sh @@ -84,7 +84,7 @@ shopt -s globstar # enable ** to match all files and zero or more directories an # set variables referenced in the usage message # -export VERSION="1.3 2024-04-16" +export VERSION="1.4 2024-04-21" NAME=$(basename "$0") export NAME export V_FLAG=0 @@ -458,6 +458,7 @@ fi { # process unique location_codes found in author_handle JSON files in dictionary order # + export PREV_LOCATION_CODE="." find "$AUTHOR_DIR" -mindepth 1 -maxdepth 1 -type f -name '*.json' -print0 | xargs -0 grep '"location_code".*:' | sed -e 's/^.*: "//' -e 's/",*$//' | @@ -499,11 +500,25 @@ fi # output markdown entry for this location # + if [[ $PREV_LOCATION_CODE != '.' ]]; then + echo '
' + fi if [[ $LOCATION_NAME == "$LOCATION_COMMON_NAME" ]]; then echo "*
**$LOCATION_CODE** - _${LOCATION_NAME}_
" else echo "*
**$LOCATION_CODE** - _${LOCATION_NAME}_ (_${LOCATION_COMMON_NAME}_)
" fi + + # ask for help with location code ZZ (Unknown location) + # + if [[ $LOCATION_CODE == 'ZZ' ]]; then + echo + echo '

**PLEASE HELP** us identify proper locations for these authors!

' + echo '

See [FAQ 5.5](faq.html#fix_author) for how you can help!

' + fi + + # output author count for this location + # echo echo " Author count: **$AUTHOR_COUNT**" echo @@ -540,7 +555,10 @@ fi done echo '

' echo + PREV_LOCATION_CODE="$LOCATION_CODE" done + echo '
' + echo '

Jump to: top

' } | if [[ -z $NOOP ]]; then cat >> "$TMP_LOC_MD" diff --git a/faq.html b/faq.html index 271f98625..7ba1c96a8 100644 --- a/faq.html +++ b/faq.html @@ -1893,6 +1893,12 @@ and ask for help. See FAQ 5.3 for information on ope

FAQ 5.5: How may I correct or update IOCCC author information?

+

PLEASE HELP us identify proper locations for IOCCC authors

+

If you know the location of an author listed under:

+

      ZZ - Unknown location

+

or if you find IOCCC author location that is incorrect, +then please submit a pull request, +or at least inform the IOCCC judges.

Authors of IOCCC winning entries are kept in JSON files of the form:

    author/author_handle.json

where author_handle is an author handle. See FAQ 6.5 for more @@ -1901,11 +1907,11 @@ information about author handles.

about authors of IOCCC entries. See FAQ 6.6 for information about the contents of these JSON file and how they are used.

You may update IOCCC author information in a author_handle.json file -by opening a GitHub pull request +by submitting a pull request against the master branch of the ioccc-src/winner repo.

-

Please see FAQ 5.2 How may I submit a fix to an IOCCC -entry. See also the FAQ 6.10 How does someone +

Please see FAQ 5.2 How may I submit a fix to an IOCCC entry.

+

See also the FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request for more information about pull requests.

diff --git a/faq.md b/faq.md index 76c3e9235..de4d1f34a 100644 --- a/faq.md +++ b/faq.md @@ -2552,6 +2552,16 @@ and ask for help. See [FAQ 5.3](#fix_an_entry) for information on opening up an
+#### PLEASE HELP us identify proper locations for IOCCC authors + +If you know the location of an author listed under: + +      **[ZZ - Unknown location](location.html#ZZ)** + +or if you find IOCCC author location that is incorrect, +then **please [submit a pull request](faq.html#pull_request)**, +or at least [inform the IOCCC judges](contact.html). + Authors of IOCCC winning entries are kept in JSON files of the form: ``` @@ -2566,12 +2576,13 @@ about authors of IOCCC entries. See [FAQ 6.6](#author_json) for information about the contents of these JSON file and how they are used. You may update IOCCC author information in a `author_handle.json` file -by opening a [GitHub pull request](https://github.com/ioccc-src/winner/pulls) +by [submitting a pull request](faq.html#pull_request) against the master [branch](https://github.com/ioccc-src/winner/branches) of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner). -Please see [FAQ 5.2 How may I submit a fix to an IOCCC -entry](#fix_an_entry). See also the [FAQ 6.10 How does someone +Please see [FAQ 5.2 How may I submit a fix to an IOCCC entry](#fix_an_entry). + +See also the [FAQ 6.10 How does someone make a change to a file and submit that change as a GitHub pull request](#ull_request) for more information about pull requests. diff --git a/location.html b/location.html index d6c4e2d2f..467d40bfe 100644 --- a/location.html +++ b/location.html @@ -146,6 +146,9 @@

+ +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +

+PLEASE HELP us identify proper locations for these authors! +

+

+See FAQ 5.5 for how you can help! +

Author count: 46

+
+

+Jump to: top +