Move inc/md2html.cfg to bin/

This is a very large commit not only because I forgot to run make www
after updating the menus but I also forgot to do that after the update
to some of the award titles (only quick-readme2index.sh was used).

There is a typo fix in bin/README.md.

This commit does mean that md2html.cfg has to be added to bin/README.md
but that can be done later.

The steps run to verify this works okay:

	make www
	git status
	git diff
	git add -u
	make update
	git status
	git restore $(git check)

The last is important as it is not time for make update. 'git check' is
an alias:

	git diff --name-only
This commit is contained in:
Cody Boone Ferguson committed 2024-06-15 12:40:42 -07:00
1 parent fb59e1203f
commit c60fa3ce7e
401 files changed
+2105 -2095

No files matched your search

+13 -13
View File
@@ -64,7 +64,7 @@ you go through each tool, if you need to understand more of it, we recommend
that you use the `-h` option on it first.
There are some scripts that are invoked by the
[inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file but some of these tools can be directly
[bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file but some of these tools can be directly
invoked as well, should you wish to see their output or if you have some odd
need to do so.
@@ -387,7 +387,7 @@ This is the primary tool that forms IOCCC generated HTML content from
markdown files (permanent markdown files or temporarily generated
markdown files) and HTML fragments from the [inc directory](../inc/index.html).
The [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) configuration file is
The [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) configuration file is
used by [md2html.sh](%%REPO_URL%%/bin/md2html.sh) to drive the generation process.
@@ -401,7 +401,7 @@ page.
For an example, see the [author details in
1984/anonymous](../1984/anonymous/index.html#author).
This tool is used in the [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file as part of
This tool is used in the [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file as part of
the [md2html tool](index.html#md2html).
@@ -413,7 +413,7 @@ Output the inventory in HTML form for an entry's index.html page. For an example
inventory, see the [inventory in
1984/anonymous](../1984/anonymous/index.html#inventory).
This tool is used in the [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file as part of
This tool is used in the [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file as part of
the [md2html tool](index.html#md2html).
@@ -424,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
inventory](../1984/index.html#inventory).
This tool is used in the [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file as part of
This tool is used in the [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file as part of
the [md2html tool](index.html#md2html).
@@ -554,7 +554,7 @@ We recommend that this tool be invoked via the top level `Makefile` by:
Print default substitutions.
This tool is used in the [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file.
This tool is used in the [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file.
<div id="subst-entry-index">
@@ -562,7 +562,7 @@ This tool is used in the [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file.
Print substitutions for an entry's `index.html`.
This tool is used in the [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file.
This tool is used in the [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file.
<div id="subst-entry-navbar-awk">
### [subst.entry-navbar.awk](%%REPO_URL%%/bin/subst.entry-navbar.awk)
@@ -579,7 +579,7 @@ This tool is used in [subst.entry-index.sh](index.html#subst-entry-index).
Print substitutions for a year level `index.html`.
This tool is used in the [inc/md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file.
This tool is used in the [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file.
<div id="subst-year-navbar-awk">
### [subst.year-navbar.awk](%%REPO_URL%%/bin/subst.year-navbar.awk)
@@ -872,7 +872,7 @@ The "output tool" would output the following 4 lines:
The command line options printed by an "output tool" are processed
after all command line options, and all options from a matching
line from the [md2html.cfg](%%REPO_URL%%/inc/md2html.cfg) file, and before any filename arguments
line from the [md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file, and before any filename arguments
on the command line.
For example:
@@ -911,7 +911,7 @@ output), or the command will exit non-zero, unless `-S` is given. If `-S` is
given, only a warning about non-substituted tokens will be written to `stderr`.
The command line of tools in the [bin directory](index.html), and perhaps
modified via the [md2html config file](%%REPO_URL%%/inc/md2html.cfg) may change to using a
modified via the [md2html config file](%%REPO_URL%%/bin/md2html.cfg) may change to using a
different filename for a given phase.
For example when forming the HTML from
@@ -920,7 +920,7 @@ a different `navbar` navigation bar is needed. So instead of the
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
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](%%REPO_URL%%/inc/md2html.cfg)
main page is needed. A line in the [md2html config file](%%REPO_URL%%/bin/md2html.cfg)
that refers to
[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
@@ -929,7 +929,7 @@ specify use of `navbar.up2index.html` (as `navbar.up2index`)instead of using the
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.
See comments in the [md2html config file](%%REPO_URL%%/inc/md2html.cfg) for details.
See comments in the [md2html config file](%%REPO_URL%%/bin/md2html.cfg) for details.
See also, the tool [readme2index.sh](index.html#readme2index) for an example of
how such command lines are used.
@@ -953,7 +953,7 @@ on the [experimental website](https://ioccc-src.github.io/temp-test-ioccc/).
Instead of editing the default HTML files in order to fix a special web page,
consider making a copy of the default file and modifying the [md2html config
file](%%REPO_URL%%/inc/md2html.cfg) to refer to the copy instead. That way your special case
file](%%REPO_URL%%/bin/md2html.cfg) to refer to the copy instead. That way your special case
situation will not impact **MOST** of the HTML content.
+13 -13
View File
@@ -419,7 +419,7 @@ For more details on each tool, including the ones mentioned above, see below. As
you go through each tool, if you need to understand more of it, we recommend
that you use the <code>-h</code> option on it first.</p>
<p>There are some scripts that are invoked by the
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">inc/md2html.cfg</a> file but some of these tools can be directly
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> file but some of these tools can be directly
invoked as well, should you wish to see their output or if you have some odd
need to do so.</p>
<div id="all-run">
@@ -581,7 +581,7 @@ do that, that is not a problem.</p>
<p>This is the primary tool that forms IOCCC generated HTML content from
markdown files (permanent markdown files or temporarily generated
markdown files) and HTML fragments from the <a href="../inc/index.html">inc directory</a>.</p>
<p>The <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">inc/md2html.cfg</a> configuration file is
<p>The <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> configuration file is
used by <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.sh">md2html.sh</a> to drive the generation process.</p>
<div id="output-index-author">
<h3 id="output-index-author.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/output-index-author.sh">output-index-author.sh</a></h3>
@@ -590,7 +590,7 @@ used by <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md
page.</p>
<p>For an example, see the <a href="../1984/anonymous/index.html#author">author details in
1984/anonymous</a>.</p>
<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
<p>This tool is used in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> file as part of
the <a href="index.html#md2html">md2html tool</a>.</p>
<div id="output-index-inventory">
<h3 id="output-index-inventory.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/output-index-inventory.sh">output-index-inventory.sh</a></h3>
@@ -598,14 +598,14 @@ the <a href="index.html#md2html">md2html tool</a>.</p>
<p>Output the inventory in HTML form for an entry’s index.html page. For an example
inventory, see the <a href="../1984/anonymous/index.html#inventory">inventory in
1984/anonymous</a>.</p>
<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
<p>This tool is used in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> file as part of
the <a href="index.html#md2html">md2html tool</a>.</p>
<h3 id="output-year-index.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/output-year-index.sh">output-year-index.sh</a></h3>
<p>Output the inventory for a given year’s winning entries in HTML form. In other
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
inventory</a>.</p>
<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
<p>This tool is used in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> file as part of
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>
<p>Wrapper tool to run <code>pandoc(1)</code>.</p>
@@ -675,11 +675,11 @@ We sort with lines starting with <code>!</code> fourth.</p>
<h3 id="subst.default.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/subst.default.sh">subst.default.sh</a></h3>
</div>
<p>Print default substitutions.</p>
<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.</p>
<p>This tool is used in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> file.</p>
<div id="subst-entry-index">
<h3 id="subst.entry-index.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/subst.entry-index.sh">subst.entry-index.sh</a></h3>
<p>Print substitutions for an entry’s <code>index.html</code>.</p>
<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.</p>
<p>This tool is used in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> file.</p>
<div id="subst-entry-navbar-awk">
<h3 id="subst.entry-navbar.awk"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/subst.entry-navbar.awk">subst.entry-navbar.awk</a></h3>
</div>
@@ -689,7 +689,7 @@ We sort with lines starting with <code>!</code> fourth.</p>
<h3 id="subst.year-index.sh"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/subst.year-index.sh">subst.year-index.sh</a></h3>
</div>
<p>Print substitutions for a year level <code>index.html</code>.</p>
<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.</p>
<p>This tool is used in the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">bin/md2html.cfg</a> file.</p>
<div id="subst-year-navbar-awk">
<h3 id="subst.year-navbar.awk"><a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/subst.year-navbar.awk">subst.year-navbar.awk</a></h3>
</div>
@@ -850,7 +850,7 @@ So for example, if an “output tool” wishes to convey:</p>
navbar=top-of-site</code></pre>
<p>The command line options printed by an “output tool” are processed
after all command line options, and all options from a matching
line from the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">md2html.cfg</a> file, and before any filename arguments
line from the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">md2html.cfg</a> file, and before any filename arguments
on the command line.</p>
<p>For example:</p>
<pre><code> command [command_options ..] [cfg_options ..] [output_tool_options ..] [--] [filename_arg ..]</code></pre>
@@ -875,7 +875,7 @@ some <code>-s token=value</code>) in all HTML output, except during phase number
output), or the command will exit non-zero, unless <code>-S</code> is given. If <code>-S</code> is
given, only a warning about non-substituted tokens will be written to <code>stderr</code>.</p>
<p>The command line of tools in the <a href="index.html">bin directory</a>, and perhaps
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/bin/md2html.cfg">md2html config file</a> may change to using a
different filename for a given phase.</p>
<p>For example when forming the HTML from
<a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/2020/ferguson1/chocolate-cake.md">2020/ferguson1/chocolate-cake.md</a>,
@@ -883,14 +883,14 @@ a different <code>navbar</code> navigation bar is needed. So instead of the
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
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="https://github.com/ioccc-src/temp-test-ioccc/blob/master/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/bin/md2html.cfg">md2html config file</a>
that refers to
<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
<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
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/bin/md2html.cfg">md2html config file</a> for details.
See also, the tool <a href="index.html#readme2index">readme2index.sh</a> for an example of
how such command lines are used.</p>
<h1 id="use-caution-when-modifying-inc-files">Use CAUTION when modifying <code>inc/</code> files</h1>
@@ -903,7 +903,7 @@ on the <a href="https://ioccc-src.github.io/temp-test-ioccc/">experimental websi
<pre><code> *.default.html</code></pre>
<p>… contain default content used to form IOCCC HTML / IOCCC web pages.</p>
<p>Instead of editing the default HTML files in order to fix a special web page,
consider making a copy of the default file and modifying the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/inc/md2html.cfg">md2html config
consider making a copy of the default file and modifying the <a href="https://github.com/ioccc-src/temp-test-ioccc/blob/master/bin/md2html.cfg">md2html config
file</a> to refer to the copy instead. That way your special case
situation will not impact <strong>MOST</strong> of the HTML content.</p>
<h1 id="why-we-do-not-use-certain-well-known-html-technologies">Why we do not use certain well-known HTML technologies</h1>
+478
View File
@@ -0,0 +1,478 @@
#
# md2html.cfg - markdown to HTML configuration
##########
# syntax #
##########
# Comments start with a # symbol and continue to the end of the line.
# Lines are of the form (without any leading whitespace or # of course),
# followed by zero or more lines that has been indented:
#
# file_glob
# cfg_option
# ...
# cfg_option
#
# NOTE: Each "cfg_option" must be in its own line.
#
# NOTE: "file_glob" cannot be a single dot (".").
#
# If one needed to associate the following options with "some_file_glob":
#
# -H navbar=. -o bin/subst.default.sh
#
# you will need 4 intended "cfg_option" lines:
#
# some_file_glob
# -H
# navbar=.
# -o
# bin/subst.default.sh
#
# The above intending is performed with 1 or more whitespace
# characters, although we use a leading tab "convention"
# out of deference to Makefile formats. :-)
#
# Once a new "file_glob" is found, the set of any previous
# option lines is said to have ended.
#
# File paths are evaluated from under the top of the repo. The file_glob should
# NOT start with a leading / and as assumed to be under the topdir directory.
#
# For information on Bash Extended Globbing, see:
#
# https://www.linuxjournal.com/content/bash-extended-globbing
# https://www.gnu.org/software/bash/manual/html_node/Pattern-Matching.html
#
# For a given file, the first 'file_glob' Bash Extended Glob that matches is used.
# If no 'file_glob' matches, the file is ignored, however `bin/md2html.sh` tool
# may still issue a Warning. Moreover this configuration file can use a
# "file_glob" or "*" at the bottom to catch all other files and
# force an error message to be issued as well as to force a non-zero exit
# by the tool.
###################
# HTML generation #
###################
# See the following for more information about how IOCCC html content is built:
#
# https://www.ioccc.org/bin/index.html#how
#################
# Configuration #
#################
# Top level markdown files have no top navigation bar
CODE_OF_CONDUCT.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Contributor Covenant Code of Conduct
-s
KEYWORDS=IOCCC, Contributor Covenant Code of Conduct, Code of Conduct
-s
HEADER_2=IOCCC GitHub repo Contributor Covenant Code of Conduct
-D
./
README.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC GitHub repo README
-s
KEYWORDS=IOCCC, IOCCC GitHub repo README
-s
HEADER_2=About the IOCCC GitHub repo
-D
./
archive/historic/README.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Historic archive of IOCCC winning entries
-s
KEYWORDS=IOCCC, archive, historic, historic archive, IOCCC archive
-s
HEADER_2=Historic archive of IOCCC winning entries
-D
../../
authors.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC Authors and their winning entries
-s
KEYWORDS=IOCCC, entry, entries, Winning entries by author
-s
HEADER_2=Authors of winning IOCCC entries
-D
./
bin/README.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Tools used to build and maintain the IOCCC website
-s
KEYWORDS=IOCCC, tools, website tools, bin
-s
HEADER_2=IOCCC tools used build and maintain the IOCCC website
-D
../
bugs.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Bugs and (mis)features of IOCCC entries
-s
KEYWORDS=IOCCC, Bugs and (mis)features, bugs, features, misfeatures, mis-features
-s
HEADER_2=IOCCC entry Bugs and (mis)features
-D
./
contact.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Contacting the IOCCC Judges
-s
KEYWORDS=IOCCC, contact, Contacting the IOCCC Judges
-s
HEADER_2=How to contact the IOCCC
-D
./
faq.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC FAQ
-s
KEYWORDS=IOCCC, FAQ, questions, answers, Frequently Asked Questions
-s
HEADER_2=Frequently Asked Questions
-D
./
inc/README.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC inc files
-s
KEYWORDS=IOCCC, inc, include files
-s
HEADER_2=Content used by bin tools to help form HTML files
-D
../
index.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=International Obfuscated C Code Contest
-s
KEYWORDS=IOCCC, International, Obfuscated, C, c, IOCCC, ioccc, obfuscated, Obfuscate, obfuscate, Landon Curt Noll, chongo, Leonid A. Broukhis, leob
-H
header=no-header-2
-D
./
judges.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC FAQ
-s
KEYWORDS=IOCCC, FAQ, questions, answers, Frequently Asked Questions
-s
HEADER_2=The Judges of the IOCCC
-D
./
license.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Highlights of some of the key features and terms of the CC BY-SA 4.0 license
-s
KEYWORDS=IOCCC, CC BY-SA 4.0 license, license
-s
HEADER_2=About the CC BY-SA 4.0 license
-D
./
location.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Locations and/or countries of IOCCC Authors
-s
KEYWORDS=IOCCC, IOCCC author by location, IOCCC author by country
-s
HEADER_2=IOCCC author by location and/or country
-D
./
markdown.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC markdown
-s
KEYWORDS=IOCCC, markdown
-s
HEADER_2=IOCCC markdown best practices
-D
./
news.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=News and notices of the IOCCC
-s
KEYWORDS=IOCCC, IOCCC news, news
-s
HEADER_2=IOCCC News
-D
./
next/README.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC Rules and Guidelines
-s
KEYWORDS=IOCCC, rules, Rules, guidelines, Guidelines
-s
HEADER_2=IOCCC Rules and Guidelines
-D
../
next/rules.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC Rules
-s
KEYWORDS=IOCCC, rules, Rules
-s
HEADER_2=IOCCC Rules
-D
../
next/guidelines.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC Guidelines
-s
KEYWORDS=IOCCC, guidelines, Guidelines
-s
HEADER_2=IOCCC Guidelines
-D
../
nojs-menu.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Menu for when JavaScipt is disabled
-s
KEYWORDS=IOCCC, JavaScipt, no-JavaScipt, menu
-s
HEADER_2=JavaScipt is disabled
-D
./
status.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC status
-s
KEYWORDS=IOCCC, status, contest_status, news_update, status_update
-s
HEADER_2=Current status of the IOCCC
-b
bin/status2html.sh
-D
./
thanks-for-help.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=Thanks for all the fixes of IOCCC winning entries
-s
KEYWORDS=IOCCC, thanks, thanx, thank you, ta
-s
HEADER_2=Thanking people for their help
-D
./
years.md
-H
navbar=empty
-o
bin/subst.default.sh
-s
TITLE=The International Obfuscated C Code Contest
-s
DESCRIPTION=IOCCC Winning Entries by Year
-s
KEYWORDS=IOCCC, entry, entries, IOCCC Winning Entries by Year, download IOCCC entry source, IOCCC entry source
-s
HEADER_2=IOCCC Winning Entries by Year
-D
./
# Year level README.md files have a special year navbar
[12][0-9][0-9][0-9]/README.md
-H
footer=inventory
-o
bin/subst.default.sh
-o
bin/subst.year-index.sh
-a
bin/output-year-index.sh
-D
../
# Unless matched above, default process all entry README.md files
[12][0-9][0-9][0-9]/*/README.md
-H
footer=inventory
-o
bin/subst.default.sh
-o
bin/subst.entry-index.sh
-b
bin/output-index-author.sh
-a
bin/output-index-inventory.sh
# Entry markdown files other than README.md files
#
# Navigation bar only moved up to the index for internal markdown files
[12][0-9][0-9][0-9]/*/*.md
-H
navbar=up2index
-s
TITLE=The International Obfuscated C Code Contest
-o
bin/subst.default.sh
# Exit 200 for any markdown file that we have not previously configured
*.md
-e
'markdown file does not match any md2html.cfg line'
-E
200
# Exit 201 for any non-markdown file
*
-e
'filename does not end in .md'
-E
201
+29 -19
View File
@@ -3,7 +3,7 @@
# md2html.sh - convert markdown into an IOCCC HTML file via config file
#
# Convert a markdown file into a HTML file for the IOCCC website,
# using the inc/md2html.cfg configuration file. Conversion from
# using the bin/md2html.cfg configuration file. Conversion from
# markdown to HTML is performed via the 'pandoc wrapper tool'.
#
# For general information on how IOCCC HTML files are generated, see:
@@ -191,7 +191,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
-n go thru the actions, but do not update any files (def: do the action)
-N do not process file, just parse arguments and ignore the file (def: process the file)
-c md2html.cfg Use md2html.cfg as the configuration file (def: use topdir/inc/md2html.cfg)
-c md2html.cfg Use md2html.cfg as the configuration file (def: use topdir/bin/md2html.cfg)
NOTE: -c may only be used in command_options (getopt phase 0)
-H phase=name use 'phase.name.html' file for HTML phase named 'phase' (def: use 'phase.default.html')
@@ -251,7 +251,7 @@ Exit codes:
8 HTML phase file not found or not readable
>= 10 < 39 internal error
>= 40 < 200 HTML phase error
>= 200 error generated via -e exit_code, or via inc/md2html.cfg, or awk script error
>= 200 error generated via -e exit_code, or via bin/md2html.cfg, or awk script error
$NAME version: $VERSION"
@@ -1096,7 +1096,7 @@ fi
# determine working directory
#
# We will use the dirname of match.md as our working directory. This is path from
# topdir, that is to be used to match an entry in the inc/md2html.cfg configuration file.
# topdir, that is to be used to match an entry in the md2html.cfg configuration file.
# In the case of a entry directory, this will be a YYYY/dir working directory.
# In the case of a year level directory, this will be a YYYY working directory.
# In the case of a top level directory, this will be just a . working directory.
@@ -1147,7 +1147,7 @@ if [[ $V_FLAG -ge 3 ]]; then
echo "$0: debug[3]: now in directory: $(/bin/pwd)" 1>&2
fi
# verify that we have a inc subdirectory
# verify that we have an inc subdirectory
#
export INC_PATH="$TOPDIR/inc"
if [[ ! -d $INC_PATH ]]; then
@@ -1156,6 +1156,16 @@ if [[ ! -d $INC_PATH ]]; then
fi
export INC_DIR="inc"
# verify that we have a bin subdirectory
#
export BIN_PATH="$TOPDIR/bin"
if [[ ! -d $BIN_PATH ]]; then
echo "$0: ERROR: bin is not a directory under topdir: $BIN_PATH" 1>&2
exit 6
fi
export BIN_DIR="bin"
# verify that we have a readable .top file
#
export TOP="$TOPDIR/.top"
@@ -1175,7 +1185,7 @@ fi
# verify we have a readable md2html.cfg file
#
if [[ -z $MD2HTML_CFG ]]; then
MD2HTML_CFG="$INC_DIR/md2html.cfg"
MD2HTML_CFG="$BIN_DIR/md2html.cfg"
fi
if [[ ! -e $MD2HTML_CFG ]]; then
echo "$0: ERROR: md2html.cfg does not exist: $MD2HTML_CFG" 1>&2
@@ -1778,7 +1788,7 @@ fi
# HTML phase 0: inc/top.__name__.html #
#######################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
export CUR_PHASE_NUM=0
export CUR_PHASE_NAME="top"
@@ -1797,7 +1807,7 @@ fi
# HTML phase 1: inc/head.__name__.html #
########################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=1
CUR_PHASE_NAME="head"
@@ -1847,7 +1857,7 @@ fi
# HTML phase 2: inc/body.__name__.html #
########################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=2
CUR_PHASE_NAME="body"
@@ -1866,7 +1876,7 @@ fi
# HTML phase 3: inc/topbar.__name__.html #
########################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=3
CUR_PHASE_NAME="topbar"
@@ -1885,7 +1895,7 @@ fi
# HTML phase 4: inc/header.__name__.html #
##########################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=4
CUR_PHASE_NAME="header"
@@ -1904,7 +1914,7 @@ fi
# HTML phase 5: inc/navbar.__name__.html #
##########################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=5
CUR_PHASE_NAME="navbar"
@@ -1923,7 +1933,7 @@ fi
# HTML phase 6: inc/before-content.__name__.html #
###################################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=6
CUR_PHASE_NAME="before-content"
@@ -1942,7 +1952,7 @@ fi
# HTML phase 20: before tool #
##############################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=20
CUR_PHASE_NAME="before-tool"
@@ -2002,7 +2012,7 @@ fi
# HTML phase 21: pandoc wrapper tool #
######################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=21
CUR_PHASE_NAME="pandoc-wrapper-tool"
@@ -2107,7 +2117,7 @@ fi
# HTML phase 22: after tool #
#############################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=22
CUR_PHASE_NAME="after-tool"
@@ -2167,7 +2177,7 @@ fi
# HTML phase 30: inc/after-content.__name__.html #
##################################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=30
CUR_PHASE_NAME="after-content"
@@ -2186,7 +2196,7 @@ fi
# HTML phase 31: inc/footer.__name__.html #
###########################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=31
CUR_PHASE_NAME="footer"
@@ -2205,7 +2215,7 @@ fi
# HTML phase 32: inc/bottom.__name__.html #
###########################################
# NOTE: See inc/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
# NOTE: See bin/md2html.cfg for details on HTML phase numbers, HTML phase names, and HTML phase files
#
CUR_PHASE_NUM=32
CUR_PHASE_NAME="bottom"
+1 -1
View File
@@ -3,7 +3,7 @@
# output-index-author.sh - output author(s) related HTML for an entry's index.html page
#
# This tool is intended to be used as a "before tool" during HTML phase number 20.
# In particular, lines in the inc/md2html.cfg configuration file of the form:
# In particular, lines in the bin/md2html.cfg configuration file of the form:
#
# -b
# bin/output-index-author.sh
+1 -1
View File
@@ -3,7 +3,7 @@
# output-index-inventory.sh - output the inventory in HTML form for an entry's index.html page
#
# This tool is intended to be used as an "after tool" during HTML phase number 22.
# In particular, lines in the inc/md2html.cfg configuration file of the form:
# In particular, lines in the bin/md2html.cfg configuration file of the form:
#
# -a
# bin/output-index-inventory.sh
+2 -2
View File
@@ -2,7 +2,7 @@
#
# output-year-index.sh - output markdown of winning entry links for a given year
#
# This tool is used in conjunction with the inc/md2html.cfg configuration
# This tool is used in conjunction with the bin/md2html.cfg configuration
# file, and the tools that use that use that configuration file such as "bin/md2html.sh".
#
# It is usually invoked by:
@@ -10,7 +10,7 @@
# bin/output-year-index.sh
#
# This tool is intended to be used as an "after tool" during HTML phase number 22.
# In particular, lines in the inc/md2html.cfg configuration file of the form:
# In particular, lines in the bin/md2html.cfg configuration file of the form:
#
# -a
# bin/output-year-index.sh
+1 -1
View File
@@ -3,7 +3,7 @@
# status2html.sh - output status.json HTML for the status.html page
#
# This tool is intended to be used as a "before tool" during HTML phase number 20.
# In particular, lines in the inc/md2html.cfg configuration file of the form:
# In particular, lines in the bin/md2html.cfg configuration file of the form:
#
# -b
# bin/status2html.sh
+1 -1
View File
@@ -2,7 +2,7 @@
#
# subst.default.sh - print default substitutions
#
# This tool is used in conjunction with the inc/md2html.cfg configuration
# This tool is used in conjunction with the bin/md2html.cfg configuration
# file, and the tools that use that use that configuration file such as "bin/md2html.sh".
#
# It is usually invoked by:
+1 -1
View File
@@ -3,7 +3,7 @@
# subst.entry-index.sh - print substitutions for a entry's index.html
#
# This tool is intended to be used as a "output tool" during getopt phases 1 and 3.
# In particular, lines in the inc/md2html.cfg configuration file of the form:
# In particular, lines in the bin/md2html.cfg configuration file of the form:
#
# -o
# bin/subst.entry-index.sh
+1 -1
View File
@@ -3,7 +3,7 @@
# subst.year-index.sh - print substitutions for a year's index.html
#
# This tool is intended to be used as a "output tool" during getopt phases 1 and 3.
# In particular, lines in the inc/md2html.cfg configuration file of the form:
# In particular, lines in the bin/md2html.cfg configuration file of the form:
#
# -o
# bin/subst.year-index.sh