From 8ef10b3df62156eb439ef4b8708fbd759439afbe Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Thu, 27 Nov 2025 21:04:07 -0800 Subject: [PATCH] make quick_ww due to recent commits --- markdown.html | 292 ++++++++++++++++++++++++++------------------------ sitemap.xml | 14 +-- 2 files changed, 156 insertions(+), 150 deletions(-) diff --git a/markdown.html b/markdown.html index 2dbc9961b..e19b81fc1 100644 --- a/markdown.html +++ b/markdown.html @@ -480,26 +480,32 @@ and ✔️ for preferred correct one.

Start remarks.md sections at level 3

If (it is not required) you do use sections in your remarks.md file (this does not apply to other markdown files), PLEASE start at level three up to level six:

-
❌ # Section Reserved
-❌ ## Section Reserved
-✔️ ### Section Level 3
-✔️ #### Section Level 4
-✔️ ##### Section Level 5
-✔️ ###### Section Level 6
+

❌ Reserved in remarks.md only.

+
# Section Reserved
+## Section Reserved
+

✔ Available every where.

+
### Section Level 3
+#### Section Level 4
+##### Section Level 5
+###### Section Level 6

Replace <a name="anchor_name"></a> construct.

-
❌ <a name="old_way">...</a>
-✔️ <div id="new_way">...</div>
-✔️ 
-✔️ ### Section title
+

❌ Incorrect.

+
<a name="old_way">Section title</a>
+

✔ Correct.

+
<div id="new_way"></div>
+
+### Section title
-
❌ This <a href="#link_target>HTML link text</a> works, but we prefer
-✔️ [markdown link text](#link_target)
+

❌ Incorrect.

+
This <a href="#link_target>HTML link text</a> works, but we prefer see below...
+

✔ Correct.

+
[markdown link text](#link_target)
@@ -507,11 +513,12 @@ not apply to other markdown files), PLEASE start at level three

Replace <strike> or <s>

-
❌ <strike>striked through text</strike>
-❌ <s>HTML 5 striked through text</s>
-
-✔️ <del>HTML 5 striked through text</del>
-✔️ ~~markdown striked through text~~
+

❌ Incorrect.

+
<strike>striked through text</strike>
+<s>HTML 5 striked through text</s>
+

✔ Correct.

+
~~markdown striked through text~~
+<del>HTML 5 striked through text</del>
@@ -519,35 +526,42 @@ not apply to other markdown files), PLEASE start at level three

Replace <u>

-
❌ <u>old tags</u>
-✔️ <ins>HTML 5 tags</ins>
+

❌ Incorrect.

+
<u>old tags</u>
+

✔ Correct.

+
<ins>HTML 5 tags</ins>

Replace <tt>

-
❌ <tt>obsolete HTML</tt>
-✔️ <span style="font-family: monospace;">monospace font</span>
-✔️ `markdown style monospace`
+

❌ Incorrect.

+
<tt>obsolete HTML</tt>
+

✔ Correct.

+
<span style="font-family: monospace;">monospace font</span>
+`markdown style monospace`

Indent code blocks by four spaces, not by TAB.

-
❌ echo "This code block is NOT indented"
+

❌ Incorrect.

+
echo "This code block is NOT indented"

We request that you indent the code block by multiples of four (4) ASCII SPACES, never TAB (␉):

-
✔️      echo "This code block is indented by multiples of 4 spaces"
+
✔ Correct.

+
    echo "This code block is indented by multiples of 4 spaces"
 
-✔️     # The top level starts with a 4 ASCII space indent.
-✔️     #
-✔️     # Only indent with multiples of 4 ASCII spaces.
-✔️         # 2nd level indent needs 8 ASCII spaces (no tabs).
-✔️             # 3rd level indent needs 12 ASCII spaces (no tabs).
-✔️                 # etc.

+    # The top level starts with a 4 ASCII space indent.
+    #
+    # Only indent with multiples of 4 ASCII spaces.
+        # 2nd level indent needs 8 ASCII spaces (no tabs).
+            # 3rd level indent needs 12 ASCII spaces (no tabs).
+                # etc.

Alternatively its possible to use ``` marks, without the initial four (4) space indentation. This is usually the better method.

-
✔️ ```
-✔️ The same thing applies to any markdown block bracketed by ``` lines.
-✔️ ```
+

✔ Also correct.

+
```
+The same thing applies to any markdown block bracketed by ``` lines.
+```
@@ -562,23 +576,20 @@ we have discovered that ASCII TAB (␉) characters create problems when used as part of the leading whitespace within a markdown file.

If you need to indent two (2) or more levels, use multiples of four (4) ASCII SPACES.

+

❌ Incorrect for markdown files only.

```
-❌ ␉Please do **NOT**␉use ASCII tabs␉in markdown files.
-❌ ␉␉Please do **NOT** indent markdown with ASCII tabs.
+␉Please do **NOT**␉use ASCII tabs␉in markdown files.
+␉␉Please do **NOT** indent markdown with ASCII tabs.
 
-❌ ␉We␉don't␉mind␉tabs␉in␉general,
-❌ ␉We just ask that you NOT use them in markdown files.
+␉We␉don't␉mind␉tabs␉in␉general,
+␉We just ask that you NOT use them in markdown files.
 ```
-

And to clarify, we are only talking about markdown files, not C code or -any other non-markdown content:

-
✔️ ␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
-✔️ ␉␉/*␉if␉you␉wish    */
+
✔ Ok for all file types, eg. .c, .h, .mk, .sh, EXCEPT .md markdown files.

+
␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
+␉␉/*␉if␉you␉wish    */
 
-✔️ ␉// We ask that you to NOT use ASCII tab characters in your remarks.md writeup,
-✔️ ␉// or in any other markdown files within your entry, please.

-
NOTE: Again, you are perfectly welcome to use ASCII TAB (␉) characters
-in your C code and other non-markdown files. We simply ask that you do
-NOT use any ASCII TAB (␉) characters in markdown files.

+␉// We ask that you to NOT use ASCII tab characters in your remarks.md writeup,
+␉// or in any other markdown files within your entry, please.
@@ -586,64 +597,57 @@ in your C code and other non-markdown files. We simply ask that you do

Use HTML comments for code block language syntax.

-

We request that fenced markdown code blocks -NOT specify a language directly.

-
❌ ```c
-❌     int main(void) {return 0;}
-❌ ```
+

We request that fenced markdown code blocks NOT specify a language directly.

+

❌ Incorrect

+
```c
+    int main(void) {return 0;}
+```

Instead, put the language inside an HTML comment, separated from the markdown code block starting fence by a space:

-
✔️ ```<!---c-->
-✔️    int main(void) {return 0;}
-✔️ ```
-

IMPORTANT: The initial   ` ` `   must be -followed by an ASCII SPACE, and THEN an opening -<!--- (a “<”, a “!” and then three “-”s), and THEN -the language and FINALLY a closing “-->” (two “-”s -followed by a “>”).

+

✔ Correct

+
```<!---c-->
+   int main(void) {return 0;}
+```

Ensure blank line between code block and text.

-

Please do NOT place text on the next line after a markdown code -block. Instead, place a blank line after the end of a markdown code -block as this makes it easier to detect when markdown code blocks are -NOT properly indented.

-
   ```
-   int
-   main(int foo)
-   {
-      return foo;
-   }
-❌ ```
-❌ C compilers cannot be given a -Wno-main-arg-errors flag.
+
❌ Incorrect, missing empty line after closing fence (```).

+
```
+int
+main(int foo)
+{
+   return foo;
+}
+```
+C compilers cannot be given a -Wno-main-arg-errors flag.

+
✔ Correct, has empty line between closing fence and subsequent text.

+
```
+int
+main(int foo)
+{
+    return foo;
+}
+```
 
-   ```
-       int
-       main(int foo)
-       {
-           return foo;
-       }
-✔️ ```
-✔️
-✔️ C compilers cannot be given a -Wno-main-arg-errors flag.

+C compilers cannot be given a -Wno-main-arg-errors flag.

Do not add trailing slash to void HTML tags.

-

Please do NOT use a trailing slash on void HTML elements. See also -this note on trailing slashes in void-element start tags.

-

The trailing slash on void HTML elements has no effect and interacts -badly with unquoted attribute values.

-
❌ <br/>
-❌ <hr/>
-❌ <img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
-   the 1984 anonymous C code" width=600 height=401 />
-
-✔️ <br>
-✔️ <hr>
-✔️ <img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
-   the 1984 anonymous C code" width=600 height=401>
+

The trailing slash on void HTML elements has no effect and interacts +badly with unquoted attribute values; do not use. See also this note +on trailing slashes in void-element start tags.

+

❌ Incorrect

+
<br/>
+<hr/>
+<img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
+the 1984 anonymous C code" width=600 height=401 />
+

✔ Correct

+
<br>
+<hr>
+<img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
+the 1984 anonymous C code" width=600 height=401>
@@ -651,41 +655,39 @@ badly with unquoted attribute values.

Do not use a trailing backslash outside of a code block

-

Unless the line is inside a markdown code block, please do NOT end -a markdown line with a trailing backslash (\). Instead use a trailing -<br>.

-
❌ In markdown,\
-❌ do NOT use trailing\
-❌ backslashes outside of\
-❌ a code block
+
❌ Incorrect, do not use escaped newlines outside of a code block.

+
In markdown,\
+do NOT use trailing\
+backslashes outside of\
+a code block

+
✔ Correct

+
In markdown,<br>
+use trailing<br>
+br's outside of<br>
+a code block
 
-✔️ In markdown,<br>
-✔️ use trailing<br>
-✔️ br's outside of<br>
-✔️ a code block
+```
+This is OK\
+inside a\
+markdown code\
+block
+```
 
-✔️ ```
-✔️ This is OK\
-✔️ inside a\
-✔️ markdown code\
-✔️ block
-✔️ ```
-
-✔️ `This is OK\`

+`This is OK\`

Doing it this way will prevent pandoc(1) from generating deprecated HTML elements, such as <br />.

Do not use markdown style images

-

Instead of using this markdown element to embed an image:

-
❌ ![alt text](filename.png "Title")
+
❌ Incorrect

+
![alt text](filename.png "Title")

+
✔ Correct

+
<img src="filename.png"
+alt="describe the filename.png image for someone who cannot view it"
+width=PIXEL_WIDTH height=PIXEL_HEIGHT>
 
-✔️ <img src="filename.png"
-   alt="describe the filename.png image for someone who cannot view it"
-   width=PIXEL_WIDTH height=PIXEL_HEIGHT>
-
-   Which allows for HTML <img> attributes `alt=`, `width=` and `length=`.

+Which allows for HTML <img> attributes `alt=`, `width=` and `length=`.

The problem is that pandoc(1) generates problematic HTML from the markdown image construct, the resulting HTML does NOT have width and height information so browsers have to slow down on rendering @@ -701,35 +703,38 @@ a line with 3 or more dashes (“-”s).

Such markdown causes pandoc(1) to generate <hr />. The <hr /> has no effect in standard HTML 5 and interacts badly with unquoted attribute values.

-
❌ * * *
-❌ - - -
-❌ ---
+
❌ Incorrect

+
* * *
+- - -
+---

+
✔ Correct

+
Regular divider...
+<hr>
 
-   Regular divider...
-✔️ <hr>
-
-   A short divider...
-✔️ <hr style="width:10%;text-align:left;margin-left:0">

+A short divider...
+<hr style="width:10%;text-align:left;margin-left:0">
-
❌ [some (text)](https://example.com/curds)
-✔️ [some &lpar;text&rpar;](https://example.com/curds)
-
-❌ [ls(1)](https://example.com/ls-man-page.1)
-✔️ [ls&lpar;1&rpar;](https://example.com/ls-man-page.1)
+

❌ Incorrect

+
[some (text)](https://example.com/curds)
+[ls(1)](https://example.com/ls-man-page.1)
+

✔ Correct

+
[some &lpar;text&rpar;](https://example.com/curds)
+[ls&lpar;1&rpar;](https://example.com/ls-man-page.1)

Markdown links that end in “))” complicate parsing and sometimes lead to incorrect URLs or file paths.

-
❌ [some text](https://example.com/foo_(bar))
-✔️ [some text](https://example.com/foo_&lpar;bar&rpar;)
-
-❌ This thing, ([some text](some/path)), is NOT ideal.
-✔️ This thing, [some text](some/path), is better.
+

❌ Incorrect

+
[some text](https://example.com/foo_(bar))
+This thing, ([some text](some/path)), is NOT ideal.
+

✔ Correct

+
[some text](https://example.com/foo_&lpar;bar&rpar;)
+This thing, [some text](some/path), is better.
@@ -738,12 +743,13 @@ to incorrect URLs or file paths.

Instead use an underscore (_). Using an asterisk can complicate parsing and sometimes lead to incorrect results. This can especially go for when it is bold and italic.

-
❌ *this text is italic*
-✔️ _this text is italic_
-
-❌ ***this text is bold italic***
-✔️ **_this text is bold italic_**
-✔️ _**this text is bold italic**_
+

❌ Incorrect

+
*this text is italic*
+***this text is bold italic***
+

✔ Correct

+
_this text is italic_
+**_this text is bold italic_**
+_**this text is bold italic**_

BTW: the astute reader might notice that some cases of * for italic might have slipped through. We do ask you, however, to please observe this rule, as best you can. diff --git a/sitemap.xml b/sitemap.xml index cc515e541..770827a54 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -16810,11 +16810,11 @@ https://www.ioccc.org/markdown.html - 2025-11-27T15:59:15+00:00 + 2025-11-28T05:02:34+00:00 https://www.ioccc.org/markdown.md - 2025-11-27T15:58:56+00:00 + 2025-11-28T04:59:17+00:00 https://www.ioccc.org/news.html @@ -16826,11 +16826,11 @@ https://www.ioccc.org/next/guidelines.html - 2025-11-27T15:58:32+00:00 + 2025-11-28T04:58:56+00:00 https://www.ioccc.org/next/guidelines.md - 2025-11-27T15:58:32+00:00 + 2025-11-28T04:58:56+00:00 https://www.ioccc.org/next/index.html @@ -16870,11 +16870,11 @@ https://www.ioccc.org/next/rules.html - 2025-11-27T15:59:14+00:00 + 2025-11-28T04:58:56+00:00 https://www.ioccc.org/next/rules.md - 2025-11-27T15:58:56+00:00 + 2025-11-28T04:58:56+00:00 https://www.ioccc.org/next/submit.html @@ -16938,7 +16938,7 @@ https://www.ioccc.org/status.html - 2025-11-27T07:15:03+00:00 + 2025-11-28T05:02:53+00:00 https://www.ioccc.org/status.json