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.
This commit is contained in:
Landon Curt Noll committed 2024-07-17 03:11:19 -07:00
1 parent d852734d98
commit 0bc6c3e413
104 files changed
+1051 -687

No files matched your search

+1 -1
View File
@@ -84,7 +84,7 @@ Send such email to:
purposes only, and should not be used today. See
[contact.html](../contact.html) for up to date contact details
as well as details on how to provide fixes to any of the entries.
See also [the IOCCC FAQ](../faq.html) for additional information on the IOCCC.
See also the [IOCCC FAQ](../faq.html) for additional information on the IOCCC.
<!--
+1 -1
View File
@@ -451,7 +451,7 @@ Send such email to:</p>
purposes only, and should not be used today. See
<a href="../contact.html">contact.html</a> for up to date contact details
as well as details on how to provide fixes to any of the entries.
See also <a href="../faq.html">the IOCCC FAQ</a> for additional information on the IOCCC.</p>
See also the <a href="../faq.html">IOCCC FAQ</a> for additional information on the IOCCC.</p>
<!--
Copyright © 1984-2024 by Landon Curt Noll. All Rights Reserved.
+5 -3
View File
@@ -5,9 +5,11 @@
```
NOTE: if you don't have curses or SDL1 installed both modes will fail to compile. In
that case see the [FAQ 3.8 - How do I compile an IOCCC entry that requires SDL1
or SDL2?](../../faq.html#SDL) and [FAQ 3.9 - How do I compile an IOCCC entry that
requires ncurses?](../../faq.html#curses) for more information.
that case see the
FAQ on "[SDL1 and SDL2](../../faq.html#SDL)"
and
FAQ on "[ncurses](../../faq.html#curses)"
for more information.
We recommend that you use the alternate code so you can see what this entry
looked like back in 2000 (with a configurable speed). See the
+5 -3
View File
@@ -415,9 +415,11 @@ Location: <a href="../../location.html#GB">GB</a> - <em>United Kingdom of Great
<h2 id="to-build">To build:</h2>
<pre><code> make alt</code></pre>
<p>NOTE: if you don’t have curses or SDL1 installed both modes will fail to compile. In
that case see the <a href="../../faq.html#SDL">FAQ 3.8 - How do I compile an IOCCC entry that requires SDL1
or SDL2?</a> and <a href="../../faq.html#curses">FAQ 3.9 - How do I compile an IOCCC entry that
requires ncurses?</a> for more information.</p>
that case see the
FAQ on “<a href="../../faq.html#SDL">SDL1 and SDL2</a>”
and
FAQ on “<a href="../../faq.html#curses">ncurses</a>”
for more information.</p>
<p>We recommend that you use the alternate code so you can see what this entry
looked like back in 2000 (with a configurable speed). See the
<a href="#original-code">original code</a> section for the original entry.</p>