Files
ioccc/status.md
T
Landon Curt Noll 0bc6c3e413 improve markdown references to FAQ entries
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.
2024-07-17 03:11:19 -07:00

5.2 KiB

format

The following JSON members are required to be present status.json.

## no_comment

This is a mandatory comment for which we offer no comment other than this comment. :-)

The JSON member value must be the following JSON quoted string:

    "mandatory comment: because comments were removed from the original JSON spec"
## IOCCC_status_version

This is the version of format of the status.json file.

The JSON member value of is a JSON quoted string the form "version YYYY-MM-DD".

This document describes version "1.0 2024-03-09".

## contest_status

The current status of the IOCCC.

The following JSON member value string may be one of the following JSON quoted strings:

#### "**pending**"

The IOCCC is not yet open, however there is a tentative scheduled date and time by which the IOCCC will open for submissions.

A preliminary IOCCC rules, guidelines, and tools have been posted. Comments and suggestions on these preliminary items are welcome. See the IOCCC news for details including the tentative scheduled opening date.

#### "**open**"

The IOCCC is open for submissions.

See the FAQ on "how to submit" for more information.

See the IOCCC news page for details on rules, guidelines, tools and deadlines.

Be sure to review the official IOCCC rules, guidelines, and tools for any changes that may have been made while the IOCCC was "pending".

#### "**judging**"

The IOCCC is closed to new submissions. The IOCCC judges are in the process of judging the submissions they received while the IOCCC was open.

Watch the @IOCCC mastodon feed for updates.

Once the IOCCC closes, the judges will:

"closed"

The IOCCC is closed and is NOT accepting submissions.

See the IOCCC winning entries page for the entries that have won the IOCCC.

NOTE: From time to time, winning IOCCC entries may have their write-ups updated, Makefiles improved, source code fixed etc. See IOCCC news for details.

Watch both this IOCCC status page and the @IOCCC mastodon feed for information about future IOCCC openings.

See the FAQ on "how to submit" for more information on the submission process when the IOCCC reopens.

## news_update

This shows the latest modification date for the IOCCC news page.

The JSON member value is a JSON quoted string obtained from the date field of the following ls(1) command:

    TZ=UTC ls -D '%FT%T+00:00' -ld news.html

NOTE: The date and time are given with respect to UTC timezone.

NOTE: It is possible that for some reason, the IOCCC news page was modified without the content being changed. While we will try to minimize the cases where this happen, we apologize in advance (Sorry tm Canada 🇨🇦) when it does.

## status_update

This shows the latest modification date of status.json file.

The JSON member value is a JSON quoted string obtained from the date field of the following ls(1) command:

    TZ=UTC ls -D '%FT%T+00:00' -ld status.json

NOTE: The date and time are given with respect to UTC timezone.

NOTE: It is possible that for some reason, the status.json file was modified without the content being changed. While we will try to minimize the cases where this happen, we apologize in advance (Sorry tm Canada 🇨🇦) when it does.


Jump to: top