From 75c89bd544023ee4f42641eed5133d7f83345ea7 Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Fri, 25 Oct 2024 06:41:45 -0700 Subject: [PATCH] Make authorship comments in bin/ tools consistent --- bin/chk-entry.sh | 16 +++++-- bin/find-invalid-json.sh | 10 ++--- bin/format-headers.sh | 3 +- bin/gen-authors.sh | 14 ++++++- bin/gen-sitemap.sh | 14 +++++-- bin/gen-top-html.sh | 27 ++++++++---- bin/index.html | 91 ++++++++++++++++++---------------------- bin/md2html.cfg | 16 +++++++ bin/output-year-index.sh | 14 ++++++- bin/status2html.sh | 14 ++++++- 10 files changed, 141 insertions(+), 78 deletions(-) diff --git a/bin/chk-entry.sh b/bin/chk-entry.sh index 710ca3773..b52193c31 100755 --- a/bin/chk-entry.sh +++ b/bin/chk-entry.sh @@ -2,9 +2,19 @@ # # chk-entry.sh - check if the files in an entry match the entry's manifest # -# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# This script was written in 2024 by: # -# ... with a slight improvement by Cody Boone Ferguson. +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# with improvements by: +# +# @xexyl +# https://xexyl.net Cody Boone Ferguson +# https://ioccc.xexyl.net +# +# "Because sometimes even the IOCCC Judges need some help." :-) +# +# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. # # Permission to use, copy, modify, and distribute this software and # its documentation for any purpose and without fee is hereby granted, @@ -24,8 +34,6 @@ # OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. # -# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ -# # Share and enjoy! :-) diff --git a/bin/find-invalid-json.sh b/bin/find-invalid-json.sh index 80ef4f48a..4cbea9841 100755 --- a/bin/find-invalid-json.sh +++ b/bin/find-invalid-json.sh @@ -2,7 +2,11 @@ # # find-invalid-json.sh - find invalid JSON files # -# The JSON parser jparse was co-developed in 2022 by: +# This script was written in 2024 by Cody Boone Ferguson. +# +# "Because sometimes even the IOCCC Judges need some help." :-) +# +# The JSON parser and its respective tools were co-developed in 2022 by: # # @xexyl # https://xexyl.net Cody Boone Ferguson @@ -10,10 +14,6 @@ # and: # chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ # -# This script was written in 2024 by Cody Boone Ferguson. -# -# "Because sometimes even the IOCCC Judges need some help." :-) -# # "Share and Enjoy!" # -- Sirius Cybernetics Corporation Complaints Division, JSON spec department. :-) diff --git a/bin/format-headers.sh b/bin/format-headers.sh index c0a165b3d..69a7e5653 100755 --- a/bin/format-headers.sh +++ b/bin/format-headers.sh @@ -15,10 +15,11 @@ # acting on all README.md files, it only acts on README.md files under git # control. # +# "Because sometimes even the IOCCC Judges need some help." :-) +# # The Perl code makes sure that for certain headers in the README.md files, # there are the correct number of blank lines before/after. # -# "Because sometimes even the IOCCC Judges need some help." :-) # # Share and enjoy! :-) diff --git a/bin/gen-authors.sh b/bin/gen-authors.sh index afd4557df..1ba9b0311 100755 --- a/bin/gen-authors.sh +++ b/bin/gen-authors.sh @@ -2,9 +2,19 @@ # # gen-authors.sh - create the top level authors.html page # -# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# This script was written in 2024 by: # -# .. with very minor improvements in June 2024 by Cody Boone Ferguson. +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# with improvements by: +# +# @xexyl +# https://xexyl.net Cody Boone Ferguson +# https://ioccc.xexyl.net +# +# "Because sometimes even the IOCCC Judges need some help." :-) +# +# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. # # Permission to use, copy, modify, and distribute this software and # its documentation for any purpose and without fee is hereby granted, diff --git a/bin/gen-sitemap.sh b/bin/gen-sitemap.sh index f1045fde2..933f32784 100755 --- a/bin/gen-sitemap.sh +++ b/bin/gen-sitemap.sh @@ -2,11 +2,17 @@ # # gen-sitemap.sh - generate an xml sitemap # -# This script was improved by Cody Boone Ferguson / @xexyl to use git ls-files -# so that other files that might exist in the directories we search are not -# added to the sitemap. +# This script was written in 2024 by: # -# "Because sometimes even IOCCC Judges need some help." :-) +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# with improvements by: +# +# @xexyl +# https://xexyl.net Cody Boone Ferguson +# https://ioccc.xexyl.net +# +# "Because sometimes even the IOCCC Judges need some help." :-) # # Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. # diff --git a/bin/gen-top-html.sh b/bin/gen-top-html.sh index ddab8b4a1..ef6668ab7 100755 --- a/bin/gen-top-html.sh +++ b/bin/gen-top-html.sh @@ -1,19 +1,29 @@ #!/usr/bin/env bash # -# gen-top-html.sh - generate all or select top level HTML files from markdown files +# gen-top-html.sh - generate all or select top level HTML files from markdown +# files # # We also generate the bin/index.html file from the bin/README.md file. +# # We also generate the inc/index.html file from the inc/README.md file. -# We also generate the archive/historic/index.html file from the archive/historic/README.md file. +# +# We also generate the archive/historic/index.html file from the +# archive/historic/README.md file. +# +# This script was written in 2024 by: +# +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# with improvements by: +# +# @xexyl +# https://xexyl.net Cody Boone Ferguson +# https://ioccc.xexyl.net +# +# "Because sometimes even the IOCCC Judges need some help." :-) # # Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. # -# Cody Boone Ferguson made an improvement where one can specify the select top -# html files to generate to save time. Works just like the script without args -# but if any args are specified and the markdown file exists it will just -# generate that or those html files. This is to save time for some Makefile -# rules that only need update one file. -# # Permission to use, copy, modify, and distribute this software and # its documentation for any purpose and without fee is hereby granted, # provided that the above copyright, this permission notice and text @@ -121,6 +131,7 @@ export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc" # unset TOP_MD_SET declare -ag TOP_MD_SET +TOP_MD_SET+=("about") TOP_MD_SET+=("CODE_OF_CONDUCT") TOP_MD_SET+=("README") TOP_MD_SET+=("author/README") diff --git a/bin/index.html b/bin/index.html index 4618b16c9..9913fb044 100644 --- a/bin/index.html +++ b/bin/index.html @@ -74,13 +74,18 @@
- Location of winning authors + Location of authors
- Bugs and (mis)features + Bugs and (Mis)features + +
+
+ + Thanks for the help
@@ -100,7 +105,7 @@
- Contest status + Contest Status
@@ -115,6 +120,13 @@ IOCCC Markdown Guidelines + +
+ + IOCCC Security Policy + +
+ @@ -126,7 +138,7 @@
- FAQ + Frequently Asked Questions
@@ -168,6 +180,12 @@
+
+ + About the IOCCC + +
+
The IOCCC Judges @@ -176,31 +194,7 @@
- Contacting the IOCCC - -
- -
- - IOCCC Security Policy - -
- -
- - Thanks for the help - -
- -
- - Website scripts - -
- -
- - Script include files + Contacting the Judges
@@ -246,7 +240,7 @@ - Authors of winning IOCCC entries + Winning Authors @@ -254,9 +248,12 @@ - Bugs and (mis)features + Bugs and (Mis)features + + Thanks for the help + @@ -267,22 +264,25 @@
+ + IOCCC News + + - Contest status + Contest Status Rules and Guidelines - - IOCCC News - - IOCCC Markdown Guidelines + + IOCCC Security Policy +
@@ -309,7 +309,7 @@ - Fixing author info + Updating author info @@ -325,6 +325,10 @@ IOCCC Home + + About the IOCCC + + The IOCCC Judges @@ -332,21 +336,8 @@ Contacting the IOCCC - - - Thanks for the help - - - - Website scripts - - - - Script include files - - diff --git a/bin/md2html.cfg b/bin/md2html.cfg index 90e1cad16..faa7f0d80 100644 --- a/bin/md2html.cfg +++ b/bin/md2html.cfg @@ -67,6 +67,22 @@ # Top level markdown files have no top navigation bar +about.md + -H + navbar=empty + -o + bin/subst.default.sh + -s + TITLE=About the International Obfuscated C Code Contest + -s + DESCRIPTION=What is the IOCCC? + -s + KEYWORDS=IOCCC, International, Obfuscated, C, c, IOCCC, ioccc, obfuscated, Obfuscate, obfuscate, Landon Curt Noll, chongo, Leonid A. Broukhis, leob + -s + HEADER_2=About the IOCCC + -D + ./ + CODE_OF_CONDUCT.md -H navbar=empty diff --git a/bin/output-year-index.sh b/bin/output-year-index.sh index 22880fb35..03e9181d1 100755 --- a/bin/output-year-index.sh +++ b/bin/output-year-index.sh @@ -27,9 +27,19 @@ # # make gen_year_index # -# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# This script was written in 2024 by: # -# .. with very minor improvements in June 2024 by Cody Boone Ferguson. +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# with improvements by: +# +# @xexyl +# https://xexyl.net Cody Boone Ferguson +# https://ioccc.xexyl.net +# +# "Because sometimes even the IOCCC Judges need some help." :-) +# +# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. # # Permission to use, copy, modify, and distribute this software and # its documentation for any purpose and without fee is hereby granted, diff --git a/bin/status2html.sh b/bin/status2html.sh index 594610ea5..b79c564b5 100755 --- a/bin/status2html.sh +++ b/bin/status2html.sh @@ -18,9 +18,19 @@ # # make gen_status # -# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# This script was written in 2024 by: # -# ... with minor improvements made in June 2024 by Cody Boone Ferguson. +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# with improvements by: +# +# @xexyl +# https://xexyl.net Cody Boone Ferguson +# https://ioccc.xexyl.net +# +# "Because sometimes even the IOCCC Judges need some help." :-) +# +# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. # # Permission to use, copy, modify, and distribute this software and # its documentation for any purpose and without fee is hereby granted,