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
@@ -48,7 +48,7 @@ us a line. We enjoy seeing who, where and how the contest is used.
|
||||
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.
|
||||
|
||||
|
||||
### Credits:
|
||||
|
||||
@@ -10,8 +10,8 @@ section below to run the original (the bug also exists here).
|
||||
```
|
||||
|
||||
NOTE: this entry requires the `X11/Xlib.h` header file and the X11 library to
|
||||
compile. If you don't have the X11 installed see the [FAQ on how to compile and
|
||||
run an entry that requires X11](../../faq.html#X11).
|
||||
compile. If you don't have the X11 installed see the
|
||||
FAQ on "[X11](../../faq.html#X11)".
|
||||
|
||||
To configure how many microseconds to sleep before updates try:
|
||||
|
||||
|
||||
@@ -414,8 +414,8 @@ bugs.html</a>). See the <a href="#original-code">original code</a>
|
||||
section below to run the original (the bug also exists here).</p>
|
||||
<pre><code> make alt</code></pre>
|
||||
<p>NOTE: this entry requires the <code>X11/Xlib.h</code> header file and the X11 library to
|
||||
compile. If you don’t have the X11 installed see the <a href="../../faq.html#X11">FAQ on how to compile and
|
||||
run an entry that requires X11</a>.</p>
|
||||
compile. If you don’t have the X11 installed see the
|
||||
FAQ on “<a href="../../faq.html#X11">X11</a>”.</p>
|
||||
<p>To configure how many microseconds to sleep before updates try:</p>
|
||||
<pre><code> make clobber SLEEP=200 alt</code></pre>
|
||||
<h3 id="bugs-and-misfeatures">Bugs and (Mis)features:</h3>
|
||||
|
||||
+1
-1
@@ -430,7 +430,7 @@ us a line. We enjoy seeing who, where and how the contest is used.</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>
|
||||
<h3 id="credits">Credits:</h3>
|
||||
<p>We would like to thank Barbara Frezza for her role as official chef
|
||||
of the contest. Landon Curt Noll and Larry Bassel appreciated the opportunity
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
## To build:
|
||||
|
||||
NOTE: this entry requires the `X11/Xlib.h` header file and the X11 library to
|
||||
compile. See [the FAQ on how to run entries that require X11](../../faq.html#X11) if
|
||||
you need help.
|
||||
compile. See the
|
||||
FAQ on "[X11](../../faq.html#X11)"
|
||||
if you need help.
|
||||
|
||||
|
||||
``` <!---sh-->
|
||||
|
||||
@@ -409,8 +409,9 @@ Location: <a href="../../location.html#NO">NO</a> - <em>Kingdom of Norway</em> (
|
||||
<!-- BEFORE: 1st line of markdown file: 1993/jonth/README.md -->
|
||||
<h2 id="to-build">To build:</h2>
|
||||
<p>NOTE: this entry requires the <code>X11/Xlib.h</code> header file and the X11 library to
|
||||
compile. See <a href="../../faq.html#X11">the FAQ on how to run entries that require X11</a> if
|
||||
you need help.</p>
|
||||
compile. See the
|
||||
FAQ on “<a href="../../faq.html#X11">X11</a>”
|
||||
if you need help.</p>
|
||||
<pre><code> make all</code></pre>
|
||||
<h2 id="to-use">To use:</h2>
|
||||
<pre><code> ./jonth # must be run on an X11 server</code></pre>
|
||||
|
||||
Reference in new issue
Block a user