From f482380661b88ca3e0f4a70c4d9b4d5ccb17e9f0 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Sun, 10 Mar 2024 22:09:46 -0700 Subject: [PATCH] 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. --- Makefile | 4 +-- faq.html | 88 ++++++++++++++++++++++++++++++++--------------------- faq.md | 76 +++++++++++++++++++++++++++------------------ sitemap.xml | 6 ++-- 4 files changed, 104 insertions(+), 70 deletions(-) diff --git a/Makefile b/Makefile index aa87dce25..d8038acd8 100644 --- a/Makefile +++ b/Makefile @@ -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 $@ =-=-=-=-=' diff --git a/faq.html b/faq.html index 72bd36a0c..96b06ab86 100644 --- a/faq.html +++ b/faq.html @@ -113,7 +113,8 @@ -

FAQ Table of Contents

+

FAQ Table of Contents +

Section 0 - Submitting entries to a new IOCCC

-

202y mm dd The Great Fork -Merge

+

202y mm dd The Great Fork Merge +

As of 2024 Mar 5 temp-test-ioccc repo there were IOCCC winner repo.

href="https://github.com/ioccc-src/winner">IOCCC winner repo resulting in substantial improvements to the official IOCCC web site.

-

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.

FAQ 1.3: How has the IOCCC size limit rule changed over the years?

@@ -2099,33 +2105,45 @@ href="https://github.com/ioccc-src/winner">ioccc-src/winner repo to submit a fix.

Some HTML files should NOT be directly modified

-

Most HTML files on the IOCCC web -site are built from Nearly all HTML files on the IOCCC +web site are built from 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. You should +NOT attempt to modify the file.

+

You may also find lines slightly below the above set that suggest +another file to edit. For example, in contact.html, one may read:

+
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<!-- !!! 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 -->
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+

This means that you could consider editing the referenced markdown +file in your IOCCC 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:

+
<!-- 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 -->
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+

This means there is NOT even a markdown file to +edit. Instead one must modify JSON files and/or change a bin directory tool.

-

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:

-
file: __some_file_path__ created by: __something__ version: __something__
-

Along with HTML comments of the form indicating which files were used -by the tool to generate the HTML file;

-
content source: __some_file_path__
-content source: __another_file_path__
-...
-

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.

-

When in doubt, consider opening up an IOCCC issue. See -FAQ 5.3 for information on opening up -an IOCCC issue.

+

If this happens, consider opening up an IOCCC issue and +ask for help. See FAQ 5.3 for information on +opening up an IOCCC issue.

FAQ 5.5: How may I correct or update IOCCC author information?

diff --git a/faq.md b/faq.md index 7ef73d0d7..829c1ce94 100644 --- a/faq.md +++ b/faq.md @@ -1,4 +1,4 @@ -# FAQ Table of Contents +# FAQ Table of Contents ## 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. + 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. 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**. + ### 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 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**. - ### 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 !!! + + + + + ``` 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__ + + + + + ``` -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__ -... + + + + + + + ``` -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. ## FAQ 5.5: How may I correct or update IOCCC author information? diff --git a/sitemap.xml b/sitemap.xml index ac5d02318..a99d850e8 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -18186,7 +18186,7 @@ https://ioccc-src.github.io/temp-test-ioccc/Makefile - 2024-03-10T03:24:01+00:00 + 2024-03-11T05:01:59+00:00 https://ioccc-src.github.io/temp-test-ioccc/README.html @@ -19262,11 +19262,11 @@ https://ioccc-src.github.io/temp-test-ioccc/faq.html - 2024-03-10T17:01:11+00:00 + 2024-03-11T05:01:02+00:00 https://ioccc-src.github.io/temp-test-ioccc/faq.md - 2024-03-09T19:02:12+00:00 + 2024-03-11T05:00:56+00:00 https://ioccc-src.github.io/temp-test-ioccc/inc/README.md