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

Reorganise menus

Browse Source 
The sections have been modified a fair amount. The Entries menu has been
extended to have: Fixing entries, Updating author info, Thanks for the
help. The first two were moved from FAQ and the last one from About.
The rationale for these, in order: entries and authors have to do with
entries and most of the help involves entries. It also has to do with
website but in 'about' it does not seem the right place, unless maybe it
is renamed to 'Credits' or something (I am not suggesting this one way
or the other). This one is debatable but that was the rationale.

The Status menu has been extended to have: Markdown guidelines and
Security policy. The rationale is that the markdown guidelines are part
of contest guidelines and the security policy is about the status of the
entries and how if there are any security problems they will not be
addressed (instead of about the IOCCC).

The FAQ was extended to have: Compiling entries, Running entries, How to
help. The reason to not have compiling and running entries under Entries
is because this is 'how to' and also the menu was too long. How to help
seems like a good idea under FAQ too (was in About).

About was extended to have the new 'about.html' page (from about.md).
This is a rare case where a new file is useful as it fits under 'About'.
The menu now is: Home page, About the IOCCC, The Judges, Contact us. I
was pondering the 'About [the IOCCC]' at the top and also naming it
'About us' but it seemed like a link to index.html was necessary and as
for 'about us' it seemed less clear as to whether it was about the
judges or the contest itself. The FAQ has been updated slightly for
this.

After further inspection the bin/index.html and the inc/index.html links
were removed from the about section.

With these changes, renaming an item or slight reordering
notwithstanding, I believe that #2006 is probably in good shape.
This commit is contained in:
Cody Boone Ferguson committed 2024-10-25 11:23:21 -07:00
1 parent 75c89bd544
commit af5482825c
421 files changed
+36559 -29682
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+95 -121
View File
@@ -62,19 +62,19 @@
<div class="sub-item">
<div class="outfit-font">
<a href="./years.html" class="sub-item-link">
Winning Entries
Winning entries
</a>
</div>
<div class="outfit-font">
<a href="./authors.html" class="sub-item-link">
Winning Authors
Winning authors
</a>
</div>
<div class="outfit-font">
<a href="./location.html" class="sub-item-link">
Location of winning authors
Location of authors
</a>
</div>
@@ -83,6 +83,24 @@
Bugs and (mis)features
</a>
</div>
<div class="outfit-font">
<a href="./faq.html#fix_an_entry" class="sub-item-link">
Fixing entries
</a>
</div>
<div class="outfit-font">
<a href="./faq.html#fix_author" class="sub-item-link">
Updating author info
</a>
</div>
<div class="outfit-font">
<a href="./thanks-for-help.html" class="sub-item-link">
Thanks for the help
</a>
</div>
</div>
</div>
@@ -94,7 +112,7 @@
<div class="sub-item">
<div class="outfit-font">
<a href="./news.html" class="sub-item-link">
IOCCC News
News
</a>
</div>
@@ -106,15 +124,22 @@
<div class="outfit-font">
<a href="./next/index.html" class="sub-item-link">
Rules and Guidelines
Rules and guidelines
</a>
</div>
<div class="outfit-font">
<a href="./markdown.html" class="sub-item-link">
IOCCC Markdown Guidelines
Markdown guidelines
</a>
</div>
<div class="outfit-font">
<a href="./SECURITY.html" class="sub-item-link">
Security policy
</a>
</div>
</div>
</div>
@@ -126,33 +151,34 @@
<div class="sub-item">
<div class="outfit-font">
<a href="./faq.html" class="sub-item-link">
FAQ
Frequently Asked Questions
</a>
</div>
<div class="outfit-font">
<a href="./faq.html#submit" class="sub-item-link">
How to enter the IOCCC
How to enter
</a>
</div>
<div class="outfit-font">
<a href="./faq.html#fix_an_entry" class="sub-item-link">
Fixing IOCCC entries
<a href="./faq.html#compiling" class="sub-item-link">
Compiling entries
</a>
</div>
<div class="outfit-font">
<a href="./faq.html#fix_website" class="sub-item-link">
Fixing the website
<a href="./faq.html#running_entries" class="sub-item-link">
Running entries
</a>
</div>
<div class="outfit-font">
<a href="./faq.html#fix_author" class="sub-item-link">
Updating author info
<a href="./faq.html#help" class="sub-item-link">
How to help
</a>
</div>
</div>
</div>
@@ -164,43 +190,25 @@
<div class="sub-item">
<div class="outfit-font">
<a href="./index.html" class="sub-item-link">
IOCCC Home
Home page
</a>
</div>
<div class="outfit-font">
<a href="./about.html" class="sub-item-link">
About the IOCCC
</a>
</div>
<div class="outfit-font">
<a href="./judges.html" class="sub-item-link">
The IOCCC Judges
The Judges
</a>
</div>
<div class="outfit-font">
<a href="./contact.html" class="sub-item-link">
Contacting the IOCCC
</a>
</div>
<div class="outfit-font">
<a href="./SECURITY.html" class="sub-item-link">
IOCCC Security Policy
</a>
</div>
<div class="outfit-font">
<a href="./thanks-for-help.html" class="sub-item-link">
Thanks for the help
</a>
</div>
<div class="outfit-font">
<a href="./bin/index.html" class="sub-item-link">
Website scripts
</a>
</div>
<div class="outfit-font">
<a href="./inc/index.html" class="sub-item-link">
Script include files
Contact us
</a>
</div>
</div>
@@ -242,11 +250,11 @@
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="./years.html">
Winning Entries
Winning entries
</a>
<a class="mobile-submenu-item" href="./authors.html">
Authors of winning IOCCC entries
Winning authors
</a>
<a class="mobile-submenu-item" href="./location.html">
@@ -257,6 +265,17 @@
Bugs and (mis)features
</a>
<a class="mobile-submenu-item" href="./faq.html#fix_an_entry">
Fixing entries
</a>
<a class="mobile-submenu-item" href="./faq.html#fix_author">
Updating author info
</a>
<a class="mobile-submenu-item" href="./thanks-for-help.html">
Thanks for the help
</a>
</div>
</div>
@@ -267,22 +286,25 @@
</div>
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="./news.html">
News
</a>
<a class="mobile-submenu-item" href="./status.html">
Contest status
</a>
<a class="mobile-submenu-item" href="./next/index.html">
Rules and Guidelines
</a>
<a class="mobile-submenu-item" href="./news.html">
IOCCC News
Rules and guidelines
</a>
<a class="mobile-submenu-item" href="./markdown.html">
IOCCC Markdown Guidelines
Markdown guidelines
</a>
<a class="mobile-submenu-item" href="./SECURITY.html">
Security policy
</a>
</div>
</div>
@@ -297,19 +319,19 @@
</a>
<a class="mobile-submenu-item" href="./faq.html#submit">
How to enter the IOCCC
How to enter
</a>
<a class="mobile-submenu-item" href="./faq.html#fix_an_entry">
Fixing IOCCC entries
<a class="mobile-submenu-item" href="./faq.html#compiling">
Compiling entries
</a>
<a class="mobile-submenu-item" href="./faq.html#fix_website">
Fixing the website
<a class="mobile-submenu-item" href="./faq.html#running_entries">
Running entries
</a>
<a class="mobile-submenu-item" href="./faq.html#fix_author">
Fixing author info
<a class="mobile-submenu-item" href="./faq.html#help">
How to help
</a>
</div>
@@ -322,31 +344,22 @@
<div class="mobile-submenu-wrapper">
<a class="mobile-submenu-item" href="./index.html">
IOCCC Home
Home page
</a>
<a class="mobile-submenu-item" href="./about.html">
About the IOCCC
</a>
<a class="mobile-submenu-item" href="./judges.html">
The IOCCC Judges
The Judges
</a>
<a class="mobile-submenu-item" href="./contact.html">
Contacting the IOCCC
</a>
<a class="mobile-submenu-item" href="./thanks-for-help.html">
Thanks for the help
</a>
<a class="mobile-submenu-item" href="./bin/index.html">
Website scripts
</a>
<a class="mobile-submenu-item" href="./inc/index.html">
Script include files
Contact us
</a>
</div>
</div>
</div>
</div>
</div>
@@ -412,7 +425,7 @@
<!-- BEFORE: 1st line of markdown file: faq.md -->
<h1 id="ioccc-faq-table-of-contents">IOCCC FAQ Table of Contents</h1>
<p>This is FAQ version <strong>28.1.2 2024-10-21</strong>.</p>
<p>This is FAQ version <strong>28.1.3 2024-10-25</strong>.</p>
<h2 id="entering-the-ioccc-the-bare-minimum-you-need-to-know">0. <a href="#enter_questions">Entering the IOCCC: the bare minimum you need to know</a></h2>
<ul>
<li><strong>Q 0.0</strong>: <a class="normal" href="#submit">How can I enter the IOCCC?</a></li>
@@ -431,7 +444,7 @@
<ul>
<li><strong>Q 1.0</strong>: <a class="normal" href="#answers_file">How can I avoid reentering the information to mkiocccentry?</a></li>
<li><strong>Q 1.1</strong>: <a class="normal" href="#prog_c">May I use a different source or compiled filename than prog.c or prog?</a></li>
<li><strong>Q 1.2</strong>: <a class="normal" href="#markdown">What are the IOCCC best practices for using markdown?</a></li>
<li><strong>Q 1.2</strong>: <a class="normal" href="#markdown">What is markdown and how does the IOCCC use it?</a></li>
<li><strong>Q 1.3</strong>: <a class="normal" href="#mkiocccentry_bugs">How do I report bugs in an <code>mkiocccentry</code> tool?</a></li>
</ul>
<h2 id="ioccc-judging-process">2. <a href="#judging">IOCCC Judging process</a></h2>
@@ -532,7 +545,7 @@
<h2 id="miscellaneous-ioccc">10. <a href="#misc">Miscellaneous IOCCC</a></h2>
<ul>
<li><strong>Q 10.0</strong>: <a class="normal" href="#mirrors">May I mirror the IOCCC website?</a></li>
<li><strong>Q 10.1</strong>: <a class="normal" href="#ioccc_copyright">Mat I use IOCCC content in an article, book, newsletter, or instructional material?</a></li>
<li><strong>Q 10.1</strong>: <a class="normal" href="#ioccc_copyright">May I use IOCCC content in an article, book, newsletter, or instructional material?</a></li>
<li><strong>Q 10.2</strong>: <a class="normal" href="#first_person">Why do you sometimes use the first person plural?</a></li>
<li><strong>Q 10.3</strong>: <a class="normal" href="#dot_files"> What is the purpose of the <code>.top</code>, <code>.allyear</code>, <code>.year</code> and <code>.path</code> files?</a></li>
<li><strong>Q 10.4</strong>: <a class="normal" href="#terms"> What is the current meaning of the IOCCC terms Author, Entry, and Submission?</a></li>
@@ -832,7 +845,7 @@ program(s), clean up any files made by the program etc.</li>
</div>
</div>
</div>
<p>First, <strong>PLEASE</strong> read the <a href="markdown.html">IOCCC Markdown Guidelines</a>.</p>
<p>First, <strong>PLEASE</strong> read the <a href="markdown.html">IOCCC markdown guidelines</a>.</p>
<p>Next, while you may put in as much or as little as you wish into your entry’s
<code>remarks.md</code> file, we do have few important suggestions:</p>
<p>We recommend that you explain how to use your entry. Explain the
@@ -933,7 +946,7 @@ For example:</p>
<p>Jump to: <a href="#">top</a></p>
<div id="markdown">
<div id="md">
<h3 id="q-1.2-what-are-the-ioccc-best-practices-for-using-markdown">Q 1.2: What are the IOCCC best practices for using markdown?</h3>
<h3 id="q-1.2-what-is-markdown-and-how-does-the-ioccc-use-it">Q 1.2: What is markdown and how does the IOCCC use it?</h3>
</div>
</div>
<p>The IOCCC makes extensive use of <a href="https://daringfireball.net/projects/markdown/">markdown</a>.
@@ -943,8 +956,9 @@ submit remarks about entry in markdown format. Every
as the basis for forming the <code>index.html</code> web page for that entry.
All generated HTML pages on the <a href="https://www.ioccc.org/index.html">Official IOCCC website</a>
start with some markdown content.</p>
<p><strong>IMPORTANT</strong>: Please read the <a href="markdown.html">IOCCC markdown best practices</a> guide
as it lists things you <strong>should not use</strong> in markdown files.</p>
<p><strong>IMPORTANT</strong>: Please read the <a href="markdown.html">IOCCC markdown guidelines</a>
as it lists things you <strong>should NOT use</strong> in markdown files and things you
<strong>should do</strong> as well.</p>
<p>See the <a href="https://www.markdownguide.org/basic-syntax">markdown syntax</a> guide.
See also <a href="https://spec.commonmark.org/current/">CommonMark Spec</a>.</p>
<p>Jump to: <a href="#">top</a></p>
@@ -4893,7 +4907,7 @@ date with the latest changes when possible. Thank you.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="permission">
<div id="ioccc_copyright">
<h3 id="q-10.1-mat-i-use-ioccc-content-in-an-article-book-newsletter-or-instructional-material">Q 10.1: Mat I use IOCCC content in an article, book, newsletter, or instructional material?</h3>
<h3 id="q-10.1-may-i-use-ioccc-content-in-an-article-book-newsletter-or-instructional-material">Q 10.1: May I use IOCCC content in an article, book, newsletter, or instructional material?</h3>
</div>
</div>
<p>While IOCCC judges look favorably on most requests to use IOCCC material,
@@ -5527,47 +5541,7 @@ announced in the early years of the IOCCC.</p>
<div id="explain_IOCCC">
<h3 id="q-11.6-i-do-not-understand-the-ioccc-can-you-explain-it-to-me">Q 11.6: I do not understand the IOCCC, can you explain it to me?</h3>
</div>
<p>The IOCCC stands for the International Obfuscated C Code Contest.
The IOCCC is a C programming contest.</p>
<p>The goals of the IOCCC are:</p>
<ul>
<li>To write the most Obscure/Obfuscated C program within the rules.</li>
<li>To show the importance of programming style, in an ironic way.</li>
<li>To stress C compilers with unusual code.</li>
<li>To illustrate some of the subtleties of the C language.</li>
<li>To provide a safe forum for poor C code. :-)</li>
<li>To have fun with C!</li>
</ul>
<p>See the
FAQ on “<a href="#ioccc_start">start of the IOCCC</a>”
and the
FAQ on “<a href="#website_history">history of the IOCCC</a>”
for more information the background of the IOCCC.</p>
<p>See the
FAQ on “<a href="#submit">entering the IOCCC</a>”
for information on how to enter and submit to the IOCCC.</p>
<p>If you are still confused, consider the nature of
the <a href="next/rules.html">IOCCC rules</a> and of the <a href="next/guidelines.html">IOCCC
guidelines</a>. You will see a dose of the technical,
mixed with “nerd humor” (or humour if you prefer 🤓).</p>
<p>If after all that you are still confused, sorry (tm Canada 😉).
Consider this: While the IOCCC often attempts to be presentable,
it is under no obligation to be wholly understandable. One might
say that to truly understand the IOCCC is problematic. And if
someone did manage to fully understand the IOCCC, then perhaps
this <strong>modified</strong> quote from the <a href="https://en.wikipedia.org/wiki/The_Hitchhiker&#39;s_Guide_to_the_Galaxy">The Hitchhiker’s Guide to the
Galaxy</a>
may apply:</p>
<blockquote>
<p>“There is a theory which states that if ever anyone discovers
exactly what the IOCCC is for and why it is here, it will
instantly disappear and be replaced by something even more bizarre
and inexplicable.</p>
<p>There is another theory which states that this has
<a href="#great_fork_merge">already happened</a>.” 😜</p>
</blockquote>
<p>Share and enjoy! ☺️</p>
<p>Jump to: <a href="#">top</a></p>
<p>Please see the <a href="about.html">About the IOCCC page</a> for more details.</p>
<!--
Copyright © 1984-2024 by Landon Curt Noll. All Rights Reserved.