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:
1 parent
d852734d98
commit
0bc6c3e413
104 files changed
+1051
-687
No files matched your search
+1
-1
@@ -90,7 +90,7 @@ the idea was limited in scope.
|
||||
|
||||
**IMPORTANT NOTE**: 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.
|
||||
|
||||
<!--
|
||||
|
||||
|
||||
@@ -5,8 +5,8 @@
|
||||
```
|
||||
|
||||
To use this entry requires, in some invocations, a sound processing program.
|
||||
This can be ALSA or SoX but we recommend the latter. See [FAQ 3.10 - How do I
|
||||
compile and use an IOCCC entry that requires sound?](../../faq.html#sox).
|
||||
This can be ALSA or SoX but we recommend the latter. See
|
||||
FAQ on "[SDL1 and SDL2](../../faq.html#sox)".
|
||||
|
||||
|
||||
### Bugs and (Mis)features:
|
||||
|
||||
@@ -410,8 +410,8 @@ Location: <a href="../../location.html#SE">SE</a> - <em>Kingdom of Sweden</em> (
|
||||
<h2 id="to-build">To build:</h2>
|
||||
<pre><code> make</code></pre>
|
||||
<p>To use this entry requires, in some invocations, a sound processing program.
|
||||
This can be ALSA or SoX but we recommend the latter. See <a href="../../faq.html#sox">FAQ 3.10 - How do I
|
||||
compile and use an IOCCC entry that requires sound?</a>.</p>
|
||||
This can be ALSA or SoX but we recommend the latter. See
|
||||
FAQ on “<a href="../../faq.html#sox">SDL1 and SDL2</a>”.</p>
|
||||
<h3 id="bugs-and-misfeatures">Bugs and (Mis)features:</h3>
|
||||
<p>The current status of this entry is:</p>
|
||||
<pre><code> STATUS: INABIAF - please DO NOT fix</code></pre>
|
||||
|
||||
@@ -27,10 +27,10 @@ graphics viewer of choice. After that try:
|
||||
|
||||
NOTE: the script uses the tools `pngtopam(1)` (or `pngtopnm(1)` for older
|
||||
versions) and `pnmscale` come from the netpbm project and `cjpeg(1)` comes from
|
||||
`libjpeg-turbo`. If you don't have these tools already see [FAQ 3.15 - How do I
|
||||
compile and install netpbm for entries that require it?](../../faq.html#netpbm) and
|
||||
[FAQ 3.16 - How do I compile and install libjpeg-turbo for entries that require
|
||||
it?](../../faq.html#libjpeg).
|
||||
`libjpeg-turbo`. If you don't have these tools already see
|
||||
FAQ on "[netpbm](../../faq.html#netpbm)"
|
||||
and
|
||||
FAQ on "[libjpeg-turbo](../../faq.html#libjpeg)".
|
||||
|
||||
NOTE: [Lenna.png](Lenna.png) is from
|
||||
<https://upload.wikimedia.org/wikipedia/en/7/7d/Lenna_%28test_image%29.png>.
|
||||
|
||||
@@ -420,10 +420,10 @@ graphics viewer of choice. After that try:</p>
|
||||
<pre><code> ./try.sh</code></pre>
|
||||
<p>NOTE: the script uses the tools <code>pngtopam(1)</code> (or <code>pngtopnm(1)</code> for older
|
||||
versions) and <code>pnmscale</code> come from the netpbm project and <code>cjpeg(1)</code> comes from
|
||||
<code>libjpeg-turbo</code>. If you don’t have these tools already see <a href="../../faq.html#netpbm">FAQ 3.15 - How do I
|
||||
compile and install netpbm for entries that require it?</a> and
|
||||
<a href="../../faq.html#libjpeg">FAQ 3.16 - How do I compile and install libjpeg-turbo for entries that require
|
||||
it?</a>.</p>
|
||||
<code>libjpeg-turbo</code>. If you don’t have these tools already see
|
||||
FAQ on “<a href="../../faq.html#netpbm">netpbm</a>”
|
||||
and
|
||||
FAQ on “<a href="../../faq.html#libjpeg">libjpeg-turbo</a>”.</p>
|
||||
<p>NOTE: <a href="Lenna.png">Lenna.png</a> is from
|
||||
<a href="https://upload.wikimedia.org/wikipedia/en/7/7d/Lenna_%28test_image%29.png" class="uri">https://upload.wikimedia.org/wikipedia/en/7/7d/Lenna_%28test_image%29.png</a>.</p>
|
||||
<h2 id="alternate-code">Alternate code:</h2>
|
||||
|
||||
@@ -206,7 +206,9 @@ bytes following `O`, addressed via `o`, and this code only needs 17. This is
|
||||
_undefined_ behavior, but as shown, it is widely available.
|
||||
|
||||
The [1979 Seventh Edition UNIX][1] (v7) system pre-dates the IOCCC by several years,
|
||||
and the source code to `sh`(1) was a [significant inspiration for this contest](../../faq.html#ioccc_start).
|
||||
and the source code to `sh`(1) was a **significant inspiration for this contest**.
|
||||
See the
|
||||
FAQ on "[IOCCC beginnings](../../faq.html#ioccc_start)".
|
||||
There are two C compilers present: `cc` written by Dennis Ritchie, and `pcc` written by Steven Johnson.
|
||||
The nested conditional expressions in 116 and smaller are too complex for `cc` ("Illegal conditional")
|
||||
but `pcc` handles them correctly, and neither compiler accepts `char o[]` or
|
||||
|
||||
@@ -543,7 +543,9 @@ with nothing following: thus, there are plenty of available and unused zero
|
||||
bytes following <code>O</code>, addressed via <code>o</code>, and this code only needs 17. This is
|
||||
<em>undefined</em> behavior, but as shown, it is widely available.</p>
|
||||
<p>The <a href="http://minnie.tuhs.org/cgi-bin/utree.pl">1979 Seventh Edition UNIX</a> (v7) system pre-dates the IOCCC by several years,
|
||||
and the source code to <code>sh</code>(1) was a <a href="../../faq.html#ioccc_start">significant inspiration for this contest</a>.
|
||||
and the source code to <code>sh</code>(1) was a <strong>significant inspiration for this contest</strong>.
|
||||
See the
|
||||
FAQ on “<a href="../../faq.html#ioccc_start">IOCCC beginnings</a>”.
|
||||
There are two C compilers present: <code>cc</code> written by Dennis Ritchie, and <code>pcc</code> written by Steven Johnson.
|
||||
The nested conditional expressions in 116 and smaller are too complex for <code>cc</code> (“Illegal conditional”)
|
||||
but <code>pcc</code> handles them correctly, and neither compiler accepts <code>char o[]</code> or
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
## To build:
|
||||
|
||||
This entry requires SDL2 to be installed. See [FAQ 3.8: How do I compile an
|
||||
IOCCC entry that requires SDL1 or SDL2?](../../faq.html#SDL) if you don't have it
|
||||
This entry requires SDL2 to be installed. See
|
||||
FAQ on "[SDL1 and SDL2](../../faq.html#SDL)"
|
||||
if you don't have it
|
||||
installed and don't know how to do so.
|
||||
|
||||
``` <!---sh-->
|
||||
|
||||
@@ -408,8 +408,9 @@ Location: <a href="../../location.html#AU">AU</a> - <em>Commonwealth of Australi
|
||||
|
||||
<!-- BEFORE: 1st line of markdown file: 2018/giles/README.md -->
|
||||
<h2 id="to-build">To build:</h2>
|
||||
<p>This entry requires SDL2 to be installed. See <a href="../../faq.html#SDL">FAQ 3.8: How do I compile an
|
||||
IOCCC entry that requires SDL1 or SDL2?</a> if you don’t have it
|
||||
<p>This entry requires SDL2 to be installed. See
|
||||
FAQ on “<a href="../../faq.html#SDL">SDL1 and SDL2</a>”
|
||||
if you don’t have it
|
||||
installed and don’t know how to do so.</p>
|
||||
<pre><code> make</code></pre>
|
||||
<h2 id="to-use">To use:</h2>
|
||||
|
||||
+1
-1
@@ -460,7 +460,7 @@ the idea was limited in scope.</p>
|
||||
<h2 id="final-comments">Final Comments</h2>
|
||||
<p><strong>IMPORTANT NOTE</strong>: 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.
|
||||
|
||||
@@ -96,8 +96,9 @@ best viewing experience is achieved when the terminal in use supports 24-bit
|
||||
colors, has a black background and the size is at least 125x38.
|
||||
|
||||
Special note for Mac users: `Terminal.app` does not work as expected; you might
|
||||
need xterm from XQuartz, see [FAQ 3.7: How do I compile and use on macOS, an
|
||||
IOCCC entry that requires X11?](../../faq.html#X11macos), or some other working
|
||||
need xterm from XQuartz, see
|
||||
FAQ on "[X11 on macOS](../../faq.html#X11macos)",
|
||||
or some other working
|
||||
terminal. Thanks to [Dave Burton](../../authors.html#Dave_Burton) for spotting this
|
||||
problem.
|
||||
|
||||
|
||||
@@ -454,8 +454,9 @@ better with it.</p>
|
||||
best viewing experience is achieved when the terminal in use supports 24-bit
|
||||
colors, has a black background and the size is at least 125x38.</p>
|
||||
<p>Special note for Mac users: <code>Terminal.app</code> does not work as expected; you might
|
||||
need xterm from XQuartz, see <a href="../../faq.html#X11macos">FAQ 3.7: How do I compile and use on macOS, an
|
||||
IOCCC entry that requires X11?</a>, or some other working
|
||||
need xterm from XQuartz, see
|
||||
FAQ on “<a href="../../faq.html#X11macos">X11 on macOS</a>”,
|
||||
or some other working
|
||||
terminal. Thanks to <a href="../../authors.html#Dave_Burton">Dave Burton</a> for spotting this
|
||||
problem.</p>
|
||||
<p>The main reason for the header <code>unistd.h</code> is <code>getdelim(3)</code> but once I included it
|
||||
|
||||
Reference in new issue
Block a user