Landon Curt Noll
0bc6c3e413
We quasi-canonicalized markdown links to FAQ entries. **IMPORTANT NOTE**: This is a useful step in completing issue #2417. This commit is consistent with the top level TODO comment requirements. Nevertheless, this changes made by this commit needs to be examined and in some cases improved. A link to an FAQ entry is of the form: ``` FAQ on "[the link text](....faq.html#string)" FAQ on "[the link text](....faq.html#string)" ``` The "FAQ" is at the start of the line, or in rare cases is preceded only by whitespace. The reference to the FAQ starts outside of the markdown link with the string **FAQ ON "**. After the markdown link is a **"** followed by either the end of line or a single punctuation character such as a period or comma. We reduced the size of "the link text" that refer to an FAQ to at most 3 words. In some cases the sentence and/or text surrounding the markdown link to a FAQ may need to be further adjusted to better accommodate this new style. **IMPORTANT NOTE**: References to a FAQ entry are on a separate line. p.s. When linking to the `faq.html` file itself, we use markdown of the form "`the [IOCCC FAQ](..../faq.html)`" and place the word "the" outside of the "IOCCC FAQ" link text. Given the above system (and because references to an FAQ entry is on a separate line), the following command shows links to FAQ entries, sorted by FAQ entry "link #name" so that one may evaluate the way a given FAQ entry is referenced: ```sh find * -name '*.md' -print0 | xargs0 grep -E '^[[:space:]]*FAQ on "' | sed -e 's/^\([^:]*\):\( *FAQ on "[^#]*\)#\([^)]*\)\()".*\)$/#\3\t\1\t\2#\3\4/' | sort ``` The above command shows the value of consistency when it comes to FAQ references. **NOTE**: There are a few differences on how a given FAQ is references. That is probably OK as there is NOT an "total mandate" that all references to a given FAQ must have the same "link text" for example. On the other hand if references to a given FAQ can be identical, that might be helpful. We are certain that in some contexts the "link text" might need to change. Should we decide to change the way FAQ are referenced, we will be able to modify identify and modify them with greater ease.' Examine the changes made by this commit and adjust and/or improve as needed. Performed `make www` to accomplish the above and to test under macOS.
Rules and Guidelines
IMPORTANT: Did you read the Important disclaimers about scope and did you check the current IOCCC status?
You may also wish to review the mkiocccentry tool repo, especially when the rules and guidelines are official, to be sure you are using an up to date official mkiocccentry tool set.
Important disclaimers about scope
When the IOCCC status is closed
When the IOCCC status is closed, the rules and guidelines are OUT OF DATE.
They are a very tentative proposal for the next IOCCC that is VERY LIKELY to be updated before the next IOCCC. They are are provided as a tentative hint at what might be used for the next IOCCC.
IMPORTANT: All tentative rules and guidelines are subject to change by the IOCCC judges at ANY time. See both the IOCCC news and the IOCCC Mastodon feed as sometimes the IOCCC judges mention changes there.
When the IOCCC status is pending
When the IOCCC status is pending, the rules and guidelines are tentative.
One might think of them as a beta release for the IOCCC that is about to open.
IMPORTANT: All tentative rules and guidelines are subject to change by the IOCCC judges at any time. See both the IOCCC news and the IOCCC Mastodon feed as sometimes the IOCCC judges mention changes there.
When the IOCCC status is open
When the IOCCC status is open, the rules and guidelines are OFFICIAL.
Unless some significant problem turns up (such as a need to delay in when the IOCCC will close, or some major bug is discovered) they will remain OFFICIAL for this IOCCC.
SUGGESTION: Watch both the IOCCC news and the IOCCC Mastodon feed for the latest news about any changes.
When the IOCCC status is judging
When the IOCCC status is judging, the rules and guidelines are for the current IOCCC that is no longer open for new submissions.
See the IOCCC news as well as the IOCCC Mastodon feed for updates on the IOCCC judging process as well as for the announcement of who won the IOCCC.