The IOCCC makes extensive use of markdown.
-For example, we submitting to the IOCCC, we have people
-to submit remarks about entry in markdown format. Every
+For example, when submitting to the IOCCC, we have people
+submit remarks about their entry in markdown format. Every
winning IOCCC entry uses a README.md markdown file
as the basis for forming the index.html web page for that entry.
All generated HTML pages on the Official IOCCC website
start with some markdown content.
See the markdown syntax guide. -See also CommonMark Spec.
+See also the CommonMark Spec.Nevertheless, the IOCCC does have certain practices that we ask authors to follow. -Some these relate to use of markdown directly, others relate to injecting HTML +Some of these relate to use of markdown directly and others relate to injecting HTML into the markdown file.
-In particular there are things we ask people to please do NOT use in +
In particular there are things we ask people to please NOT use in markdown files for the IOCCC:
<a ..> hyperlink elementsPlease do NOT use the HTML construct:
- <a name="string">...</a> <=== no thank you <a name="string">...</a> <!-- no thank you -->as those are NOT part of the HTML 5 standard.
Instead use:
<div id="string">...</div>There are certain HTML Elements that cannot have internal <div id="string">...</div>.
For example:
- # <div id="string">THIS WILL NOT WORK!</div> <=== this will not workFor things like headings, you have to surround them as in:
+ # <div id="string">THIS WILL NOT WORK!</div> <!-- this will not work -->For things like headings, you have to surround them, as in:
<div id="string">
# This will work
</div>While some browsers will still recognize the HTML construct <a name="string">...</a>, it is possible they might NOT in the future.
<strike> nor <s> HTML elementPlease NOT use the obsolete <strike> nor <s> ( strikeout ) HTML elements:
<strike>...</strike> <=== no thank you
- <s>...</s> <=== no thank you<strike> or <s> HTML elementPlease NOT use the obsolete <strike> or <s> (strikeout) HTML elements:
<strike>...</strike> <!-- no thank you -->
+ <s>...</s> <!-- no thank you -->Use instead:
<del>...</del><u> HTML elementPlease NOT use the obsolete <u> (underline) HTML element:
<u>...</u> <=== no thank you <u>...</u> <!-- no thank you -->Use instead:
<ins>...</ins><tt> HTML elementPlease do NOT use the obsolete <tt> (teletype) HTML element:
<tt>The obsolete tt element is obsolete</tt> <=== no thank you <tt>The obsolete tt element is obsolete</tt> <!-- no thank you -->Instead use either a monospaced span:
<span style="font-family: monospace;">Use of monospaced font is one option</span>Or better and easier still, use an inline markdown code block:
@@ -436,8 +436,7 @@ for the given page URL.Please do NOT start code blocks at the left-hand edge.
```
-This code block <=== no thank you
-is NOT indented
+This code block is NOT indented <!-- no thank you -->
```We request that you indent the code block by 4 spaces:
```
diff --git a/markdown.md b/markdown.md
index 3be81312f..9f91caeb2 100644
--- a/markdown.md
+++ b/markdown.md
@@ -1,21 +1,21 @@
# IOCCC markdown best practices
The IOCCC makes extensive use of [markdown](https://daringfireball.net/projects/markdown/).
-For example, we [submitting to the IOCCC](faq.html#submit), we have people
-to submit remarks about entry in markdown format. Every
+For example, when [submitting to the IOCCC](faq.html#submit), we have people
+submit remarks about their entry in markdown format. Every
[winning IOCCC entry](years.html) uses a `README.md` markdown file
as the basis for forming the `index.html` web page for that entry.
All generated HTML pages on the [Official IOCCC website](https://www.ioccc.org/index.html)
start with some markdown content.
See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide.
-See also [CommonMark Spec](https://spec.commonmark.org/current/).
+See also the [CommonMark Spec](https://spec.commonmark.org/current/).
Nevertheless, the IOCCC does have certain practices that we ask authors to follow.
-Some these relate to use of markdown directly, others relate to injecting HTML
+Some of these relate to use of markdown directly and others relate to injecting HTML
into the markdown file.
-In particular there are things we ask people to please do **NOT** use in
+In particular there are things we ask people to please **NOT** use in
markdown files for the IOCCC:
@@ -24,7 +24,7 @@ markdown files for the IOCCC:
Please do **NOT** use the HTML construct:
```
- ... <=== no thank you
+ ...
```
as those are **NOT** part of the HTML 5 standard.
@@ -46,10 +46,10 @@ id="string">...`.
For example:
```
- # THIS WILL NOT WORK! <=== this will not work
+ # THIS WILL NOT WORK!
```
-For things like headings, you have to surround them as in:
+For things like headings, you have to surround them, as in:
```
@@ -61,13 +61,13 @@ While some browsers will still recognize the HTML construct `...`, it is possible they might NOT in the future.
-## Please do NOT use the `` nor `` HTML element
+## Please do NOT use the `` or `` HTML element
-Please NOT use the obsolete `` nor `` ( _strikeout_ ) HTML elements:
+Please NOT use the obsolete `` or `` (_strikeout_) HTML elements:
```
- ... <=== no thank you
- ... <=== no thank you
+ ...
+ ...
```
Use instead:
@@ -82,7 +82,7 @@ Use instead:
Please NOT use the obsolete `` (_underline_) HTML element:
```
- ... <=== no thank you
+ ...
```
Use instead:
@@ -97,7 +97,7 @@ Use instead:
Please do **NOT** use the obsolete `` (_teletype_) HTML element:
```
- The obsolete tt element is obsolete <=== no thank you
+ The obsolete tt element is obsolete
```
Instead use either a monospaced span:
@@ -119,8 +119,7 @@ Please do **NOT** start code blocks at the left-hand edge.
````
```
-This code block <=== no thank you
-is NOT indented
+This code block is NOT indented
```
````
diff --git a/news.html b/news.html
index aa30c4f69..f5c0d13c0 100644
--- a/news.html
+++ b/news.html
@@ -80,7 +80,7 @@
@@ -106,7 +106,7 @@
@@ -236,7 +236,7 @@
- Bugs & (Mis)features
+ Bugs and (mis)features
@@ -254,7 +254,7 @@
- Rules & Guidelines
+ Rules and Guidelines
diff --git a/next/guidelines.html b/next/guidelines.html
index 02d312a14..802d9ae2d 100644
--- a/next/guidelines.html
+++ b/next/guidelines.html
@@ -80,7 +80,7 @@
@@ -106,7 +106,7 @@
@@ -236,7 +236,7 @@
- Bugs & (Mis)features
+ Bugs and (mis)features
@@ -254,7 +254,7 @@
- Rules & Guidelines
+ Rules and Guidelines
diff --git a/next/index.html b/next/index.html
index b13103b22..e98061a30 100644
--- a/next/index.html
+++ b/next/index.html
@@ -80,7 +80,7 @@
@@ -106,7 +106,7 @@
@@ -236,7 +236,7 @@
- Bugs & (Mis)features
+ Bugs and (mis)features
@@ -254,7 +254,7 @@
- Rules & Guidelines
+ Rules and Guidelines
diff --git a/next/rules.html b/next/rules.html
index e35b2dcdd..a50cc3d69 100644
--- a/next/rules.html
+++ b/next/rules.html
@@ -80,7 +80,7 @@
@@ -106,7 +106,7 @@
@@ -236,7 +236,7 @@
- Bugs & (Mis)features
+ Bugs and (mis)features
@@ -254,7 +254,7 @@
- Rules & Guidelines
+ Rules and Guidelines
diff --git a/nojs-menu.html b/nojs-menu.html
index 85e820a30..cbc44d3ee 100644
--- a/nojs-menu.html
+++ b/nojs-menu.html
@@ -80,7 +80,7 @@
@@ -106,7 +106,7 @@
@@ -236,7 +236,7 @@
- Bugs & (Mis)features
+ Bugs and (mis)features
@@ -254,7 +254,7 @@
- Rules & Guidelines
+ Rules and Guidelines
@@ -388,18 +388,18 @@
Winning Entries
People who have won
Location of authors
-Bugs & Misfeatures
+Bugs and (mis)features
Status
FAQ
- FAQ
-- How to enter the IOCCC
+- How to enter the IOCCC
- Fixing IOCCC entries
- Fixing the website
- Fixing author info
diff --git a/nojs-menu.md b/nojs-menu.md
index e502ff5a5..e3ead29ad 100644
--- a/nojs-menu.md
+++ b/nojs-menu.md
@@ -5,18 +5,18 @@
* [Winning Entries](years.html)
* [People who have won](authors.html)
* [Location of authors](location.html)
-* [Bugs & Misfeatures](bugs.html)
+* [Bugs and (mis)features](bugs.html)
## Status
* [IOCCC News](news.html)
* [Contest status](status.html)
-* [Rules & Guidelines](next/index.html)
+* [Rules and Guidelines](next/index.html)
## FAQ
* [FAQ](faq.html)
-* [How to enter the IOCCC](faq.html#fix_an_entry)
+* [How to enter the IOCCC](faq.html#submit)
* [Fixing IOCCC entries](faq.html#fix_an_entry)
* [Fixing the website](faq.html#fix_web_site)
* [Fixing author info](faq.html#fix_author)
diff --git a/status.html b/status.html
index e3d268921..7bba4203d 100644
--- a/status.html
+++ b/status.html
@@ -80,7 +80,7 @@
@@ -106,7 +106,7 @@
@@ -236,7 +236,7 @@
- Bugs & (Mis)features
+ Bugs and (mis)features
@@ -254,7 +254,7 @@
- Rules & Guidelines
+ Rules and Guidelines
diff --git a/thanks-for-help.html b/thanks-for-help.html
index 8239cb14c..ba8fdda98 100644
--- a/thanks-for-help.html
+++ b/thanks-for-help.html
@@ -80,7 +80,7 @@
@@ -106,7 +106,7 @@
@@ -236,7 +236,7 @@
- Bugs & (Mis)features
+ Bugs and (mis)features
@@ -254,7 +254,7 @@
- Rules & Guidelines
+ Rules and Guidelines