Run a command on all IOCCC years.
Usage:
bin/all-years.sh -v 1 bin/gen-year-index.sh -v 1Alternate usage:
+If you wish to run instead, for example, chk-entry.sh, then do:
bin/all-years.sh -v 1 bin/chk-entry.shRun a command on all winning entries.
Usage:
bin/all-run.sh -v 3 bin/quick-readme2index.sh -v 1Alternate usage:
+If you wish to run instead, for example, readme2index.sh, then +do:
bin/all-run.sh -v 3 bin/readme2index.sh -v 1Run a command on all IOCCC years.
Usage:
bin/all-years.sh -v 1 bin/gen-year-index.sh -v 1Alternate usage:
+If you wish to run instead, for example, chk-entry.sh, then +do:
bin/all-years.sh -v 1 bin/chk-entry.sh.entry.json files.
-Combine all author/author_handle.JSON files as single JSON file.
+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.
@@ -504,6 +529,9 @@ due to the bogosity of the so-called JSON spec.
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.
NOTE: see the
+FAQ on “author_handle.json”
+for more details on author_handle.json files.
Next this tool processes the non-CSV comment lines in
manifest.csv. The 1st and 2nd fields of
manifest.csv refer to entry YYYY and entry subdirectory (i.e.,
@@ -557,7 +585,10 @@ only modify those .entry.json files when their content changes.
.entry.json file matches the files in the YYYY/dir directory, or even
that the .entry.json contains a manifest (or any of the other required JSON
-content).
+content). Another tool will be modified to do this, at a later date.
+NOTE: you can obtain jparse(1) from the which can be obtained from the
+mkiocccentry repo’s copy of the
+jparse repo.
-N is used i
case this tool does nothing). The compressed tarball, formed by default
under the /var/tmp directory, may contain such as:
YYYY/dir/.info.jsonYYYY/dir/.auth.jsonYYYY/dir/remarks.mdYYYY/dir/README.mdYYYY/dir/index.mdYYYY/dir/YYYY_dir.tar.bz2author/author_handle.json (could be more than one file)Only those files that exist will be put into the compressed tarball.
The compressed tarball formed (by default under the /var/tmp directory)
@@ -598,9 +629,9 @@ is of the following form:
-YYYY_dir.mods.YYYYMMDD.hhmmss.tar.bz2
Here “YYYYMMDD.hhmmss” is a date and timestamp from when the tool was executed.
+Here “YYYYMMDD.hhmmss” is a date and timestamp from when the tool was executed.
The purpose of this compressed tarball is to allow the files in the -submission directory (that could be modified or removed by this tool) +entry directory (that could be modified or removed by this tool) to be restored as follows:
tar -jxvf /var/tmp/YYYY_dir.mods.YYYYMMDD.hhmmss.tar.bz2 YYYY/dirOne may also restore modified author/author_handle.json files using:
This tool will form YYYY/dir/README.md if needed, from YYYY/dir/remarks.md,
template/entry/README.md.head, and template/entry/README.md.tail.
NOTE: This interactive tool (unless -i input_data is used) does
-NOT perform all of the steps needed to make a directory a new winning
+NOT perform all of the steps needed to make a directory for a new winning
IOCCC entry. For example, files such as YYYY/dir/README.md and/or YYYY/dir/index.html
-might contain “triple X” patterns indicating where the Judges
+might contain “triple X” comments (<!--XXXX-->), indicating where the Judges
need to add content. Moreover, the Makefile and .gitignore files
need to be examined for suitability, etc.
HINT: Executing this tool on your submission will NOT make you an IOCCC winner. :-)
@@ -620,7 +651,7 @@ need to be examined for suitability, etc.This tool takes as input, all entry .entry.json files
and updates 3 CSV files:
author_handle followed their entry_idsauthor_handle followed by their entry_idsentry_id followed by the entry’s award titleTOPDIR.
Find all markdown links to local files that do not exist.
-This tool does NOT check that a remote URL exists. -This tool only checks on links to local files.
-This tool does NOT check links in a given place in a file. -This tool only checks that local files linked by markdown exist.
-This tool does NOT check HTML file links. -This tool only checks markdown based links.
+This tool does NOT check that a remote URL exists, it checks on +links to local files.
+This tool does NOT check links in a given place in a file, it +checks that local files linked by markdown actually exist.
+This tool does NOT check HTML file links, it checks markdown +based links.
Usage:
bin/find-missing-links.sh -v 1If no missing links are found, this tool exits 0 with no output -(debug messages not withstanding), otherwise this tool will exit non-zero.
+(debug messages notwithstanding), otherwise this tool will exit non-zero.NOTE: If the markdown link is malformed, this tool might generate an error about a file that does exist. If this tool claims that a file is missing that does exist, @@ -680,7 +711,7 @@ JSON files in the tree.
Usage:
bin/find-invalid-json.sh -v 1If no invalid JSON files are found, this tool exits 0 with no output -(debug messages not withstanding), otherwise this tool will exit non-zero.
+(debug messages notwithstanding), otherwise this tool will exit non-zero.We recommend that this tool be invoked via the top level Makefile:
make find_invalid_jsonThis would generate the sitemap.xml file.
We recommend that this tool be invoked via the top level Makefile:
make gen_sitemapIMPORTANT NOTE: if a file is open with vim or some editor that creates a swap -file, this will cause a problem with the output.
@@ -789,8 +818,7 @@ do that, that is not a problem.The jfmt-wrapper.sh tool is a wrapper
-tool for jfmt(1), a tool that will format a JSON
-# file into a canonical style.
jfmt(1), a tool that will format a JSON file into a canonical style.
NOTE: As of 2024 Oct 08 the jfmt(1) tool has not been written,
so jfmt-wrapper.sh uses the
JSONPath.sh(1) tool from the recently forked and modified
@@ -854,12 +882,12 @@ and not have to use -T with bin/jval-wrapper.sh.
Output manifest csv from a entry’s manifest as found in its .entry.json file.
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.jsonOutput manifest table from a entry’s .entry.json file.
Output manifest table from an entry’s .entry.json file.
awk -v github=REPO_URL -f bin/manifest.entry.json.awk YYYY/dir/.entry.jsonThis tool can modify the top level .allyear file, and YYYY/Makefile files.
NOTE: This tool assumes that new-year.sh was executed to create +
NOTE: This tool assumes that new-year.sh was executed to create
the prerequisite YYYY directory and related files.
HINT: Executing this tool on your submission will NOT make you an IOCCC winner. :-)
-This tool is used by the Judges as part of the final @@ -915,10 +943,10 @@ steps to announce a new set of winning IOCCC entries.
This tool may modify the top level .top and Makefile files.
It will form YYYY/Makefile and/or YYYY/.year if needed.
It will form YYYY/README.md if needed, from template/README.md.year.
NOTE: This tool NOT perform all of the steps needed to make a new IOCCC year directory. +
NOTE: This tool does NOT perform all of the steps needed to make a new IOCCC year directory.
For example, files such as YYYY/README.md and/or YYYY/index.html
-might contain “triple X” patterns indicating where the Judges
-need to add content.
<!-- XXX -->) indicating where the
+Judges need to add content.
Usage:
bin/new-year.sh -v 1 YYYYHere, YYYY must be a new 4-digit (happy :-)) new IOCCC year.
bin/othermd2html.sh YYYY/dir/pathto.mdFor example:
bin/othermd2html.sh -v 1 2020/ferguson1/chocolate-cake.mdThe othermd2html.sh tool is used by gen-other-html.sh.
+The othermd2html.sh tool is used by +gen-other-html.sh.
-Output author’s or authors’ related HTML details for an entry’s index.html +
Output an author’s or authors’ related HTML details for an entry’s index.html page.
For an example, see the author details in 1984/anonymous.
@@ -953,7 +982,7 @@ the md2html tool.Output the inventory for a given year’s winning entries in HTML form. In other words in 1984 it would list, as links, the four winning -entries, which you can see directly at 1984 +entries, which you can see directly at the 1984 inventory.
This tool is used in the bin/md2html.cfg file as part of the md2html tool.
@@ -987,7 +1016,7 @@ modification times forREADME.md, .entry.json,
and index.html are correct. If in doubt, use
readme2index.sh.
We recommend that this tool be invoked via the top level Makefile:
make quick_entry_index make quick_readme2indexFirst, PLEASE read the IOCCC markdown guidelines.
+First, PLEASE read the IOCCC Markdown Guidelines.
Next, while you may put in as much or as little as you wish into your entry’s
remarks.md file, we do have few important suggestions:
We recommend that you explain how to use your entry. Explain the diff --git a/inc/index.html b/inc/index.html index d0c6e7689..7507ac21f 100644 --- a/inc/index.html +++ b/inc/index.html @@ -109,6 +109,12 @@ Rules and Guidelines + +
@@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/inc/topbar.default.html b/inc/topbar.default.html index d43fa980e..534b22e9c 100644 --- a/inc/topbar.default.html +++ b/inc/topbar.default.html @@ -65,6 +65,12 @@ Rules and Guidelines + + @@ -143,8 +149,14 @@ + + @@ -223,6 +235,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -277,6 +293,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/index.html b/index.html index 444a24efa..22e46b572 100644 --- a/index.html +++ b/index.html @@ -109,6 +109,12 @@ Rules and Guidelines + + @@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/judges.html b/judges.html index 242e22679..4571db539 100644 --- a/judges.html +++ b/judges.html @@ -109,6 +109,12 @@ Rules and Guidelines + + @@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/license.html b/license.html index 3655ae37d..328a7c821 100644 --- a/license.html +++ b/license.html @@ -109,6 +109,12 @@ Rules and Guidelines + + @@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/location.html b/location.html index 4bf910568..c9657a8e8 100644 --- a/location.html +++ b/location.html @@ -109,6 +109,12 @@ Rules and Guidelines + + @@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/markdown.html b/markdown.html index 66aae3e6c..ff87d0337 100644 --- a/markdown.html +++ b/markdown.html @@ -12,7 +12,7 @@The IOCCC makes extensive use of markdown. For example, when submitting to the IOCCC diff --git a/news.html b/news.html index be263e3ac..e4e37cc88 100644 --- a/news.html +++ b/news.html @@ -109,6 +109,12 @@ Rules and Guidelines + +
@@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/next/guidelines.html b/next/guidelines.html index 92a360603..169698aaa 100644 --- a/next/guidelines.html +++ b/next/guidelines.html @@ -109,6 +109,12 @@ Rules and Guidelines + + @@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + @@ -1518,7 +1541,7 @@ aware that some people may use tab stop that is different than the common 8 character tab stop. @@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/next/rules.html b/next/rules.html index 44938c791..5eea2637a 100644 --- a/next/rules.html +++ b/next/rules.html @@ -109,6 +109,12 @@ Rules and Guidelines + + @@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + diff --git a/nojs-menu.html b/nojs-menu.html index b8f4c15c4..a60582698 100644 --- a/nojs-menu.html +++ b/nojs-menu.html @@ -109,6 +109,12 @@ Rules and Guidelines + + @@ -187,8 +193,14 @@ + + @@ -267,6 +279,10 @@ IOCCC News + + IOCCC Markdown Guidelines + + @@ -321,6 +337,13 @@ Thanks for the help + + Website scripts + + + + Script include files + @@ -401,6 +424,7 @@