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
+22
-17
@@ -395,9 +395,11 @@ and are <strong>VERY LIKELY</strong> to be updated before the next IOCCC.
|
||||
They are are provided as a <strong>VERY TENTATIVE</strong> hint at <strong>what
|
||||
MIGHT</strong> be used in the next IOCCC. In some cases they might
|
||||
even be a copy of the guidelines from the previous IOCCC.</p>
|
||||
<p>See our <a href="../faq.html#feedback">FAQ about providing feedback</a> as well
|
||||
as our <a href="../faq.html#question">FAQ about asking questions</a> about
|
||||
these guidelines.</p>
|
||||
<p>See our
|
||||
FAQ on “<a href="#feedback">rules, guidelines, tools feedback</a>”.
|
||||
as well as our
|
||||
FAQ on “<a href="../faq.html#question">asking questions</a>”
|
||||
about these guidelines.</p>
|
||||
<h1 id="the-ioccc-is-closed">The IOCCC is closed</h1>
|
||||
<p>The IOCCC is <strong>NOT</strong> accepting new submissions at this time. See the
|
||||
<a href="../years.html">IOCCC winning entries page</a> for the entries that have won the
|
||||
@@ -476,8 +478,8 @@ The submit URL should be active on or slightly before <strong>2024-MMM-DD HH:MM:
|
||||
The <a href="rules.html">IOCCC rules</a>, <a href="guidelines.html">IOCCC
|
||||
guidelines</a> will be available on the <a href="https://www.ioccc.org">Official IOCCC
|
||||
website</a> on or slightly before start of this IOCCC. Please check
|
||||
<a href="../faq.html#submit">the IOCCC FAQ about how to submit</a> to see how
|
||||
to submit entries, on or after the start of this IOCCC, to be sure
|
||||
FAQ on “<a href="../faq.html#submit">how to submit</a>”
|
||||
to see how to submit entries, on or after the start of this IOCCC, to be sure
|
||||
you are using the correct versions of these items before using the
|
||||
IOCCC submission URL.
|
||||
</p>
|
||||
@@ -672,8 +674,8 @@ below) fails to validate the <code>.auth.json</code> or <code>.info.json</code>
|
||||
it is an error and possibly a bug that you should <a href="https://github.com/ioccc-src/mkiocccentry/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+%3Ctitle%3E">report as a bug at the
|
||||
mkiocccentry issues
|
||||
page</a>.
|
||||
<strong>PLEASE run the <code>bug_report.sh</code> script to help us out here!</strong> See the <a href="../faq.html#mkiocccentry_bugs">the FAQ
|
||||
about reporting bugs in the mkiocccentry repo</a>.
|
||||
<strong>PLEASE run the <code>bug_report.sh</code> script to help us out here!</strong> See the
|
||||
FAQ on “<a href="../faq.html#mkiocccentry_bugs">report mkiocccentry bugs</a>”.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
However, just because there are errors <strong>does not</strong> mean it is a bug in the
|
||||
@@ -897,8 +899,8 @@ not pass and you used <code>mkiocccentry(1)</code> it is very possibly a bug and
|
||||
<a href="https://github.com/ioccc-src/mkiocccentry/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+%3Ctitle%3E">report
|
||||
it as a bug at the mkiocccentry issues
|
||||
page</a>.
|
||||
See the <a href="../faq.html#mkiocccentry_bugs">the FAQ about reporting
|
||||
bugs in the mkiocccentry repo</a>.
|
||||
See the
|
||||
FAQ on “<a href="../faq.html#mkiocccentry_bugs">report mkiocccentry bugs</a>”.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
Assuming that <code>chkentry(1)</code> validates both <code>.auth.json</code> and
|
||||
@@ -940,8 +942,8 @@ compressed tarball; if any issues are found (‘<code>feathers are stuck in the
|
||||
<code>mkiocccentry(1)</code></strong>, then it is very possibly a bug in one of the tools and you
|
||||
should <a href="https://github.com/ioccc-src/mkiocccentry/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+%3Ctitle%3E">report it as a bug at the mkiocccentry issues
|
||||
page</a>. <strong>PLEASE run the
|
||||
<code>bug_report.sh</code> script to help us out here!</strong> See <a href="../faq.html#mkiocccentry_bugs">the FAQ about reporting bugs
|
||||
in the mkiocccentry repo</a>.
|
||||
<code>bug_report.sh</code> script to help us out here!</strong> See
|
||||
FAQ on “<a href="../faq.html#mkiocccentry_bugs">report mkiocccentry bugs</a>”.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
As part of its sanity checks, <code>txzchk(1)</code> will run <code>fnamchk(1)</code> on the
|
||||
@@ -955,8 +957,8 @@ would prevent this from happening as it would not create such a file anyway. If
|
||||
<code>mkiocccentry(1)</code> was used it would rather suggest a bug in one of the tools and
|
||||
you should <a href="https://github.com/ioccc-src/mkiocccentry/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+%3Ctitle%3E">report it as a bug at the mkiocccentry issues
|
||||
page</a>.
|
||||
See <a href="../faq.html#mkiocccentry_bugs">the FAQ about reporting bugs in the mkiocccentry
|
||||
repo</a>.
|
||||
See
|
||||
FAQ on “<a href="../faq.html#mkiocccentry_bugs">report mkiocccentry bugs</a>”.
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
If verbosity level is > 0, <code>txzchk(1)</code> will show the contents of the tarball which is
|
||||
@@ -1045,8 +1047,9 @@ by modifying the <code>CSTD</code> Makefile variable. For example, to use <code>
|
||||
<pre><code> CSTD= -std=c17</code></pre>
|
||||
<p class="leftbar">
|
||||
For compilers, such as <code>clang</code>, that have the <code>-Weverything</code> option,
|
||||
while you may wish to try it, you should look at <a href="../faq.html#weverything">the FAQ about clang
|
||||
-Weverything</a>. We do <strong>NOT</strong> recommend that you put
|
||||
while you may wish to try it, you should look at
|
||||
FAQ on “<a href="../faq.html#weverything">clang -Weverything</a>”.
|
||||
We do <strong>NOT</strong> recommend that you put
|
||||
the use of <code>-Weverything</code> into your submission’s <code>Makefile</code> for the reasons
|
||||
cited there. This goes even if your version does not trigger a warning as some
|
||||
other version might!
|
||||
@@ -1884,7 +1887,8 @@ It has been shown that receiving <strong>anonymous</strong> gifts provides the
|
||||
<a href="../judges.html">IOCCC judges</a> help make the <a href="../index.html">IOCCC</a> better for everyone. :-)
|
||||
</p>
|
||||
<p class="leftbar">
|
||||
See <a href="../faq.html#support">FAQ: How may I support the IOCCC?</a>.
|
||||
See
|
||||
FAQ on “<a href="../faq.html#support">support the IOCCC</a>”.
|
||||
</p>
|
||||
<p>More often than not, we select a small submission (usually one line) and a
|
||||
strange/creative layout submission. We sometimes also select a
|
||||
@@ -1987,7 +1991,8 @@ See the <a href="../news.html">Official IOCCC website news</a> for additional in
|
||||
<p class="change marker">
|
||||
For the updates and breaking <a href="../news.html">IOCCC news</a>, you are encouraged to follow
|
||||
the <a href="https://fosstodon.org/@ioccc">IOCCC on Mastodon</a>. See our
|
||||
<a href="../faq.html#try_mastodon">FAQ on Mastodon</a> for more information. <strong>Please be
|
||||
FAQ on “<a href="../faq.html#try_mastodon">Mastodon</a>”
|
||||
for more information. <strong>Please be
|
||||
aware</strong> that unless you are mentioned you most likely will <strong>NOT</strong> get a
|
||||
notification so you should make sure to check the page.
|
||||
</p>
|
||||
|
||||
Reference in new issue
Block a user