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

markdown.html
+116 -74
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>
@@ -411,8 +424,20 @@
<!-- START: this line starts content for HTML phase 21 by: bin/pandoc-wrapper.sh via bin/md2html.sh -->
<!-- BEFORE: 1st line of markdown file: markdown.md -->
<div id="guidelines">
<h1 id="ioccc-markdown-guidelines">IOCCC markdown guidelines</h1>
<div id="markdown_guidelines">
<h1 id="ioccc-28th-markdown-guidelines">IOCCC 28th Markdown Guidelines</h1>
</div>
<div id="markdown_version">
<h2 id="ioccc-markdown-guidelines-version">IOCCC Markdown guidelines version</h2>
</div>
<p class="leftbar">
These <a href="markdown.html">IOCCC markdown guidelines</a> are version <strong>28.0 2024-10-25</strong>.
</p>
<p><strong>IMPORTANT</strong>: Be sure to read the <a href="next/rules.html">IOCCC rules</a> and <a href="next/guidelines.html">IOCCC
guidelines</a>.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="markdown">
<h2 id="ioccc-markdown-guidelines">IOCCC Markdown guidelines</h2>
</div>
<p>The IOCCC makes extensive use of <a href="https://daringfireball.net/projects/markdown/">markdown</a>.
For example, when submitting to the IOCCC
@@ -431,6 +456,7 @@ Some of these relate to use of markdown directly and others relate to injecting
into the markdown file.</p>
<p>In particular there are things we ask people to please <strong>NOT</strong> use in
markdown files for the IOCCC:</p>
<p>Jump to: <a href="#">top</a></p>
<div id="name">
<div id="anchor-name">
<h2 id="please-do-not-use-the-name-attributes-in-html-a...a-hyperlink-elements">Please do NOT use the <code>name</code> attributes in HTML <code>&lt;a&gt;...&lt;/a&gt;</code> hyperlink elements</h2>
@@ -454,6 +480,7 @@ for the given page URL.</p>
# This will work
&lt;/div&gt;</code></pre>
<p>While some browsers will still recognize the HTML construct <code>&lt;a name="string"&gt;...&lt;/a&gt;</code>, it is possible <strong>they MIGHT NOT</strong> in the future.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="links">
<h2 id="if-you-can-it-is-preferable-to-use-markdown-links-rather-than-a...a">If you can, it is PREFERABLE to use markdown links rather than <code>&lt;a&gt;...&lt;/a&gt;</code></h2>
</div>
@@ -463,6 +490,7 @@ anchors.</p>
<pre><code> Use of &lt;a href=&quot;#links&gt;HTML anchors&lt;/a&gt;
is one option, however ...</code></pre>
<pre><code> [markdown links](#links) are easier and preferred</code></pre>
<p>Jump to: <a href="#">top</a></p>
<div id="strike">
<div id="del">
<h2 id="please-do-not-use-the-strike-or-the-s-html-element">Please do NOT use the <code>&lt;strike&gt;</code> or the <code>&lt;s&gt;</code> HTML element</h2>
@@ -474,6 +502,7 @@ anchors.</p>
&lt;s&gt;...&lt;/s&gt; &lt;=== no thank you</code></pre>
<p>Use instead:</p>
<pre><code> &lt;del&gt;...&lt;/del&gt;</code></pre>
<p>Jump to: <a href="#">top</a></p>
<div id="underline">
<div id="ins">
<h2 id="please-do-not-use-the-u-html-element">Please do NOT use the <code>&lt;u&gt;</code> HTML element</h2>
@@ -483,6 +512,7 @@ anchors.</p>
<pre><code> &lt;u&gt;...&lt;/u&gt; &lt;=== no thank you</code></pre>
<p>Use instead:</p>
<pre><code> &lt;ins&gt;...&lt;/ins&gt;</code></pre>
<p>Jump to: <a href="#">top</a></p>
<div id="tt">
<div id="span">
<h2 id="please-do-not-use-the-tt-html-element">Please do NOT use the <code>&lt;tt&gt;</code> HTML element</h2>
@@ -497,6 +527,7 @@ anchors.</p>
however ... &lt;/span&gt;</code></pre>
<p>We recommend using the inline markdown code block method instead:</p>
<pre><code> Using the `inline markdown code block` is easier and is **preferred**.</code></pre>
<p>Jump to: <a href="#">top</a></p>
<div id="unindented">
<div id="indented">
<h2 id="please-do-not-use-unindented-code-blocks">Please do NOT use unindented code blocks</h2>
@@ -523,6 +554,7 @@ echo &quot;This code block is NOT indented&quot; &lt;===
The same thing applies to any markdown block surrounded by ``` lines.
```</code></pre>
<p>Please do <strong>NOT</strong> indent using ASCII tab characters in markdown files.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="tabs">
<div id="spaces">
<h2 id="please-do-not-use-ascii-tabs-in-markdown-files">Please do NOT use ASCII tabs in markdown files</h2>
@@ -553,6 +585,7 @@ not C code or any other non-markdown content:</p>
<p><strong>NOTE</strong>: Again, you are <strong>perfectly welcome</strong> to use ASCII tab characters in
your C code and other non-markdown files. We simply ask that you do <strong>NOT</strong> use any
ASCII tab characters in markdown files.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="vim-tabs">
<h3 id="tip-for-vim-users">Tip for <code>vim</code> users</h3>
</div>
@@ -571,6 +604,7 @@ spaces.</p>
<p>To <strong>VERIFY</strong> that there are no tabs in a file you may do, in command mode:</p>
<pre><code> /\t</code></pre>
<p>If you’re in insert mode hit <code>ESC</code> first.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="languages">
<div id="code">
<h2 id="please-use-html-comments-to-specify-a-language-for-a-code-block">Please use HTML comments to specify a language for a code block</h2>
@@ -592,6 +626,7 @@ markdown code block starting fence by a space:</p>
and <strong>THEN</strong> an <strong>opening</strong> <strong><code>&lt;!---</code></strong> (a “<code>&lt;</code>”, a “<code>!</code>” and then three “<code>-</code>”s), and
<strong>THEN</strong> the <strong>language</strong> and <strong>FINALLY</strong> a <strong>closing</strong> “<code>--&gt;</code>” (two “<code>-</code>”s
followed by a “<code>&gt;</code>”).</p>
<p>Jump to: <a href="#">top</a></p>
<div id="slash">
<div id="void">
<h2 id="please-do-not-add-trailing-slash-to-void-html-elements">Please do NOT add trailing slash to void HTML elements</h2>
@@ -622,6 +657,7 @@ unquoted attribute values.</p>
alt=&quot;image of a tattoo of the 1984 anonymous C code&quot;
width=600 height=401&gt;</code></pre>
<p>etc.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="backslash">
<div id="br">
<h2 id="please-do-not-use-a-trailing-backslash-outside-of-a-code-block">Please do NOT use a TRAILING backslash (<code>\</code>) outside of a code block</h2>
@@ -651,6 +687,7 @@ a trailing <code>&lt;br&gt;</code>.</p>
<pre><code> `This is OK\`</code></pre>
<p>Doing it this way will prevent <code>pandoc(1)</code> from generating deprecated HTML
elements such as <code>&lt;br /&gt;</code>.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="images">
<div id="img">
<h2 id="please-do-not-use-markdown-style-images">Please do NOT use markdown style images</h2>
@@ -675,6 +712,7 @@ HTML from the markdown image construct, the resulting HTML does <strong>NOT</str
have <code>width</code> and <code>height</code> information so browsers have to slow down
on rendering text around the image until it can internally determine
the image size.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="hr">
<div id="horizontal">
<div id="lines">
@@ -692,6 +730,7 @@ effect in standard HTML 5 and interacts badly with unquoted attribute values.</p
<pre><code> &lt;hr&gt;</code></pre>
<p>If a short line is needed, use:</p>
<pre><code> &lt;hr style=&quot;width:10%;text-align:left;margin-left:0&quot;&gt;</code></pre>
<p>Jump to: <a href="#">top</a></p>
<div id="parentheses">
<h2 id="please-do-not-put-a-literal-or-in-markdown-link-titles">Please do NOT put a LITERAL “<code>(</code>” or “<code>)</code>” in markdown link titles</h2>
</div>
@@ -704,6 +743,7 @@ effect in standard HTML 5 and interacts badly with unquoted attribute values.</p
<pre><code> [ls(1)](https://example.com/ls-man-page.1) &lt;=== no thank you</code></pre>
<p>use:</p>
<pre><code> [ls&amp;lpar;1&amp;rpar;](https://example.com/ls-man-page.1)</code></pre>
<p>Jump to: <a href="#">top</a></p>
<div id="closing-parentheses">
<h2 id="please-do-not-end-markdown-links-with">Please do NOT end markdown links with “<code>))</code>”</h2>
</div>
@@ -718,6 +758,7 @@ to incorrect URLs or file paths.</p>
<pre><code> This thing, ([some text](some/path)), is NOT ideal. &lt;=== no thank you</code></pre>
<p>use:</p>
<pre><code> This thing, [some text](some/path), is better.</code></pre>
<p>Jump to: <a href="#">top</a></p>
<div id="code-text">
<div id="code-and-text">
<div id="text">
@@ -749,6 +790,7 @@ C compilers cannot be given a -Wno-main-arg-errors flag. &lt;=== no thank y
C compilers cannot be given a -Wno-main-arg-errors flag.</code></pre>
<p><strong>BTW</strong>: Please note the blank line after the code block.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="italics">
<h2 id="please-use-_-for-italics-in-markdown">Please use <code>_</code> for italics in markdown</h2>
</div>