mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

remove XXX from text in faq.md

Browse Source 
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:
Landon Curt Noll committed 2024-03-10 22:09:46 -07:00
1 parent 449205e1a5
commit f482380661
4 files changed
+104 -70
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Makefile
+2 -2
View File
@@ -240,7 +240,7 @@ indent.c:
.PHONY: help genpath genfilelist verify_entry_files gen_authors gen_location gen_years \
entry_index gen_top_html gen_status thanks gen_other_html quick_entry_index \
gen_year_index quick_www www gen_sitemap \
gen_year_index quick_www www gen_sitemap sitemap \
form_entry_tarball form_year_tarball form_all_tarball tar
# Suggest rules in this section
@@ -401,7 +401,7 @@ quick_entry_index quick_readme2index: ${ALL_RUN} ${QUICK_README2INDEX}
# generate the XML sitemap
#
gen_sitemap: ${GEN_SITEMAP}
gen_sitemap sitemap: ${GEN_SITEMAP}
@echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-='
${GEN_SITEMAP} -v 1
@echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-='
faq.html
+53 -35
View File
@@ -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>&lt;!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --&gt;
&lt;!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! --&gt;
&lt;!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! --&gt;
&lt;!-- !!! DO NOT MODIFY THIS FILE - This file is generated by a tool !!! --&gt;
&lt;!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --&gt;</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>&lt;!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --&gt;
&lt;!-- !!! Do not modify this web page, instead modify the file: contact.md --&gt;
&lt;!-- !!! Do not modify this web page, instead modify the file: contact.md --&gt;
&lt;!-- !!! Do not modify this web page, instead modify the file: contact.md --&gt;
&lt;!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --&gt;</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>&lt;!-- The main section of this web page came from JSON and other data files --&gt;
&lt;!-- --&gt;
&lt;!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --&gt;
&lt;!-- The main section of this web page was generated via the tool: bin/gen-years.sh --&gt;
&lt;!-- The main section of this web page was generated via the tool: bin/gen-years.sh --&gt;
&lt;!-- The main section of this web page was generated via the tool: bin/gen-years.sh --&gt;
&lt;!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --&gt;</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>
faq.md
+46 -30
View File
@@ -1,4 +1,4 @@
# FAQ Table of Contents
# FAQ Table of Contents <!-- XXX - Change the references from _temp-test-ioccc_ to _winners_ when these fixes are merged. -->
## Section 0 - [Submitting entries to a new IOCCC](#faq0)
- [0.0 - How may I submit to the IOCCC?](#faq0_0)
@@ -104,7 +104,12 @@ To submit your code to the IOCCC, you **MUST** follow these steps:
2. Register for the IOCCC
XXX - instructions TBD - XXX
The **IOCCC registration procedure** is still being designed.
<!--XXX--> As such, we do not yet have instructions on how to
use the **IOCCC registration procedure**. Once **IOCCC
registration procedure** is ready, we will update this section
with the proper instructions. Watch the [IOCCC news](news.html)
for an annoucement about the **IOCCC registration procedure**.
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
@@ -158,7 +163,13 @@ To submit your code to the IOCCC, you **MUST** follow these steps:
6. Upload your entry to the IOCCC submit server
XXX - instructions TBD - XXX
The **IOCCC submit server** 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 **IOCCC submit server**. Once
**IOCCC submit server** is ready, we will update this section
with the proper instructions. Watch the [IOCCC news](news.html)
for an annoucement of the availability of the **IOCCC submit server**.
### <a name="faq0_1"></a>FAQ 0.1: What types of entries have been over-submitted to the IOCCC?
@@ -496,9 +507,6 @@ on 2020 Dec
See [/archive/historic/index.html](archive/historic/index.html) for
details about these bzip2 compressed tarballs.
**XXX**: Change the references to _temp-test-ioccc_ to _winners_
when these fixes are merged.
#### 2022 Dec 29 Official IOCCC winner repo
@@ -628,7 +636,7 @@ Changes to the IOCCC content included things such as:
* Making use of an new and improved IOCCC CSS for web site consistency
* etc.
#### 202y mm dd The Great Fork Merge
#### 202y mm dd The Great Fork Merge <!-- XXX - Fill in the date when Great Fork Merge happens -->
As of 2024 Mar 5 [temp-test-ioccc
repo](https://github.com/ioccc-src/temp-test-ioccc)
@@ -639,10 +647,6 @@ On 202y mm dd, the temporary repo was merged back into the [IOCCC winner
repo](https://github.com/ioccc-src/winner) resulting in substantial improvements
to the [official IOCCC web site](https://www.ioccc.org).
**XXX**: 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 **Great Fork Merge**.
### <a name="faq1_3"></a><a name="size_rule"></a>FAQ 1.3: How has the IOCCC size limit rule changed over the years?
@@ -2249,42 +2253,54 @@ to submit a fix.
#### Some HTML files should NOT be directly modified
Most HTML files on the [IOCCC web site](https://www.ioccc.org)
Nearly all HTML files on the [IOCCC web site](https://www.ioccc.org)
are built from [markdown](https://daringfireball.net/projects/markdown/) files.
If you see lines containing:
```
!!! 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 !!!
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- !!! 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 !!! -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
```
This means that the file is generated by a tool from a [bin directory tool](bin/index.html).
You should **NOT** attempt to modify the file.
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
You will find a HTML comment of the form indicating which tool
was used to generate the contents:
You may also find lines slightly below the above set that suggest another file to edit.
For example, in [contact.html](contact.html), one may read:
```
file: __some_file_path__ created by: __something__ version: __something__
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<!-- !!! 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 -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
```
Along with HTML comments of the form indicating which files were
used by the tool to generate the HTML file;
This means that you could consider editing the referenced markdown file
in your [IOCCC pull request](#pull_request).
In some cases, the HTML file is **NOT** 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:
```
content source: __some_file_path__
content source: __another_file_path__
...
<!-- 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 -->
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
```
Those **content source:** comment lines will give you a clue to the content that
is used by the tool to generate the **DO NOT MODIFY THIS FILE** HTML file.
This means there is **NOT even a markdown file to edit**. Instead one must
modify JSON files and/or change a [bin directory tool](bin/index.html).
When in doubt, consider opening up an [IOCCC issue](https://github.com/ioccc-src/winner/issues).
See [FAQ 5.3](#report_web_problem) for information on opening up an IOCCC issue.
If this happens, consider opening up an [IOCCC issue](https://github.com/ioccc-src/winner/issues)
and ask for help. See [FAQ 5.3](#fix_an_entry) for information on opening up an IOCCC issue.
## <a name="faq5_5"></a><a name="fix_author"></a>FAQ 5.5: How may I correct or update IOCCC author information?
sitemap.xml
+3 -3
View File
@@ -18186,7 +18186,7 @@
</url>
<url>
<loc>https://ioccc-src.github.io/temp-test-ioccc/Makefile</loc>
<lastmod>2024-03-10T03:24:01+00:00</lastmod>
<lastmod>2024-03-11T05:01:59+00:00</lastmod>
</url>
<url>
<loc>https://ioccc-src.github.io/temp-test-ioccc/README.html</loc>
@@ -19262,11 +19262,11 @@
</url>
<url>
<loc>https://ioccc-src.github.io/temp-test-ioccc/faq.html</loc>
<lastmod>2024-03-10T17:01:11+00:00</lastmod>
<lastmod>2024-03-11T05:01:02+00:00</lastmod>
</url>
<url>
<loc>https://ioccc-src.github.io/temp-test-ioccc/faq.md</loc>
<lastmod>2024-03-09T19:02:12+00:00</lastmod>
<lastmod>2024-03-11T05:00:56+00:00</lastmod>
</url>
<url>
<loc>https://ioccc-src.github.io/temp-test-ioccc/inc/README.md</loc>