mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2443 from xexyl/location-1995-authors

Browse Source
This commit is contained in:
Landon Curt Noll authored and GitHub committed 2024-06-17 10:31:20 -07:00
2 parents 3f8c170dec a8500f8aad
commit aee3699ad9
8 files changed
+230 -57
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

1995/heathbar/index.html
+2 -2
View File
@@ -394,10 +394,10 @@
</div>
<ul>
<li>Name: <a href="../../authors.html#Heather_Downs">Heather Downs</a><br>
Location: <a href="../../location.html#ZZ">ZZ</a> - <em>Unknown location</em>
Location: <a href="../../location.html#US">US</a> - <em>United States of America</em> (<em>United States</em>)
<br><br></li>
<li>Name: <a href="../../authors.html#Selene_Makarios">Selene Makarios</a><br>
Location: <a href="../../location.html#ZZ">ZZ</a> - <em>Unknown location</em></li>
Location: <a href="../../location.html#US">US</a> - <em>United States of America</em> (<em>United States</em>)</li>
</ul>
<!-- END: next line ends content generated by: bin/output-index-author.sh -->
1995/makarios/index.html
+2 -2
View File
@@ -394,10 +394,10 @@
</div>
<ul>
<li>Name: <a href="../../authors.html#Heather_Downs">Heather Downs</a><br>
Location: <a href="../../location.html#ZZ">ZZ</a> - <em>Unknown location</em>
Location: <a href="../../location.html#US">US</a> - <em>United States of America</em> (<em>United States</em>)
<br><br></li>
<li>Name: <a href="../../authors.html#Selene_Makarios">Selene Makarios</a><br>
Location: <a href="../../location.html#ZZ">ZZ</a> - <em>Unknown location</em></li>
Location: <a href="../../location.html#US">US</a> - <em>United States of America</em> (<em>United States</em>)</li>
</ul>
<!-- END: next line ends content generated by: bin/output-index-author.sh -->
author/Heather_Downs.json
+3 -3
View File
@@ -4,9 +4,9 @@
"author_handle" : "Heather_Downs",
"full_name" : "Heather Downs",
"sort_word" : "downs",
"location_code" : "ZZ",
"email" : "heather@bungalow.com",
"url" : "http://www.bungalow.com/",
"location_code" : "US",
"email" : null,
"url" : "https://web.archive.org/web/19961019045145/http://www.bungalow.com/",
"alt_url" : null,
"deprecated_twitter_handle" : null,
"mastodon" : null,
author/Selene_Makarios.json
+2 -2
View File
@@ -4,9 +4,9 @@
"author_handle" : "Selene_Makarios",
"full_name" : "Selene Makarios",
"sort_word" : "makarios",
"location_code" : "ZZ",
"location_code" : "US",
"email" : null,
"url" : "http://www.bungalow.com/",
"url" : "https://web.archive.org/web/19961019045145/http://www.bungalow.com/",
"alt_url" : null,
"deprecated_twitter_handle" : null,
"mastodon" : null,
authors.html
+4 -4
View File
@@ -1380,9 +1380,9 @@ author_handle: <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master
</div>
<p>
</p>
Location: <a href="location.html#ZZ">ZZ</a> - <em>Unknown location</em>
Location: <a href="location.html#US">US</a> - <em>United States of America</em> (<em>United States</em>)
<br>
URL: <a href="http://www.bungalow.com/">http://www.bungalow.com/</a>
URL: <a href="https://web.archive.org/web/19961019045145/http://www.bungalow.com/">https://web.archive.org/web/19961019045145/http://www.bungalow.com/</a>
<br>
author_handle: <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/author/Heather_Downs.json">Heather_Downs</a>
<p>
@@ -2583,9 +2583,9 @@ author_handle: <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master
</div>
<p>
</p>
Location: <a href="location.html#ZZ">ZZ</a> - <em>Unknown location</em>
Location: <a href="location.html#US">US</a> - <em>United States of America</em> (<em>United States</em>)
<br>
URL: <a href="http://www.bungalow.com/">http://www.bungalow.com/</a>
URL: <a href="https://web.archive.org/web/19961019045145/http://www.bungalow.com/">https://web.archive.org/web/19961019045145/http://www.bungalow.com/</a>
<br>
author_handle: <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/author/Selene_Makarios.json">Selene_Makarios</a>
<p>
faq.html
+90 -20
View File
@@ -1199,13 +1199,15 @@ hints, especially in cases were something else needs to be installed.</p>
<p>If you have a fix that makes a minimal impact to the entry, then
please consider submitting that change in the form of a pull request.
Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC
entry</a>. See also the <a href="#ull_request">FAQ 6.10 How does someone
entry</a>. See also the <a href="#pull_request">FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<p>In some cases alternative code has been added that does compile on some or most systems. Check the write up for the entry for “alt” code and possible ways to compile and run that code. In some cases we replaced the original code (but not the <code>.orig.c</code> file!) with code
that works for modern systems but one can view the original code in the
<code>.orig.c</code> files (sometimes the original code is also in the directory as a
<code>dirname.alt.c</code> or <code>prog.alt.c</code>).</p>
<p>In some cases alternative code has been added that does compile on some or most
systems. Check the write up for the entry for “alt” code and possible ways to
compile and run that code. In some cases we replaced the original code (but not
the <code>.orig.c</code> file!) with code that works for modern systems but one can view
the original code in the <code>.orig.c</code> files (sometimes the original code is also in
the directory as a <code>dirname.alt.c</code> or <code>prog.alt.c</code>).</p>
<p>It might also be worth noting that almost all entries, have been
fixed so that they can compile in modern systems though just because an entry
compiles does not mean it will run on your specific system.</p>
@@ -1234,7 +1236,7 @@ a pull request with that change. Pull requests that fix such code
while trying to minimize the impact of any changes and preserving
the spirit of the original code are very welcome! Please see <a href="#fix_an_entry">FAQ
5.2 How may I submit a fix to an IOCCC entry</a> for
details. See also the <a href="#ull_request">FAQ 6.10 How does someone make a change to
details. See also the <a href="#pull_request">FAQ 6.10 How does someone make a change to
a file and submit that change as a GitHub pull request</a>
for more information about pull requests.</p>
<div id="faq3_3">
@@ -1269,7 +1271,7 @@ other things that have to be done plus remembering to do it.</p>
that fixes the problem (even if it just a change to the <code>Makefile</code>) that doesn’t
negatively impact the entry too much, consider submitting that change in the
form of a pull request. Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC
entry</a>. See also the <a href="#ull_request">FAQ 6.10 How does someone
entry</a>. See also the <a href="#pull_request">FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<div id="faq3_5">
@@ -1474,8 +1476,8 @@ for downloading, installing and using SDL.</p>
<p>In the case that some entries do not work even with SDL1/SDL2 installed it might
be that you need additional SDL libraries. See the entry’s index.html for
details. If something is not noted you’re welcome to report it as an issue or
fix it and make a new pull request.</p>
<p>See the <a href="#ull_request">FAQ 6.10 How does someone make a change to a file and submit that change
fix it and make a pull request.</p>
<p>See the <a href="#pull_request">FAQ 6.10 How does someone make a change to a file and submit that change
as a GitHub pull request</a> for more information about pull requests.</p>
<div id="faq3_9">
<div id="curses">
@@ -2164,7 +2166,7 @@ fix. If it is accepted we’ll be happy to credit you in the
link to your entries; if you’re not we can link to your website if you wish.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC
entry</a> for information on how to submit a fix to an
IOCCC entry. See also the <a href="#ull_request">FAQ 6.10 How does someone make a change
IOCCC entry. See also the <a href="#pull_request">FAQ 6.10 How does someone make a change
to a file and submit that change as a GitHub pull request</a>
for more information about pull requests.</p>
<div id="faq5_2">
@@ -2185,7 +2187,7 @@ repo</a>.</p>
such as “<em>index.html</em>” files, fixing issues in a “<em>Makefile</em>”, or otherwise
correcting an IOCCC entry is <strong>VERY MUCH WELCOME</strong>! Please use the same
<a href="https://github.com/ioccc-src/winner/pulls">GitHub pull request</a> process against
the master <a href="https://github.com/ioccc-src/winner/branches">branch</a> of the
the <a href="https://github.com/ioccc-src/winner/branches">master branch</a> of the
<a href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a>.</p>
<p>NOTE: some of the issues in the <a href="bugs.html">bugs.html</a> file includes just missing
files and we welcome these too!</p>
@@ -2196,10 +2198,10 @@ IOCCC winning entries are presented!</p>
<p>And of course, an IOCCC author may update their own entries
(metadata as well as source code and any extra files) by opening a
<a href="https://github.com/ioccc-src/winner/pulls">GitHub pull request</a>
against the master <a href="https://github.com/ioccc-src/winner/branches">branch</a>
against the <a href="https://github.com/ioccc-src/winner/branches">master branch</a>
of the <a href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a>.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC
entry</a>. See also the <a href="#ull_request">FAQ 6.10 How does someone
entry</a>. See also the <a href="#pull_request">FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<p>Note that we’re much more inclined to accept an author’s fixes but the judges
@@ -2232,11 +2234,11 @@ to <a href="https://github.com/ioccc-src/winner/issues/new">open a new IOCCC iss
<p>For IOCCC website problems that relate to a particular IOCCC entry, please
see <a href="#fix_an_entry">FAQ 5.2</a> for information on how submit a fix to an IOCCC entry.</p>
<p>You may open a <a href="https://github.com/ioccc-src/winner/pulls">GitHub pull request</a>
against the master <a href="https://github.com/ioccc-src/winner/branches">branch</a>
against the <a href="https://github.com/ioccc-src/winner/branches">master branch</a>
of the <a href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a>
to submit a fix.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC
entry</a>. See also the <a href="#ull_request">FAQ 6.10 How does someone
entry</a>. See also the <a href="#pull_request">FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<h4 id="some-html-files-should-not-be-directly-modified">Some HTML files should NOT be directly modified</h4>
@@ -2263,7 +2265,7 @@ request</a>. There are quicker ways but to be sure you get
everything built you should do this. If you modified a markdown and you do not
see the same file as a html file then you did not complete the fix.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC
entry</a>. See also the <a href="#ull_request">FAQ 6.10 How does someone
entry</a>. See also the <a href="#pull_request">FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<p>In some cases, the HTML file is <strong>NOT</strong> based on markdown content, but instead
@@ -2303,19 +2305,54 @@ about authors of IOCCC entries. See <a href="#author_json">FAQ 6.6</a> for infor
about the contents of these JSON file and how they are used.</p>
<p>You may update IOCCC author information in a <code>author_handle.json</code> file
by <a href="faq.html#pull_request">submitting a pull request</a>
against the master <a href="https://github.com/ioccc-src/winner/branches">branch</a>
against the <a href="https://github.com/ioccc-src/winner/branches">master branch</a>
of the <a href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a>.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC entry</a>.</p>
<p>See also the <a href="#ull_request">FAQ 6.10 How does someone
<p>As these files are JSON you should verify that they are validly formed (e.g. you
didn’t make a typo).</p>
<p>Please make sure that you run <code>make www</code> after updating the file or files. This unfortunately
takes quite a while but it is the safest way to do it. There are other ways to go
about this that can speed things up. Here is one such way which was done when
fixing two authors in 1995 (in one commit as they were the authors of the same
two entries):</p>
<p>First, the two files, <a href="author/Heather_Downs.json">author/Heather_Downs.json</a> and
<a href="author/Selene_Makarios.json">author/Selene_Makarios.json</a> were fixed (the
location was set as <code>ZZ</code> but Cody Boone Ferguson knew from the archive that it
was the US for both of them and he also noticed that the URL, the same for
both, was no longer valid and it was also known that the email was no longer
valid as it referred to the same domain). Thus the <code>location_code</code>, <code>url</code> (it was on the Internet Wayback Machine) and
in one case the <code>email</code> lines to look like:</p>
<pre class="&lt;--json--&gt;"><code> &quot;location_code&quot; : &quot;US&quot;,
&quot;email&quot; : null,
&quot;url&quot; : &quot;https://web.archive.org/web/19961019045145/http://www.bungalow.com/&quot;,</code></pre>
<p>Now since only two entries (the same entries) were won by these two individuals
it means that only two index.html files had to be updated, besides the
<a href="authors.html">authors.html</a> and <a href="location.html">location.html</a> files. These
are: <a href="1995/heathbar/index.html">1995/heathbar/index.html</a> and
<a href="1995/makarios/index.html">1995/makarios/index.html</a>. Thus the following
procedure was done:</p>
<pre class="&lt;!--sh--&gt;"><code> touch 1995/heathbar/README.md 1995/makarios/README.md
make quick_www</code></pre>
<p>That works because the <code>quick_www</code> rule will update the <code>authors.html</code> and
<code>location.html</code> pages and it will also check the timestamps of the <code>index.html</code>
files versus the <code>README.md</code> files. Since they were touched and thus the
timestamp was updated, the
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/quick-readme2index.sh">bin/quick-readme2index.sh</a> tool would
only worry about those two files. This greatly speeds things along.</p>
<p>Once that command finishes a proper <code>git status</code> and <code>git diff</code> shows that
everything is in order. In the end the safest way is to run <code>make www</code>, however.</p>
<p>Please see <a href="#fix_an_entry">FAQ 5.2 How may I submit a fix to an IOCCC entry?</a>.</p>
<p>See also the <a href="#pull_request">FAQ 6.10 How does someone
make a change to a file and submit that change as a GitHub pull
request</a> for more information about pull requests.</p>
<p><strong>FYI</strong>: The <a href="location.html#ZZ">ZZ - Unknown location</a> is used for
historic winning authors whose location or country is not known,
whereas the <a href="location.html#XX">XX - Anonymous location</a> is used when the
winning author does <strong>not wish to disclose their location</strong>.</p>
<h3 id="important-note-about-xx---anonymous-location">Important note about <strong>XX - Anonymous location</strong>:</h3>
<p>Unless you are the author who originally selected the <strong>XX - Anonymous
location</strong>, please do not attempt to change an <strong>XX - Anonymous
location</strong>, without the permission of the original author.</p>
location</strong> without the permission of the original author, as sometimes they
want to have the location known but not their name and/or other details.</p>
<div id="faq5_6">
<div id="fix_link">
<h2 id="faq-5.6-what-should-i-do-if-i-find-a-broken-or-wrong-web-link">FAQ 5.6: What should I do if I find a broken or wrong web link?</h2>
@@ -2535,6 +2572,36 @@ is to look at an example, the <code>author_handle.json</code> file for Yusuke En
{ &quot;entry_id&quot; : &quot;2020_endoh3&quot; }
]
}</code></pre>
<p>Before we walk you through the above JSON document, we will show you how to
validate that the JSON is validly formed.</p>
<div id="validating_json">
<h5 id="validating-json-documents">Validating JSON documents</h5>
</div>
<p>Although special tools (that will validate <code>author_handle.json</code> files) are in
the works (which will be documented here after they are developed) there is a
way to validate all JSON documents including these files. Until those special
tools are developed (which will do the same as this next tool but more) we
request that you validate the JSON with this tool that we co-developed with Cody
Boone Ferguson. This tool, <code>jparse(1)</code>, for the time being is in the
<a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry repo</a> but will later be
in a separate repo. In any case you need to download the repo or <code>git clone</code> it
and then compile it (cd to the directory and then run <code>make</code>). If you wish to
make it easier you can do <code>make install</code> so you can run the tool from any path
but in any case the syntax is:</p>
<pre class="&lt;!--sh--&gt;"><code> jparse foo.json</code></pre>
<p>If the tool exits 0 (and shows no output) then the JSON is valid. If it is
invalid you should get an error but for more details you can increase the
verbosity with the <code>-v</code> flag like:</p>
<pre class="&lt;!--sh--&gt;"><code> jparse -v 3 foo.json</code></pre>
<p>If the tool is not installed then you will obviously have to specify the path of
the tool.</p>
<p>If you wish to validate every JSON file in <code>author/</code> then you could do so like:</p>
<pre class="&lt;!--sh--&gt;"><code> for auth in *.json; do jparse 2&gt;/dev/null &quot;$auth&quot; || echo &quot;$auth is invalid JSON&quot; ; done</code></pre>
<p>If you see any output then it will say which file or files are invalid JSON
(this should not actually happen).</p>
<div id="walk_through_author_json">
<h5 id="walk-through-of-an-author_handle.json-file">Walk through of an <code>author_handle.json</code> file</h5>
</div>
<p>We now will walk thru the above JSON document looking at various JSON members:</p>
<h5 id="no_comment">no_comment</h5>
<pre><code> &quot;no_comment&quot; : &quot;mandatory comment: because comments were removed from the original JSON spec&quot;,</code></pre>
@@ -2654,6 +2721,9 @@ once used:</p>
unknown, it should be the <em>JSON null</em> as the <em>JSON value</em> of this <em>JSON member</em>.
For example:</p>
<pre><code> &quot;deprecated_twitter_handle&quot; : null,</code></pre>
<p>Of course in the future we will not be asking for twitter handles so this means
that unless the winner is a previous winner (before we moved to mastodon) this
will always be <code>null</code> anyway.</p>
<p>NOTE: The <em>JSON null</em> is <strong>NOT</strong> enclosed in quotes!</p>
<h5 id="mastodon">mastodon</h5>
<pre><code> &quot;mastodon&quot; : &quot;@mame@ruby.social&quot;,</code></pre>
faq.md
+123 -20
View File
@@ -1072,12 +1072,14 @@ please consider submitting that change in the form of a pull request.
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.
request](#pull_request) for more information about pull requests.
In some cases alternative code has been added that does compile on some or most systems. Check the write up for the entry for "alt" code and possible ways to compile and run that code. In some cases we replaced the original code (but not the `.orig.c` file!) with code
that works for modern systems but one can view the original code in the
`.orig.c` files (sometimes the original code is also in the directory as a
`dirname.alt.c` or `prog.alt.c`).
In some cases alternative code has been added that does compile on some or most
systems. Check the write up for the entry for "alt" code and possible ways to
compile and run that code. In some cases we replaced the original code (but not
the `.orig.c` file!) with code that works for modern systems but one can view
the original code in the `.orig.c` files (sometimes the original code is also in
the directory as a `dirname.alt.c` or `prog.alt.c`).
It might also be worth noting that almost all entries, have been
fixed so that they can compile in modern systems though just because an entry
@@ -1114,7 +1116,7 @@ while trying to minimize the impact of any changes and preserving
the spirit of the original code are very welcome! Please see [FAQ
5.2 How may I submit a fix to an IOCCC entry](#fix_an_entry) for
details. 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)
a file and submit that change as a GitHub pull request](#pull_request)
for more information about pull requests.
@@ -1161,7 +1163,7 @@ negatively impact the entry too much, consider submitting that change in the
form of a pull request. 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.
request](#pull_request) for more information about pull requests.
<div id="faq3_5">
@@ -1497,10 +1499,10 @@ We recommend trying a method suitable for your environment first, if possible.
In the case that some entries do not work even with SDL1/SDL2 installed it might
be that you need additional SDL libraries. See the entry's index.html for
details. If something is not noted you're welcome to report it as an issue or
fix it and make a new pull request.
fix it and make a pull request.
See 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.
as a GitHub pull request](#pull_request) for more information about pull requests.
<div id="faq3_9">
@@ -2601,7 +2603,7 @@ link to your entries; if you're not we can link to your website if you wish.
Please see [FAQ 5.2 How may I submit a fix to an IOCCC
entry](#fix_an_entry) for information on how to 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](#ull_request)
to a file and submit that change as a GitHub pull request](#pull_request)
for more information about pull requests.
@@ -2626,7 +2628,7 @@ BTW: A **problem** is not limited to the code itself. Fixing typos in files
such as "_index.html_" files, fixing issues in a "_Makefile_", or otherwise
correcting an IOCCC entry is **VERY MUCH WELCOME**! Please use the same
[GitHub pull request](https://github.com/ioccc-src/winner/pulls) process against
the master [branch](https://github.com/ioccc-src/winner/branches) of the
the [master branch](https://github.com/ioccc-src/winner/branches) of the
[ioccc-src/winner repo](https://github.com/ioccc-src/winner).
NOTE: some of the issues in the [bugs.html](bugs.html) file includes just missing
@@ -2641,13 +2643,13 @@ In any event we will happily add you to the
And of course, an IOCCC author may update their own entries
(metadata as well as source code and any extra files) by opening a
[GitHub pull request](https://github.com/ioccc-src/winner/pulls)
against the master [branch](https://github.com/ioccc-src/winner/branches)
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
make a change to a file and submit that change as a GitHub pull
request](#ull_request) for more information about pull requests.
request](#pull_request) for more information about pull requests.
Note that we're much more inclined to accept an author's fixes but the judges
have the final say in the matter.
@@ -2688,14 +2690,14 @@ For IOCCC website problems that relate to a particular IOCCC entry, please
see [FAQ 5.2](#fix_an_entry) for information on how submit a fix to an IOCCC entry.
You may open a [GitHub pull request](https://github.com/ioccc-src/winner/pulls)
against the master [branch](https://github.com/ioccc-src/winner/branches)
against the [master branch](https://github.com/ioccc-src/winner/branches)
of the [ioccc-src/winner repo](https://github.com/ioccc-src/winner)
to submit a fix.
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.
request](#pull_request) for more information about pull requests.
#### Some HTML files should NOT be directly modified
@@ -2734,7 +2736,7 @@ see the same file as a html file then you did not complete the fix.
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.
request](#pull_request) for more information about pull requests.
In some cases, the HTML file is **NOT** based on markdown content, but instead
came from JSON and other data files. So instead of the above reference to a
@@ -2794,23 +2796,71 @@ 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 [submitting a pull request](faq.html#pull_request)
against the master [branch](https://github.com/ioccc-src/winner/branches)
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).
As these files are JSON you should verify that they are validly formed (e.g. you
didn't make a typo).
Please make sure that you run `make www` after updating the file or files. This unfortunately
takes quite a while but it is the safest way to do it. There are other ways to go
about this that can speed things up. Here is one such way which was done when
fixing two authors in 1995 (in one commit as they were the authors of the same
two entries):
First, the two files, [author/Heather_Downs.json](author/Heather_Downs.json) and
[author/Selene_Makarios.json](author/Selene_Makarios.json) were fixed (the
location was set as `ZZ` but Cody Boone Ferguson knew from the archive that it
was the US for both of them and he also noticed that the URL, the same for
both, was no longer valid and it was also known that the email was no longer
valid as it referred to the same domain). Thus the `location_code`, `url` (it was on the Internet Wayback Machine) and
in one case the `email` lines to look like:
``` <--json-->
"location_code" : "US",
"email" : null,
"url" : "https://web.archive.org/web/19961019045145/http://www.bungalow.com/",
```
Now since only two entries (the same entries) were won by these two individuals
it means that only two index.html files had to be updated, besides the
[authors.html](authors.html) and [location.html](location.html) files. These
are: [1995/heathbar/index.html](1995/heathbar/index.html) and
[1995/makarios/index.html](1995/makarios/index.html). Thus the following
procedure was done:
``` <!--sh-->
touch 1995/heathbar/README.md 1995/makarios/README.md
make quick_www
```
That works because the `quick_www` rule will update the `authors.html` and
`location.html` pages and it will also check the timestamps of the `index.html`
files versus the `README.md` files. Since they were touched and thus the
timestamp was updated, the
[bin/quick-readme2index.sh](%%REPO_URL%%/bin/quick-readme2index.sh) tool would
only worry about those two files. This greatly speeds things along.
Once that command finishes a proper `git status` and `git diff` shows that
everything is in order. In the end the safest way is to run `make www`, however.
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.
request](#pull_request) for more information about pull requests.
**FYI**: The [ZZ - Unknown location](location.html#ZZ) is used for
historic winning authors whose location or country is not known,
whereas the [XX - Anonymous location](location.html#XX) is used when the
winning author does **not wish to disclose their location**.
### Important note about **XX - Anonymous location**:
Unless you are the author who originally selected the **XX - Anonymous
location**, please do not attempt to change an **XX - Anonymous
location**, without the permission of the original author.
location** without the permission of the original author, as sometimes they
want to have the location known but not their name and/or other details.
<div id="faq5_6">
@@ -3125,6 +3175,55 @@ As of _Thu Nov 30 23:51:12 UTC 2023_, the contents was as follows:
}
```
Before we walk you through the above JSON document, we will show you how to
validate that the JSON is validly formed.
<div id="validating_json">
##### Validating JSON documents
</div>
Although special tools (that will validate `author_handle.json` files) are in
the works (which will be documented here after they are developed) there is a
way to validate all JSON documents including these files. Until those special
tools are developed (which will do the same as this next tool but more) we
request that you validate the JSON with this tool that we co-developed with Cody
Boone Ferguson. This tool, `jparse(1)`, for the time being is in the
[mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry) but will later be
in a separate repo. In any case you need to download the repo or `git clone` it
and then compile it (cd to the directory and then run `make`). If you wish to
make it easier you can do `make install` so you can run the tool from any path
but in any case the syntax is:
``` <!--sh-->
jparse foo.json
```
If the tool exits 0 (and shows no output) then the JSON is valid. If it is
invalid you should get an error but for more details you can increase the
verbosity with the `-v` flag like:
``` <!--sh-->
jparse -v 3 foo.json
```
If the tool is not installed then you will obviously have to specify the path of
the tool.
If you wish to validate every JSON file in `author/` then you could do so like:
``` <!--sh-->
for auth in *.json; do jparse 2>/dev/null "$auth" || echo "$auth is invalid JSON" ; done
```
If you see any output then it will say which file or files are invalid JSON
(this should not actually happen).
<div id="walk_through_author_json">
##### Walk through of an `author_handle.json` file
</div>
We now will walk thru the above JSON document looking at various JSON members:
@@ -3349,6 +3448,10 @@ For example:
"deprecated_twitter_handle" : null,
```
Of course in the future we will not be asking for twitter handles so this means
that unless the winner is a previous winner (before we moved to mastodon) this
will always be `null` anyway.
NOTE: The _JSON null_ is **NOT** enclosed in quotes!
location.html
+4 -4
View File
@@ -733,7 +733,7 @@
<li><div id="US">
<strong>US</strong> - <em>United States of America</em> (<em>United States</em>)
</div>
<p>Author count: <strong>68</strong></p>
<p>Author count: <strong>70</strong></p>
<ul>
<li><a href="authors.html#Derek_Anderson">Derek Anderson</a></li>
<li><a href="authors.html#Anonymous_1984">Anonymous 1984</a></li>
@@ -755,6 +755,7 @@
<li><a href="authors.html#John_Dalbec">John Dalbec</a></li>
<li><a href="authors.html#Dave_Decot">Dave Decot</a></li>
<li><a href="authors.html#Don_Dodson">Don Dodson</a></li>
<li><a href="authors.html#Heather_Downs">Heather Downs</a></li>
<li><a href="authors.html#Peter_Eastman">Peter Eastman</a></li>
<li><a href="authors.html#Cody_Boone_Ferguson">Cody Boone Ferguson</a></li>
<li><a href="authors.html#Thomas_A_Fine">Thomas A. Fine</a></li>
@@ -772,6 +773,7 @@
<li><a href="authors.html#J_David_Lowe">J. David Lowe</a></li>
<li><a href="authors.html#Ed_Luke">Ed Luke</a></li>
<li><a href="authors.html#Ben_Lynn">Ben Lynn</a></li>
<li><a href="authors.html#Selene_Makarios">Selene Makarios</a></li>
<li><a href="authors.html#Adrian_Mariano">Adrian Mariano</a></li>
<li><a href="authors.html#Eric_Marshall">Eric Marshall</a></li>
<li><a href="authors.html#Ron_McFarland">Ron McFarland</a></li>
@@ -819,7 +821,7 @@
<p>
See <a href="faq.html#fix_author">FAQ 5.5</a> for how you can help!
</p>
<p>Author count: <strong>46</strong></p>
<p>Author count: <strong>44</strong></p>
<ul>
<li><a href="authors.html#Glyn_Anderson">Glyn Anderson</a></li>
<li><a href="authors.html#Anonymous_2005">Anonymous 2005</a></li>
@@ -835,7 +837,6 @@ See <a href="faq.html#fix_author">FAQ 5.5</a> for how you can help!
<li><a href="authors.html#Ferenc_Deak">Ferenc Deak</a></li>
<li><a href="authors.html#Frans_van_Dorsselaer">Frans van Dorsselaer</a></li>
<li><a href="authors.html#Sean_Dorward">Sean Dorward</a></li>
<li><a href="authors.html#Heather_Downs">Heather Downs</a></li>
<li><a href="authors.html#Carlos_Duarte">Carlos Duarte</a></li>
<li><a href="authors.html#Paul_Eggert">Paul Eggert</a></li>
<li><a href="authors.html#Thor_Eldby">Thor Eldby</a></li>
@@ -850,7 +851,6 @@ See <a href="faq.html#fix_author">FAQ 5.5</a> for how you can help!
<li><a href="authors.html#Mike_Laman">Mike Laman</a></li>
<li><a href="authors.html#Oskar_von_der_Luehe">Oskar von der Luehe</a></li>
<li><a href="authors.html#Ed_Lycklama">Ed Lycklama</a></li>
<li><a href="authors.html#Selene_Makarios">Selene Makarios</a></li>
<li><a href="authors.html#Neil_Mix">Neil Mix</a></li>
<li><a href="authors.html#Jeff_Newbern">Jeff Newbern</a></li>
<li><a href="authors.html#Michael_H_Pawka">Michael H. Pawka</a></li>