remove XXX from text in faq.md
In several cases where the `faq.md` had **XXX**'s, we replaced the text with equivalent text for someone to read (such as the **IOCCC registration procedure** or **IOCCC submit server** is not ready). In a number of cases, an HTML comment with a **XXX** inside, was added as an indicator for the need of a future edit. Added `make sitemap` as an alias for `make gen_sitemap`. Performed `make gen_top_html sitemap` to do perform the above.
This commit is contained in:
1 parent
449205e1a5
commit
f482380661
4 files changed
+104
-70
No files matched your search
@@ -113,7 +113,8 @@
|
||||
<!-- END: this line ends content from: inc/before-content.default.html -->
|
||||
<!-- START: this line starts content for HTML phase 21 by: bin/pandoc-wrapper.sh via bin/md2html.sh -->
|
||||
|
||||
<h1 id="faq-table-of-contents">FAQ Table of Contents</h1>
|
||||
<h1 id="faq-table-of-contents">FAQ Table of Contents
|
||||
<!-- XXX - Change the references from _temp-test-ioccc_ to _winners_ when these fixes are merged. --></h1>
|
||||
<h2 id="section-0---submitting-entries-to-a-new-ioccc">Section 0 - <a
|
||||
href="#faq0">Submitting entries to a new IOCCC</a></h2>
|
||||
<ul>
|
||||
@@ -274,7 +275,13 @@ rules</a>.</p>
|
||||
href="guidelines.html">official IOCCC guidelines</a> as they contain
|
||||
important suggestions, useful hints, and IOCCC humor. :-)</p></li>
|
||||
<li><p>Register for the IOCCC</p>
|
||||
<p>XXX - instructions TBD - XXX</p>
|
||||
<p>The <strong>IOCCC registration procedure</strong> is still being
|
||||
designed. <!--XXX--> As such, we do not yet have instructions on how to
|
||||
use the <strong>IOCCC registration procedure</strong>. Once
|
||||
<strong>IOCCC registration procedure</strong> is ready, we will update
|
||||
this section with the proper instructions. Watch the <a
|
||||
href="news.html">IOCCC news</a> for an annoucement about the
|
||||
<strong>IOCCC registration procedure</strong>.</p>
|
||||
<p>Once you have been registered, you will receive an email message for
|
||||
how to prepare your entries for submission, and how to upload the
|
||||
compressed tarballs to our submission portal.</p></li>
|
||||
@@ -308,7 +315,13 @@ and then re-run the <code>mkiocccentry</code> tool.</p>
|
||||
<p>If you choose to risk violating rules, be sure an explain your reason
|
||||
for doing so in your _remarks.md file.</p></li>
|
||||
<li><p>Upload your entry to the IOCCC submit server</p>
|
||||
<p>XXX - instructions TBD - XXX</p></li>
|
||||
<p>The <strong>IOCCC submit server</strong> is still being written as of
|
||||
2024 Mar 10. <!--XXX--> As such, we do not yet have instructions on how
|
||||
upload your entry to the <strong>IOCCC submit server</strong>. Once
|
||||
<strong>IOCCC submit server</strong> is ready, we will update this
|
||||
section with the proper instructions. Watch the <a
|
||||
href="news.html">IOCCC news</a> for an annoucement of the availability
|
||||
of the <strong>IOCCC submit server</strong>.</p></li>
|
||||
</ol>
|
||||
<h3
|
||||
id="faq-0.1-what-types-of-entries-have-been-over-submitted-to-the-ioccc"><a name="faq0_1"></a>FAQ
|
||||
@@ -609,9 +622,6 @@ href="https://web.archive.org/web/20201228005211/https://www.ioccc.org/">snapsho
|
||||
of the website on 2020 Dec 28</a>. See <a
|
||||
href="archive/historic/index.html">/archive/historic/index.html</a> for
|
||||
details about these bzip2 compressed tarballs.</p>
|
||||
<p><strong>XXX</strong>: Change the references to
|
||||
<em>temp-test-ioccc</em> to <em>winners</em> when these fixes are
|
||||
merged.</p>
|
||||
<h4 id="dec-29-official-ioccc-winner-repo">2022 Dec 29 Official IOCCC
|
||||
winner repo</h4>
|
||||
<p>The <a href="https://github.com/ioccc-src/winner">Official IOCCC
|
||||
@@ -756,8 +766,8 @@ tool</li>
|
||||
consistency</li>
|
||||
<li>etc.</li>
|
||||
</ul>
|
||||
<h4 id="y-mm-dd-the-great-fork-merge">202y mm dd The Great Fork
|
||||
Merge</h4>
|
||||
<h4 id="y-mm-dd-the-great-fork-merge">202y mm dd The Great Fork Merge
|
||||
<!-- XXX - Fill in the date when Great Fork Merge happens --></h4>
|
||||
<p>As of 2024 Mar 5 <a
|
||||
href="https://github.com/ioccc-src/temp-test-ioccc">temp-test-ioccc
|
||||
repo</a> there were <a
|
||||
@@ -768,10 +778,6 @@ href="https://github.com/ioccc-src/winner">IOCCC winner repo</a>.</p>
|
||||
href="https://github.com/ioccc-src/winner">IOCCC winner repo</a>
|
||||
resulting in substantial improvements to the <a
|
||||
href="https://www.ioccc.org">official IOCCC web site</a>.</p>
|
||||
<p><strong>XXX</strong>: Fill in the date when the pull request happens
|
||||
including the size of the pull request and/or number of changes that
|
||||
went into the pull request. We call this the <strong>Great Fork
|
||||
Merge</strong>.</p>
|
||||
<h3
|
||||
id="faq-1.3-how-has-the-ioccc-size-limit-rule-changed-over-the-years"><a name="faq1_3"></a><a name="size_rule"></a>FAQ
|
||||
1.3: How has the IOCCC size limit rule changed over the years?</h3>
|
||||
@@ -2099,33 +2105,45 @@ href="https://github.com/ioccc-src/winner">ioccc-src/winner repo</a> to
|
||||
submit a fix.</p>
|
||||
<h4 id="some-html-files-should-not-be-directly-modified">Some HTML files
|
||||
should NOT be directly modified</h4>
|
||||
<p>Most HTML files on the <a href="https://www.ioccc.org">IOCCC web
|
||||
site</a> are built from <a
|
||||
<p>Nearly all HTML files on the <a href="https://www.ioccc.org">IOCCC
|
||||
web site</a> are built from <a
|
||||
href="https://daringfireball.net/projects/markdown/">markdown</a> files.
|
||||
If you see lines containing:</p>
|
||||
<pre><code>!!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!!
|
||||
!!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!!
|
||||
!!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!!</code></pre>
|
||||
<pre><code><!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
|
||||
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
|
||||
<!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! -->
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --></code></pre>
|
||||
<p>This means that the file is generated by a tool from a <a
|
||||
href="bin/index.html">bin directory tool</a>. You should
|
||||
<strong>NOT</strong> attempt to modify the file.</p>
|
||||
<p>You may also find lines slightly below the above set that suggest
|
||||
another file to edit. For example, in <a
|
||||
href="contact.html">contact.html</a>, one may read:</p>
|
||||
<pre><code><!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<!-- !!! Do not modify this web page, instead modify the file: contact.md -->
|
||||
<!-- !!! Do not modify this web page, instead modify the file: contact.md -->
|
||||
<!-- !!! Do not modify this web page, instead modify the file: contact.md -->
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --></code></pre>
|
||||
<p>This means that you could consider editing the referenced markdown
|
||||
file in your <a href="#pull_request">IOCCC pull request</a>.</p>
|
||||
<p>In some cases, the HTML file is <strong>NOT</strong> based on
|
||||
markdown content, but instead came from JSON and other data files. So
|
||||
instead of the above reference to a markdown file, you will read:</p>
|
||||
<pre><code><!-- The main section of this web page came from JSON and other data files -->
|
||||
<!-- -->
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<!-- The main section of this web page was generated via the tool: bin/gen-years.sh -->
|
||||
<!-- The main section of this web page was generated via the tool: bin/gen-years.sh -->
|
||||
<!-- The main section of this web page was generated via the tool: bin/gen-years.sh -->
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --></code></pre>
|
||||
<p>This means there is <strong>NOT even a markdown file to
|
||||
edit</strong>. Instead one must modify JSON files and/or change a <a
|
||||
href="bin/index.html">bin directory tool</a>.</p>
|
||||
<p>XXX - the text below for this FAQ entry needs to be updated - XXX XXX
|
||||
- the text needs to be synced with what tools be written will do -
|
||||
XXX</p>
|
||||
<p>You will find a HTML comment of the form indicating which tool was
|
||||
used to generate the contents:</p>
|
||||
<pre><code>file: __some_file_path__ created by: __something__ version: __something__</code></pre>
|
||||
<p>Along with HTML comments of the form indicating which files were used
|
||||
by the tool to generate the HTML file;</p>
|
||||
<pre><code>content source: __some_file_path__
|
||||
content source: __another_file_path__
|
||||
...</code></pre>
|
||||
<p>Those <strong>content source:</strong> comment lines will give you a
|
||||
clue to the content that is used by the tool to generate the <strong>DO
|
||||
NOT MODIFY THIS FILE</strong> HTML file.</p>
|
||||
<p>When in doubt, consider opening up an <a
|
||||
href="https://github.com/ioccc-src/winner/issues">IOCCC issue</a>. See
|
||||
<a href="#report_web_problem">FAQ 5.3</a> for information on opening up
|
||||
an IOCCC issue.</p>
|
||||
<p>If this happens, consider opening up an <a
|
||||
href="https://github.com/ioccc-src/winner/issues">IOCCC issue</a> and
|
||||
ask for help. See <a href="#fix_an_entry">FAQ 5.3</a> for information on
|
||||
opening up an IOCCC issue.</p>
|
||||
<h2
|
||||
id="faq-5.5-how-may-i-correct-or-update-ioccc-author-information"><a name="faq5_5"></a><a name="fix_author"></a>FAQ
|
||||
5.5: How may I correct or update IOCCC author information?</h2>
|
||||
|
||||
Reference in new issue
Block a user