Links and format fixes in bin/README.md
This completes bin/ except that one file is likely to be moved to bin/ which will mean that the file has to be updated again but not in a big way. Very few top level html files (including inc/ and some other subdirectories that are not the years) have to be checked now, I believe. Some did not require any fixes at all. Still it might be a couple days before this is done. It is hoped that the entry html files will go quicker and then the final FAQ and bugs checks can be done.
This commit is contained in:
1 parent
77cf358704
commit
9751f7d21b
2 files changed
+61
-33
No files matched your search
+32
-18
@@ -326,7 +326,6 @@ Examples of top level HTML pages built by this tool include:
|
|||||||
- [faq.html](../faq.html)
|
- [faq.html](../faq.html)
|
||||||
- [inc/index.html](../inc/index.html)
|
- [inc/index.html](../inc/index.html)
|
||||||
- [index.html](../index.html)
|
- [index.html](../index.html)
|
||||||
- [thanks-for-help.html](../thanks-for-help.html)
|
|
||||||
- [judges.html](../judges.html)
|
- [judges.html](../judges.html)
|
||||||
- [news.html](../news.html)
|
- [news.html](../news.html)
|
||||||
- [thanks-for-help.html](../thanks-for-help.html)
|
- [thanks-for-help.html](../thanks-for-help.html)
|
||||||
@@ -425,7 +424,7 @@ words in [1984](../1984/index.html) it would list, as links, the four winning
|
|||||||
entries, which you can see directly at [1984
|
entries, which you can see directly at [1984
|
||||||
inventory](../1984/index.html#inventory).
|
inventory](../1984/index.html#inventory).
|
||||||
|
|
||||||
This tool is used in the [inc/md2html.cfg](%%REPO_URLH%%/inc/md2html.cfg) file as part of
|
This tool is used in the [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file as part of
|
||||||
the [md2html tool](index.html#md2html).
|
the [md2html tool](index.html#md2html).
|
||||||
|
|
||||||
|
|
||||||
@@ -445,7 +444,7 @@ does not have a non-empty `index.hmtl` file, or if either
|
|||||||
This is useful when only a few entries have been
|
This is useful when only a few entries have been
|
||||||
modified (resulting in an updated `.entry.json` file)
|
modified (resulting in an updated `.entry.json` file)
|
||||||
or if the `README.md` of a few entries have been changed: while the
|
or if the `README.md` of a few entries have been changed: while the
|
||||||
[readme2index.sh](%%REPO_URL%%/bin/readme2index.sh) script takes a few seconds
|
[readme2index.sh](index.html#readme2index) script takes a few seconds
|
||||||
to run for a few entries, when applied to 300+ entries, the extra time can add
|
to run for a few entries, when applied to 300+ entries, the extra time can add
|
||||||
up.
|
up.
|
||||||
|
|
||||||
@@ -688,7 +687,7 @@ We recommend that this tool be invoked via the top level `Makefile` by:
|
|||||||
# How IOCCC HTML content is built
|
# How IOCCC HTML content is built
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
The [md2html.sh](%%REPO_URL%%/bin/md2html.sh) tool is the primary tool that
|
The [md2html.sh](index.html#md2html) tool is the primary tool that
|
||||||
is used to form all IOCCC related HTML pages for the [official IOCCC web
|
is used to form all IOCCC related HTML pages for the [official IOCCC web
|
||||||
site](https://www.ioccc.org).
|
site](https://www.ioccc.org).
|
||||||
|
|
||||||
@@ -777,7 +776,7 @@ It is an error, unless `-S` is given, for any phase, except phases HTML
|
|||||||
20-29, to not substitute all `%%TOKEN%%`s. For phases HTML 20-29, any
|
20-29, to not substitute all `%%TOKEN%%`s. For phases HTML 20-29, any
|
||||||
`%%TOKEN%%` that is not substituted are passed thru without substitution.
|
`%%TOKEN%%` that is not substituted are passed thru without substitution.
|
||||||
|
|
||||||
See the tool [readme2index.sh](%%REPO_URL%%/bin/readme2index.sh) for an example of
|
See the tool [readme2index.sh](index.html#readme2index) for an example of
|
||||||
how HTML phases are implemented.
|
how HTML phases are implemented.
|
||||||
|
|
||||||
|
|
||||||
@@ -916,14 +915,14 @@ modified via the [md2html config file](%%REPO_URL%%/inc/md2html.cfg) may change
|
|||||||
different filename for a given phase.
|
different filename for a given phase.
|
||||||
|
|
||||||
For example when forming the HTML from
|
For example when forming the HTML from
|
||||||
[2020/ferguson1/chocolate-cake.md](%%DOCROOT_SLASH%%2020/ferguson1/chocolate-cake.md),
|
[2020/ferguson1/chocolate-cake.md](%%REPO_URL%%/2020/ferguson1/chocolate-cake.md),
|
||||||
a different `navbar` navigation bar is needed. So instead of the
|
a different `navbar` navigation bar is needed. So instead of the
|
||||||
usual top navigation bar that normally directs people to the previous
|
usual top navigation bar that normally directs people to the previous
|
||||||
entry for the year, or go up to the year page, or to the next entry
|
entry for the year, or go up to the year page, or to the next entry
|
||||||
for the year, a top navigation bar to just go up to the entry's
|
for the year, a top navigation bar to just go up to the entry's
|
||||||
main page is needed. A line in the [md2html config file](%%DOCROOT_SLASH%%inc/md2html.cfg)
|
main page is needed. A line in the [md2html config file](%%REPO_URL%%/inc/md2html.cfg)
|
||||||
that refers to
|
that refers to
|
||||||
[2020/ferguson1/chocolate-cake.md](%%DOCROOT_SLASH%%2020/ferguson1/chocolate-cake.md) may
|
[2020/ferguson1/chocolate-cake.md](%%REPO_URL%%/2020/ferguson1/chocolate-cake.md) may
|
||||||
specify use of `navbar.up2index.html` (as `navbar.up2index`)instead of using the
|
specify use of `navbar.up2index.html` (as `navbar.up2index`)instead of using the
|
||||||
`navbar.default.html` (`navbar.default.html`) default.
|
`navbar.default.html` (`navbar.default.html`) default.
|
||||||
|
|
||||||
@@ -931,11 +930,11 @@ The HTML phase may be skipped resulting in no HTML output during a given phase
|
|||||||
and furthermore, forming no HTML content from a given markdown file altogether.
|
and furthermore, forming no HTML content from a given markdown file altogether.
|
||||||
|
|
||||||
See comments in the [md2html config file](%%REPO_URL%%/inc/md2html.cfg) for details.
|
See comments in the [md2html config file](%%REPO_URL%%/inc/md2html.cfg) for details.
|
||||||
See also, the tool [readme2index.sh](%%REPO_URL%%/bin/readme2index.sh) for an example of
|
See also, the tool [readme2index.sh](index.html#readme2index) for an example of
|
||||||
how such command lines are used.
|
how such command lines are used.
|
||||||
|
|
||||||
|
|
||||||
# Use CAUTION when modifying inc files
|
# Use CAUTION when modifying `inc/` files
|
||||||
|
|
||||||
Some of the files under this directory are used to form **MOST** of the HTML content
|
Some of the files under this directory are used to form **MOST** of the HTML content
|
||||||
on the [official IOCCC website](https://www.ioccc.org).
|
on the [official IOCCC website](https://www.ioccc.org).
|
||||||
@@ -1061,8 +1060,7 @@ C source code, we will do so in such a way that someone will be able to view
|
|||||||
disabled.
|
disabled.
|
||||||
|
|
||||||
The IOCCC will **NOT MANDATE USE OF JavaScript** to view [official IOCCC web
|
The IOCCC will **NOT MANDATE USE OF JavaScript** to view [official IOCCC web
|
||||||
site](https://www.ioccc.org) (except for some mobile devices where it would
|
site](https://www.ioccc.org) (except for some mobile devices for the menu).
|
||||||
otherwise not work).
|
|
||||||
|
|
||||||
For this reason, we cannot use JavaScript include HTML content.
|
For this reason, we cannot use JavaScript include HTML content.
|
||||||
|
|
||||||
@@ -1191,14 +1189,30 @@ The `year` directories reside directly below the top level directory.
|
|||||||
## `.year`
|
## `.year`
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Each `year` directory will have a file under it named:
|
Each `year` directory will have a file under it named `.year`.
|
||||||
|
|
||||||
```
|
|
||||||
.year
|
|
||||||
```
|
|
||||||
|
|
||||||
The contents of the `.year` file is the year string of the directory. For
|
The contents of the `.year` file is the year string of the directory. For
|
||||||
instance, [2020/.year](%%DOCROOT_SLASH%%2020/.year) has the string: `2020`.
|
instance, [2020/.year](%%REPO_URL%%/2020/.year) lists, one directory per line,
|
||||||
|
the directories of the winning entries of that year. For instance, for 2020:
|
||||||
|
|
||||||
|
``` <!--sh-->
|
||||||
|
$ cat 2020/.year
|
||||||
|
2020/burton
|
||||||
|
2020/carlini
|
||||||
|
2020/endoh1
|
||||||
|
2020/endoh2
|
||||||
|
2020/endoh3
|
||||||
|
2020/ferguson1
|
||||||
|
2020/ferguson2
|
||||||
|
2020/giles
|
||||||
|
2020/kurdyukov1
|
||||||
|
2020/kurdyukov2
|
||||||
|
2020/kurdyukov3
|
||||||
|
2020/kurdyukov4
|
||||||
|
2020/otterness
|
||||||
|
2020/tsoj
|
||||||
|
2020/yang
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
<div id="dir">
|
<div id="dir">
|
||||||
|
|||||||
+29
-15
@@ -550,7 +550,6 @@ do that, that is not a problem.</p>
|
|||||||
<li><a href="../faq.html">faq.html</a></li>
|
<li><a href="../faq.html">faq.html</a></li>
|
||||||
<li><a href="../inc/index.html">inc/index.html</a></li>
|
<li><a href="../inc/index.html">inc/index.html</a></li>
|
||||||
<li><a href="../index.html">index.html</a></li>
|
<li><a href="../index.html">index.html</a></li>
|
||||||
<li><a href="../thanks-for-help.html">thanks-for-help.html</a></li>
|
|
||||||
<li><a href="../judges.html">judges.html</a></li>
|
<li><a href="../judges.html">judges.html</a></li>
|
||||||
<li><a href="../news.html">news.html</a></li>
|
<li><a href="../news.html">news.html</a></li>
|
||||||
<li><a href="../thanks-for-help.html">thanks-for-help.html</a></li>
|
<li><a href="../thanks-for-help.html">thanks-for-help.html</a></li>
|
||||||
@@ -606,7 +605,7 @@ the <a href="index.html#md2html">md2html tool</a>.</p>
|
|||||||
words in <a href="../1984/index.html">1984</a> it would list, as links, the four winning
|
words in <a href="../1984/index.html">1984</a> it would list, as links, the four winning
|
||||||
entries, which you can see directly at <a href="../1984/index.html#inventory">1984
|
entries, which you can see directly at <a href="../1984/index.html#inventory">1984
|
||||||
inventory</a>.</p>
|
inventory</a>.</p>
|
||||||
<p>This tool is used in the <a href="%%REPO_URLH%%/inc/md2html.cfg">inc/md2html.cfg</a> file as part of
|
<p>This tool is used in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">inc/md2html.cfg</a> file as part of
|
||||||
the <a href="index.html#md2html">md2html tool</a>.</p>
|
the <a href="index.html#md2html">md2html tool</a>.</p>
|
||||||
<h3 id="pandoc-wrapper.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/pandoc-wrapper.sh">pandoc-wrapper.sh</a></h3>
|
<h3 id="pandoc-wrapper.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/pandoc-wrapper.sh">pandoc-wrapper.sh</a></h3>
|
||||||
<p>Wrapper tool to run <code>pandoc(1)</code>.</p>
|
<p>Wrapper tool to run <code>pandoc(1)</code>.</p>
|
||||||
@@ -619,7 +618,7 @@ does not have a non-empty <code>index.hmtl</code> file, or if either
|
|||||||
<p>This is useful when only a few entries have been
|
<p>This is useful when only a few entries have been
|
||||||
modified (resulting in an updated <code>.entry.json</code> file)
|
modified (resulting in an updated <code>.entry.json</code> file)
|
||||||
or if the <code>README.md</code> of a few entries have been changed: while the
|
or if the <code>README.md</code> of a few entries have been changed: while the
|
||||||
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/readme2index.sh">readme2index.sh</a> script takes a few seconds
|
<a href="index.html#readme2index">readme2index.sh</a> script takes a few seconds
|
||||||
to run for a few entries, when applied to 300+ entries, the extra time can add
|
to run for a few entries, when applied to 300+ entries, the extra time can add
|
||||||
up.</p>
|
up.</p>
|
||||||
<p>If only a few <code>index.hmtl</code> files need updating, then
|
<p>If only a few <code>index.hmtl</code> files need updating, then
|
||||||
@@ -737,7 +736,7 @@ We sort with lines starting with <code>!</code> fourth.</p>
|
|||||||
<div id="how">
|
<div id="how">
|
||||||
<h1 id="how-ioccc-html-content-is-built">How IOCCC HTML content is built</h1>
|
<h1 id="how-ioccc-html-content-is-built">How IOCCC HTML content is built</h1>
|
||||||
</div>
|
</div>
|
||||||
<p>The <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.sh">md2html.sh</a> tool is the primary tool that
|
<p>The <a href="index.html#md2html">md2html.sh</a> tool is the primary tool that
|
||||||
is used to form all IOCCC related HTML pages for the <a href="https://www.ioccc.org">official IOCCC web
|
is used to form all IOCCC related HTML pages for the <a href="https://www.ioccc.org">official IOCCC web
|
||||||
site</a>.</p>
|
site</a>.</p>
|
||||||
<p>Nearly all IOCCC related HTML pages are built from markdown files,
|
<p>Nearly all IOCCC related HTML pages are built from markdown files,
|
||||||
@@ -798,7 +797,7 @@ as well as the markdown content given to the <code>pandoc wrapper tool</code> (<
|
|||||||
<p>It is an error, unless <code>-S</code> is given, for any phase, except phases HTML
|
<p>It is an error, unless <code>-S</code> is given, for any phase, except phases HTML
|
||||||
20-29, to not substitute all <code>%%TOKEN%%</code>s. For phases HTML 20-29, any
|
20-29, to not substitute all <code>%%TOKEN%%</code>s. For phases HTML 20-29, any
|
||||||
<code>%%TOKEN%%</code> that is not substituted are passed thru without substitution.</p>
|
<code>%%TOKEN%%</code> that is not substituted are passed thru without substitution.</p>
|
||||||
<p>See the tool <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/readme2index.sh">readme2index.sh</a> for an example of
|
<p>See the tool <a href="index.html#readme2index">readme2index.sh</a> for an example of
|
||||||
how HTML phases are implemented.</p>
|
how HTML phases are implemented.</p>
|
||||||
<div id="getopt">
|
<div id="getopt">
|
||||||
<h2 id="getopt-phase-processing-of-the-command-line">getopt phase processing of the command line</h2>
|
<h2 id="getopt-phase-processing-of-the-command-line">getopt phase processing of the command line</h2>
|
||||||
@@ -879,22 +878,22 @@ given, only a warning about non-substituted tokens will be written to <code>stde
|
|||||||
modified via the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">md2html config file</a> may change to using a
|
modified via the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">md2html config file</a> may change to using a
|
||||||
different filename for a given phase.</p>
|
different filename for a given phase.</p>
|
||||||
<p>For example when forming the HTML from
|
<p>For example when forming the HTML from
|
||||||
<a href="../2020/ferguson1/chocolate-cake.md">2020/ferguson1/chocolate-cake.md</a>,
|
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/ferguson1/chocolate-cake.md">2020/ferguson1/chocolate-cake.md</a>,
|
||||||
a different <code>navbar</code> navigation bar is needed. So instead of the
|
a different <code>navbar</code> navigation bar is needed. So instead of the
|
||||||
usual top navigation bar that normally directs people to the previous
|
usual top navigation bar that normally directs people to the previous
|
||||||
entry for the year, or go up to the year page, or to the next entry
|
entry for the year, or go up to the year page, or to the next entry
|
||||||
for the year, a top navigation bar to just go up to the entry’s
|
for the year, a top navigation bar to just go up to the entry’s
|
||||||
main page is needed. A line in the <a href="../inc/md2html.cfg">md2html config file</a>
|
main page is needed. A line in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">md2html config file</a>
|
||||||
that refers to
|
that refers to
|
||||||
<a href="../2020/ferguson1/chocolate-cake.md">2020/ferguson1/chocolate-cake.md</a> may
|
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/ferguson1/chocolate-cake.md">2020/ferguson1/chocolate-cake.md</a> may
|
||||||
specify use of <code>navbar.up2index.html</code> (as <code>navbar.up2index</code>)instead of using the
|
specify use of <code>navbar.up2index.html</code> (as <code>navbar.up2index</code>)instead of using the
|
||||||
<code>navbar.default.html</code> (<code>navbar.default.html</code>) default.</p>
|
<code>navbar.default.html</code> (<code>navbar.default.html</code>) default.</p>
|
||||||
<p>The HTML phase may be skipped resulting in no HTML output during a given phase
|
<p>The HTML phase may be skipped resulting in no HTML output during a given phase
|
||||||
and furthermore, forming no HTML content from a given markdown file altogether.</p>
|
and furthermore, forming no HTML content from a given markdown file altogether.</p>
|
||||||
<p>See comments in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">md2html config file</a> for details.
|
<p>See comments in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">md2html config file</a> for details.
|
||||||
See also, the tool <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/readme2index.sh">readme2index.sh</a> for an example of
|
See also, the tool <a href="index.html#readme2index">readme2index.sh</a> for an example of
|
||||||
how such command lines are used.</p>
|
how such command lines are used.</p>
|
||||||
<h1 id="use-caution-when-modifying-inc-files">Use CAUTION when modifying inc files</h1>
|
<h1 id="use-caution-when-modifying-inc-files">Use CAUTION when modifying <code>inc/</code> files</h1>
|
||||||
<p>Some of the files under this directory are used to form <strong>MOST</strong> of the HTML content
|
<p>Some of the files under this directory are used to form <strong>MOST</strong> of the HTML content
|
||||||
on the <a href="https://www.ioccc.org">official IOCCC website</a>.</p>
|
on the <a href="https://www.ioccc.org">official IOCCC website</a>.</p>
|
||||||
<p>These files are used to form <strong>MOST</strong> of the HTML content
|
<p>These files are used to form <strong>MOST</strong> of the HTML content
|
||||||
@@ -975,8 +974,7 @@ C source code, we will do so in such a way that someone will be able to view
|
|||||||
<a href="https://www.ioccc.org">official IOCCC website</a> content with JavaScript
|
<a href="https://www.ioccc.org">official IOCCC website</a> content with JavaScript
|
||||||
disabled.</p>
|
disabled.</p>
|
||||||
<p>The IOCCC will <strong>NOT MANDATE USE OF JavaScript</strong> to view <a href="https://www.ioccc.org">official IOCCC web
|
<p>The IOCCC will <strong>NOT MANDATE USE OF JavaScript</strong> to view <a href="https://www.ioccc.org">official IOCCC web
|
||||||
site</a> (except for some mobile devices where it would
|
site</a> (except for some mobile devices for the menu).</p>
|
||||||
otherwise not work).</p>
|
|
||||||
<p>For this reason, we cannot use JavaScript include HTML content.</p>
|
<p>For this reason, we cannot use JavaScript include HTML content.</p>
|
||||||
<div id="terms">
|
<div id="terms">
|
||||||
<h1 id="ioccc-terms">IOCCC terms</h1>
|
<h1 id="ioccc-terms">IOCCC terms</h1>
|
||||||
@@ -1042,10 +1040,26 @@ Non-numeric <code>year</code> strings are lower case.</p>
|
|||||||
<div id="dot-year">
|
<div id="dot-year">
|
||||||
<h2 id="year-1"><code>.year</code></h2>
|
<h2 id="year-1"><code>.year</code></h2>
|
||||||
</div>
|
</div>
|
||||||
<p>Each <code>year</code> directory will have a file under it named:</p>
|
<p>Each <code>year</code> directory will have a file under it named <code>.year</code>.</p>
|
||||||
<pre><code> .year</code></pre>
|
|
||||||
<p>The contents of the <code>.year</code> file is the year string of the directory. For
|
<p>The contents of the <code>.year</code> file is the year string of the directory. For
|
||||||
instance, <a href="../2020/.year">2020/.year</a> has the string: <code>2020</code>.</p>
|
instance, <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/.year">2020/.year</a> lists, one directory per line,
|
||||||
|
the directories of the winning entries of that year. For instance, for 2020:</p>
|
||||||
|
<pre class="<!--sh-->"><code> $ cat 2020/.year
|
||||||
|
2020/burton
|
||||||
|
2020/carlini
|
||||||
|
2020/endoh1
|
||||||
|
2020/endoh2
|
||||||
|
2020/endoh3
|
||||||
|
2020/ferguson1
|
||||||
|
2020/ferguson2
|
||||||
|
2020/giles
|
||||||
|
2020/kurdyukov1
|
||||||
|
2020/kurdyukov2
|
||||||
|
2020/kurdyukov3
|
||||||
|
2020/kurdyukov4
|
||||||
|
2020/otterness
|
||||||
|
2020/tsoj
|
||||||
|
2020/yang</code></pre>
|
||||||
<h2 id="dir"><code>dir</code></h2>
|
<h2 id="dir"><code>dir</code></h2>
|
||||||
<p>A <code>dir</code> is a POSIX safe string that holds an entry.</p>
|
<p>A <code>dir</code> is a POSIX safe string that holds an entry.</p>
|
||||||
<p>A <code>dir</code> is a string that matches this regexp:</p>
|
<p>A <code>dir</code> is a string that matches this regexp:</p>
|
||||||
|
|||||||
Reference in new issue
Block a user