build index.html for all winners

Updated manifest as per recent file changes. Updated winner `.winner.json` to reflect the manifest changes. Added [bin/all_run.sh](bin/all_run.sh) tool to run a command over all winning entries. These tools had slight improvements in the help usage message: * bin/gen-author.sh VERSION="1.3.1 2024-01-16" * bin/gen-inventory.sh VERSION="1.0.1 2024-01-16" * bin/pandoc_wrapper.sh VERSION="1.3.1 2024-01-16" * bin/subst.default.sh VERSION="1.1.1 2024-01-16" * bin/subst.winner-index.sh VERSION="1.1.1 2024-01-16" The `bin/readme2index.sh` tool was improved so that if the `index.html` file exists and the tool forms the exact same content, then the file `index.html` file is NOT touched. * bin/readme2index.sh VERSION="1.1 2024-01-16" We used the following command to generate `index.html` files for all winning entries: ```sh bin/all_run.sh -v 3 bin/readme2index.sh ``` NOTE: We have not (yet) built HTML files above the winner directory level (e.g., no year level nor top level HTML), nor have be built non-index HTML files for winners. NOTE: By default we are running `pandoc(1)` with: ``` --fail-if-warnings=true ``` This means that any problems with markdown to HTML generates an error. This is done to be sure that the HTML conversion is clean. We had to fix the following `README.md` files: * `2000/rince/README.md` The reference [^2] was never used. We made a guess that [^2] applies to the same spot as [^1]. Perhaps there is a better spot where [^2] applies? NOTE: For every reference, there MUST be some place where that reference is used. * 2012/vik/README.md The string "$...$" is assumed to be a TeX encoded string. NOTE: Every "$..$" needs to be backslashed as in "\$..\$". * 2018/burton1/README.md The reference [2] was duplicated. We changed the second [2] to [3]. NOTE: Every reference needs to have a unique number. * 2020/carlini/README.md The string "$...$" is assumed to be a TeX encoded string. NOTE: Every "$..$" needs to be backslashed as in "\$..\$". We also found 2 errors in the `author/author_handle.json` file set: * author/Anonymous_2001.json The `author/Anonymous_2001.json` file was missing. * author/Jari_Arkko.json The winner ID for `1989_jar.1` had a typo.
2024-01-17 00:32:39 -08:00
1 parent 893cd915b6
commit c1466f5165
@@ -1,4 +1,6 @@
 <!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!-- START: two lines up starts content from: inc/top.default.html -->
 <!-- -->
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
@@ -6,27 +8,268 @@
 <!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <!-- -->
-<!-- file: 1998/tomtorfs/index.html created by: fake.gen_index.sh version: 1.0.5 2023-10-31 -->
-<html lang="en">
+<!-- END: this line ends content from: inc/top.default.html -->
+<!-- -->
+<!-- This file was formed by the tool: bin/readme2index.sh version: 1.1 2024-01-16 -->
+<!-- -->
+<!-- START: this line starts content from: inc/head.default.html -->
+
 <head>
-<meta charset="UTF-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>1998 tomtorfs</title>
-<meta name="description" content="IOCCC year: 1998 IOCCC winner: tomtorfs winner index page">
-<meta name="keywords" content="IOCCC,1998,tomtorfs,winner index page">
+<link rel="stylesheet" href="/temp-test-ioccc/ioccc.css">
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
+<title>1998/tomtorfs</title>
+<meta name="description" content="1998 IOCCC winner tomtorfs">
+<meta name="keywords" content="IOCCC, 1998, IOCCC 1998, IOCCC winner, tomtorfs">
 </head>

+<!-- END: this line ends content from: inc/head.default.html -->
+<!-- START: this line starts content from: inc/body.default.html -->
+
 <body>

-<h1>1998 tomtorfs</h1>
+<!-- END: this line ends content from: inc/body.default.html -->
+<!-- START: this line starts content from: inc/header.default.html -->

-<p>XXX - fake content until readme2index is working - XXX</p>
+<div class="header">
+  <img src="/temp-test-ioccc/png/ioccc.png" alt="IOCCC image by Matt Zucker" width=300 height=110>
+  <h1>The International Obfuscated C Code Contest</h1>
+  <h2>1998/tomtorfs</h2>
+</div>

-<hr style="width:50%;text-align:left;margin-left:0">
+<!-- END: this line ends content from: inc/header.default.html -->
+<!-- START: this line starts content from: inc/topnav.last.html -->

-<!-- Start Nu Html Checker -->
-<p><a href="https://validator.w3.org/nu/?doc=https%3A%2F%2Fioccc-src.github.io%2Ftemp-test-ioccc%2F1998%2Ftomtorfs%2Findex.html">Nu Html check https://ioccc-src.github.io/temp-test-ioccc/1998/tomtorfs/index.html</a></p>
-<!-- End Nu Html Checker -->
+<div class="topnav">
+  <a class="Left" href="../schweikh3/index.html">&larr; schweikh3</a>
+  <a class="Left" href="../index.html">&uarr; 1998 &uarr;</a>
+  <a class="Left Disabled" href="#">last entry</a>
+  <a class="Right" href="#inventory">Inventory</a>
+</div>
+
+<!-- END: this line ends content from: inc/topnav.last.html -->
+<!-- START: this line starts content from: inc/begin-row.default.html -->
+
+<div class="row">
+
+<!-- END: this line ends content from: inc/begin-row.default.html -->
+<!-- START: this line starts content from: inc/begin-leftcolumn.default.html -->
+
+  <div class="leftcolumn">
+
+<!-- END: this line ends content from: inc/begin-leftcolumn.default.html -->
+<!-- START: this line starts content from: inc/sidenav.default.html -->
+
+    <div class="sidenav">
+      <a href="#content">Jump to contents</a>
+    </div>
+    <hr>
+    <div class="sidenav">
+      <a href="/temp-test-ioccc/index.html">IOCCC Home</a>
+      <a href="/temp-test-ioccc/years.html">Winning Entries</a>
+      <a href="/temp-test-ioccc/winners.html">People who have won</a>
+    </div>
+    <hr>
+    <div class="sidenav">
+      <a href="/temp-test-ioccc/news.html">IOCCC News</a>
+      <a href="/temp-test-ioccc/faq.html#submit">How to enter the IOCCC</a>
+      <a href="/temp-test-ioccc/faq.html">FAQ</a>
+    </div>
+    <hr>
+    <div class="sidenav">
+      <a href="/temp-test-ioccc/bugs.html">Bugs &amp; (mis)features</a>
+      <a href="/temp-test-ioccc/faq.html#fix_a_winner">Fixing IOCCC winners</a>
+      <a href="/temp-test-ioccc/faq.html#fix_web_site">Fixing the web site</a>
+      <a href="/temp-test-ioccc/faq.html#fix_author">Fixing winner info</a>
+      <a href="/temp-test-ioccc/thanks-for-help.html">Thanks for the help</a>
+    </div>
+    <hr>
+    <div class="sidenav">
+      <a href="/temp-test-ioccc/judges.html">The IOCCC Judges</a>
+      <a href="/temp-test-ioccc/contact.html">Contacting the IOCCC</a>
+    </div>
+    <hr>
+    <div class="sidenav">
+      <a href="#top">Jump to top</a>
+    </div>
+
+<!-- END: this line ends content from: inc/sidenav.default.html -->
+<!-- START: this line starts content from: inc/end-leftcolumn.default.html -->
+
+  </div>
+
+<!-- END: this line ends content from: inc/end-leftcolumn.default.html -->
+<!-- START: this line starts content from: inc/begin-rightcolumn.default.html -->
+
+  <div class="rightcolumn">
+
+<!-- END: this line ends content from: inc/begin-rightcolumn.default.html -->
+<!-- START: this line starts content from: inc/before-content.default.html -->
+
+    <a name="content"></a>
+
+<!-- END: this line ends content from: inc/before-content.default.html -->
+<!-- START: this line starts content generated by: bin/gen-author.sh -->
+
+<p><a name="author"><strong>Author:</strong></a> <br><br>Name: <a
+href="/temp-test-ioccc/winners.html#Tom_Torfs">Tom Torfs</a><br>
+Location: <a href="/temp-test-ioccc/location.html#null">unknown</a></p>
+
+<!-- END: next line ends content generated by: bin/gen-author.sh -->
+<h2 id="to-build">To build:</h2>
+<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span> all</span></code></pre></div>
+<h2 id="to-use">To use:</h2>
+<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./tomtorfs</span> filename bitwidth polynom reflected init xor</span></code></pre></div>
+<p>where:</p>
+<pre><code>filename  : file to calculate the CRC of
+bitwidth  : width of the CRC in bits (decimal)
+polynom   : polynomial used for the CRC (hexadecimal)
+reflected : 0 if the CRC is not reflected, 1 if it is
+init      : initial value for the CRC (hexadecimal)
+xor       : value to xor the final CRC with (hexadecimal)</code></pre>
+<h2 id="try">Try:</h2>
+<div class="sourceCode" id="cb4"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./try.sh</span></span></code></pre></div>
+<h2 id="judges-remarks">Judges’ remarks:</h2>
+<p>If you don’t believe the program is correct, try and compare the
+output of the program with the value of CRCs computed by PKZIP or any
+other archiver that uses the CRC-32 algorithm.</p>
+<h2 id="authors-remarks">Author’s remarks:</h2>
+<pre><code>Usage:
+./tomtorfs filename bitwidth polynom reflected init xor
+
+filename  : file to calculate the CRC of
+bitwidth  : width of the CRC in bits (decimal)
+polynom   : polynomial used for the CRC (hexadecimal)
+reflected : 0 if the CRC is not reflected, 1 if it is
+init      : initial value for the CRC (hexadecimal)
+xor       : value to xor the final CRC with (hexadecimal)</code></pre>
+<h3 id="examples">Examples</h3>
+<h4 id="crc-16">CRC-16:</h4>
+<div class="sourceCode" id="cb6"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./tomtorfs</span> filename 16 1021 0 FFFF 0000</span></code></pre></div>
+<h4 id="crc-32">CRC-32:</h4>
+<div class="sourceCode" id="cb7"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./tomtorfs</span> filename 32 04C11DB7 1 FFFFFFFF FFFFFFFF</span></code></pre></div>
+<h4 id="xmodem">XMODEM:</h4>
+<div class="sourceCode" id="cb8"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./tomtorfs</span> filename 16 8408 1 0000 0000</span></code></pre></div>
+<h4 id="arc">ARC:</h4>
+<div class="sourceCode" id="cb9"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="ex">./tomtorfs</span> filename 16 8005 1 0000 0000</span></code></pre></div>
+<h3 id="portability-notes">Portability notes</h3>
+<p>The program assumes <code>CHAR_BIT==8</code>. Results are undefined
+if <code>bitwidth &gt; sizeof(unsigned long) * 8</code>. It is also
+assumed that <code>EOF</code> is <code>-1</code> and <code>1</code> is a
+valid exit value to indicate failure (replace them with <code>EOF</code>
+resp. <code>EXIT_FAILURE</code> if the assumptions are false). Otherwise
+ANSI/ISO C.</p>
+<p>No special build options required.</p>
+<h3 id="special-notes">Special notes</h3>
+<p>Count the number of non-whitespace characters in the source file to
+find out what dark force drove me to write this ;-).</p>
+<h3 id="spoiler">Spoiler</h3>
+<p>First of all, if you run a C beautifier on the program (thereby of
+course losing the nice code shape I worked so hard on ;-) ) the code
+will become a bit more readable.</p>
+<p>The variable names are not very descriptive. They have the following
+meanings:</p>
+<pre><code>a = argc
+A = argv
+
+b = array of unsigned long variables
+    b[0] = bit-width of the CRC (argv[2])
+    b[1] = CRC polynomial (argv[3])
+    b[2] = nonzero if CRC is reflected (argv[4])
+    b[3] = initial value of CRC (argv[5])
+    b[4] = value final CRC is XORed with (argv[6])
+    b[5] = CRC value
+    b[6] = byte from file
+    b[7] = counter
+
+B = FILE * through which the file argv[1] is opened
+
+C = typedef for unsigned long</code></pre>
+<p>The first <code>for</code> loop simply reads the command-line
+arguments in the <code>b[]</code> array. The third parameter to
+<code>strtoul(3)</code> causes all arguments to be in base-16 (hex)
+except the first one, which will be in base-10 (decimal).</p>
+<p>The rest of the program “simply” calculates the CRC in
+<code>b[5]</code> and then prints it to <code>stdout</code>. The bit
+reflection loops may appear a bit tricky at first, but if you have a
+good look at them they should become obvious also.</p>
+<h3 id="acknowledgments">Acknowledgments:</h3>
+<p>Ross N. Williams, whose CRC guide was very useful to me for writing
+this. You can find it in <a href="crc.txt">crc.txt</a>.</p>
+<h2 id="copyright-and-cc-by-sa-4.0-license">Copyright and CC BY-SA 4.0
+License:</h2>
+<p>This file is Copyright (c) 2023 by Landon Curt Noll. All Rights
+Reserved. You are free to share and adapt this file under the terms of
+this license:</p>
+<pre><code>Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)</code></pre>
+<p>For more information, see:
+https://creativecommons.org/licenses/by-sa/4.0/</p>
+<!-- START: this line starts content generated by: bin/gen-inventory.sh -->
+
+<h1 id="inventory-for-1998tomtorfs"><a name="inventory"></a>Inventory
+for 1998/tomtorfs</h1>
+<h2 id="primary-files">Primary files</h2>
+<ul>
+<li><a href="index.html">index.html</a> - winner home page</li>
+<li><a
+href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1998/tomtorfs/tomtorfs.c">tomtorfs.c</a>
+- winning source</li>
+<li><a
+href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1998/tomtorfs/Makefile">Makefile</a>
+- winner Makefile</li>
+<li><a
+href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1998/tomtorfs/tomtorfs.orig.c">tomtorfs.orig.c</a>
+- original source</li>
+<li><a
+href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1998/tomtorfs/try.sh">try.sh</a>
+- how to run</li>
+<li><a
+href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1998/tomtorfs/crc.txt">crc.txt</a>
+- painless guide to CRC algorithms</li>
+<li><a href="1998_tomtorfs.tar.bz2">1998_tomtorfs.tar.bz2</a> - download
+winning source</li>
+</ul>
+<h2 id="secondary-files">Secondary files</h2>
+<ul>
+<li><a
+href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1998/tomtorfs/.gitignore">.gitignore</a>
+- list of files that should not be committed under git</li>
+<li><a href=".path">.path</a> - directory path from top directory</li>
+<li><a
+href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1998/tomtorfs/.winner.json">.winner.json</a>
+- description of winner in JSON</li>
+<li><a
+href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/1998/tomtorfs/README.md">README.md</a>
+- markdown source for index.html</li>
+</ul>
+
+<!-- END: next line ends content generated by: bin/gen-inventory.sh -->
+<!-- START: this line starts content from: inc/after-content.default.html -->
+
+<!-- END: this line ends content from: inc/after-content.default.html -->
+<!-- START: this line starts content from: inc/end-rightcolumn.default.html -->
+
+  </div>
+
+<!-- END: this line ends content from: inc/end-rightcolumn.default.html -->
+<!-- START: this line starts content from: inc/end-row.default.html -->
+
+</div>
+
+<!-- END: this line ends content from: inc/end-row.default.html -->
+<!-- START: this line starts content from: inc/footer.default.html -->
+
+<div class="footer">
+  <hr>
+  <h2>Coda</h2>
+  <p><a href="https://validator.w3.org/nu/?doc=https%3A%2F%2Fioccc-src.github.io%2Ftemp-test-ioccc%2F1998%2Ftomtorfs%2Findex.html">Nu HTML check this web page</a></p>
+  <p><a href="#top">Jump to top</a> <a href="#content">Jump to Content</a> <a href="#inventory">Jump to Inventory</a></p>
+</div>
+
+<!-- END: this line ends content from: inc/footer.default.html -->
+<!-- START: this line starts content from: inc/bottom.default.html -->

 </body>
 </html>
+
+<!-- END: this line ends content from: inc/bottom.default.html -->