There were several places where a code block was used for text that is
more like a quote (and in one case it is a quote) and these have been
converted to a blockquote.
A few links were added instead of having the link in a code block.
In a case where a paragraph was split with blank lines in between each
line (with the '|' marker at each line) I added a <br> to it so that it
looked more natural.
With the recent changes to this file and the rules file more checks have
to be made as well.
Given how problematic leading tabs in markdown files can be,
we have expanded all leading tabs in markdown files by:
```sh
find * -type f -name '*.md' -print |
while read -r file; do
rm -f "$file.tmp" ;
expand < "$file" > "$file.tmp" ;
mv -f -v "$file.tmp" "$file" ;
done
```
Given the previous changes to `bin/pandoc-wrapper.sh` and other recent
commits and recent pull requests, the were were **NO** changes to
any HTML files. This is a **good thing** as the expression goes.
No there are no leading tabs in any markdown files.
A check to catch any re-introduction of leading tabs
into any markdown file is on the way.
BTW: We do not have anything against leading tabs in files,
even though we have had to deal with their impact on forming
HTML from markdown files (as well as the calc source code).
It is just that this is one of those cases where tabs conflict
(sometimes caused by people wanting to change the classic
8-space tab model) with a desired outcome.
Perform `make www` to perform the above and test under macOS.
The '{', '}' and other chars that are referred to are now in code blocks
(surrounded by single quotes) to help make them stand out better. The
single quotes are there as depending on the person's perception (or if
they're tired or ...) the colour difference might not be enough (in fact
it's barely enough for me at this point and others are more colour blind
than I am). The block quote colour is being experimented with still,
too, so that is another reason to have the 's.
Added make gen_next rule to Makefile which builds next/index.html from
next/README.md, next/rules.html from next/rules.md and
next/guidelines.html from next/guidelines.md. The make help rule was
updated for this.
Each individual IOCCC rule has its own div tag.
References to a specific IOCCC rule is now a link.
We now use the term **IOCCC rules** more consistency when
referring to the rules.
We now use the term **IOCCC guidelines** more consistency when
referring to the guidelines.
In the **IOCCC guidelines**, we use _guideline_ when
referring to a general guideline.
Updated **IOCCC rules** and **IOCCC guidelines** to 2024-06-23-v28.
Added guidelines about the recent Rule 2a changes.
Improved to order of the guidelines related to Rule 2.
Added a ">" formatted quote about the iocccsize summary to the IOCCC guidelines.
Perform `make www` to perform the above and test under macOS.
Changed version from "2024-06-11-v28"
to "2024-06-15-v28'.
Changed all places where a date was used.
Improved the "XXX - date/time is TBD - XXX" message format.
Removed more stuff about tweeting that we no longer do.
Added a few missing | change marks.
As we fixed a rules typo, we went ahead and merged in a few of the
new rules that were pending.
... including the index.{md,html} which was in all caps ..
The bin/README.md file (and index.html) was updated slightly with an
added comma: not strictly necessary but for some it might be easier to
read. This was discovered as I was going through the links (not done
checking them yet but so far so good).
I was asked to actually make corrections in the rules and guidelines and
to make sure that the look and feel seems good. The typos and other
features will be added back later. Some things worth noting below.
First references to twitter were changed to mastodon. I also in some
cases (this should be in the FAQ too and I'm not sure if it is) when
referring to mastodon noted that unless you are mentioned (also if
someone reposts your toot but this is not mentioned as it's not
relevant) you will not get a notification so one should still refresh
the page as otherwise they might not get an update.
The current iocccsize in the mkiocccentry repo checks for 2503 not 2053
like it used to. Only some of the references can be changed to 2503,
however. For why this is read the file!
I changed the word 'historic' to 'historical'. This is because
historical refers to something that happened in the past and the rules
and guidelines are something that existed in the past. On the other hand
historic refers to famous or important in history. Of course that might
be the case here but it felt like in these cases historical was more
correct. This, of course, depends entirely on how you view the rules and
guidelines that are from the previous contest.
This time I modified files in inc: guidelines.closed.hdr and
rules.closed.hdr. This is because the next/guidelines.md and
next/rules.md refer to it as being included (even though it appears that
might not be the case). These files are simply what the top of the
guidelines.md and rules.md files are. I do not know if this is important
but since the markdown files do refer to them I have updated this time
(even though it seems like one has to keep two copies of the same text).
While these are not the 2024 rules and guidelines, they
do contain a number of corrections and updates that are
anticipated for IOCCC28.
Fixed several broken links.
Performed `make www` to complete the above.
Some links were fixed. For instance instead of index.html#enter it's now
the relevant FAQ. A markdown link was broken so that it did not create a
link at all.
Some formatting was updated mostly to make points bold or in code block
(if it's going to be html it might as well especially as they are
important).
And although there were some typo fixes there still are some typos in
there. If you don't know why that is see the FAQ 1.0: How did the IOCCC
get started?. :-) Besides much will be changed in these files by the
judges and the purpose of this commit was to make sure links were valid
and that the files are rendered okay, not to try and change the rules
(although I did update the IOCCC email and make it the 28th IOCCC and
fix the judges [list] .. to make a reference to something recent :-) ).
This commit means that the files under next/ have all been checked. As
usual we all anticipate things to change but some things that were
outdated were corrected (or they were at least partially corrected like
referring to the mkiocccentry repo) to help out a bit.
Temporary files are now of the form:
```
export TMP_AB_CD=".tmp.NAME.AB_CD.$$.tmp"
```
Where `NAME` is the basename of the script, and `AB_CD` is the
part of the exported variable name after the "TMP_".
This will help avoid bugs such as that
commit c7dc9a9f6b had to fix.
Added `.tmp.*` to the top level `.gitignore` file.
Changed `bin/chk-entry.sh` VERSION from "1.1.6 2024-04-13"
to "1.1.7 2024-04-28".
Changed `bin/gen-authors.sh` VERSION from "1.9 2024-04-21"
to "1.9.1 2024-04-28".
Changed `bin/gen-location.sh` VERSION from "1.4 2024-04-21"
to "1.4.1 2024-04-28".
Changed `bin/gen-other-html.sh` VERSION from "1.2.2 2024-04-21"
to "1.2.3 2024-04-28".
Changed `bin/gen-sitemap.sh` VERSION from "1.3.7 2024-04-14"
to "1.3.8 2024-04-28".
Changed `bin/gen-status.sh` VERSION from "1.5 2024-04-22"
to "1.5.1 2024-04-28".
Changed `bin/gen-years.sh` VERSION from "1.3 2024-04-21"
to "1.3.1 2024-04-28".
Changed `bin/md2html.sh` VERSION from "1.5 2024-04-20"
to "1.5.1 2024-04-28".
Changed `bin/output-index-author.sh` VERSION from "1.7 2024-04-15"
to "1.7.1 2024-04-28".
Changed `bin/output-index-inventory.sh` VERSION from "1.4 2024-04-21"
to "1.4.1 2024-04-28".
Changed `bin/output-year-index.sh` VERSION from "1.4 2024-04-21"
to "1.4.1 2024-04-28".
Changed `bin/sort.gitignore.sh` VERSION from "1.1.6 2024-04-13"
to "1.1.7 2024-04-28".
Changed `bin/status2html.sh` VERSION from "1.4 2024-04-18"
to "1.4.1 2024-04-28".
Changed `bin/tar-entry.sh` VERSION from "1.3.5 2024-04-13"
to "1.3.6 2024-04-28".
Changed `bin/tar-year.sh` VERSION from "1.2.3 2024-04-13"
to "1.2.4 2024-04-28".
Ran `make www` to perform test the above under macOS.
Fix the Nu html check URL for `next/rules.html` and `next/guidelines.html`.
Restore building `next/rules.html` and `next/guidelines.html` by
`bin/gen-top-html.sh` and `make gen_top_html`. Also `make gen_status`
will rebuild these files if `status.json` changes or `news.html`
was modified.
Add cross links between `next/rules.html` and `next/guidelines.html`.
Changed `bin/gen-top-html.sh` VERSION from "1.4.3 2024-04-21"
to "1.4.4 2024-04-21".
Ran `make gen_top_html gen_status` to perform the above.
Adjusted `next/guidelines.md` so that the `next/guidelines.html`
will generate an info notice about avoiding the use of "<br />".
Fixed the formatting of IOCCC judges names.
By changing the _inventory_order_ of the compressed tarball from
**100000** to **1415926535**, the compressed tarball will land at
the top of the secondary file list and remain still easy to find.
Updated the `manifest.numbers` spreadsheet and rebuilt
the `.entry.json` files.
Added `next/` directory to hold the next IOCCC rules and guidelines.
Added `next/README.md` that `bin/gen-top-html.sh` uses to form
the `next/index.html` file.
Added _Rules and Guidelines_ link to the sidenav bar to link to the
`next/index.html` file.
Added _IOCCC Rules_ as `next/rules.md` that `bin/gen-top-html.sh`
uses to form the `next/rules.html` file.
Added _IOCCC Guidelines_ as `next/guidelines.md` that `bin/gen-top-html.sh`
uses to form the `next/guidelines.html` file.
Changed `bin/gen-top-html.sh` VERSION from "1.2.4 2024-04-13"
to "1.3 2024-04-14".
Prevent `pandoc(1)` from interpreting the commented out language
of a markdown code block as a code class. So a markdown such as:
````
``` <!---sh-->
...
```
````
that produced HTML of the form:
```html
<pre class="<!---sh-->"><code>...</code></pre>
```
will now produce HTML of the form:
```html
<pre><code>...</code></pre>
```
NOTE: Before when the language of a markdown code block
was not commented, the HTML produced by `pandoc(1)` was
oddly indented with extra whitespace on the first line
of the code block. While commenting out the language
of the code block removed some of the odd intending,
it left a weird class in the HTML pre block that
surrounded the HTML code block. This hack prevents
`pandoc(1)` from assigning a class to the HTML pre block.
Changed `in/md2html.sh` VERSION from "1.2.1 2024-04-13"
to "1.3 2024-04-14".
Added `make gen_sitemap` to end of both `make www` and `make
quick_www` in top level Makefile.
Ram `make www` to test under macOS and to perform the above.
**IMPORTANT NOTE**: The current `next/rules.md` and `next/guidelines.md`
are simply the 2020 IOCCC Rules and Guidelines converted into
markdown form. There are **NOT** the Rules and Guidelines that
will be used the IOCCC MOCK, nor the next IOCCC.
TODO: Improve the `bin/gen-status.sh` tool to modify the top of the
`next/rules.md` and `next/guidelines.md` files to keep them
in sync with the _contest_status_ as found in `status.json`.
TODO: Improve the look and feel of the `next/rules.md` and
`next/guidelines.md` markdown files.
Cody Boone Ferguson