Support inline comments

[LesML] / README.markdown

diff --git a/README.markdown b/README.markdown
index 14716c20c628937e551294aaa4706ae7714d626d..327f253c5d3c63fdb24c0c14ba3e1607a4d43b1e 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -1,5 +1,5 @@
 <!--
 <!--

-SPDX-FileCopyrightText: 2024 Lady <https://www.ladys.computer/about/#lady>
+SPDX-FileCopyrightText: 2024, 2025 Lady <https://www.ladys.computer/about/#lady>

 SPDX-License-Identifier: CC0-1.0
 -->
 # 💄📝 Les·M·L
 SPDX-License-Identifier: CC0-1.0
 -->
 # 💄📝 Les·M·L


@@ -103,12 +103,19 @@ Non·empty paragraphs are classified as follows :⁠—
   There is only one level of paragraph quoting; quoted paragraphs may
     not be quoted again.
 
   There is only one level of paragraph quoting; quoted paragraphs may
     not be quoted again.
 

+- If every line in the paragraph begins with zero or more white·space
+    characters followed by `|`, it is a “preformatted” paragraph and
+    white·space is not collapsed (`<html:pre>`).
+  A paragraph may be both quoted and preformatted.
+

 - Otherwise, the paragraph is unquoted.
 
 After this classification, each quoted or unquoted paragraph is further
   classified by type based on its first character (which is must be
    followed by white·space, or else the only thing on the line) :⁠—
 
 - Otherwise, the paragraph is unquoted.
 
 After this classification, each quoted or unquoted paragraph is further
   classified by type based on its first character (which is must be
    followed by white·space, or else the only thing on the line) :⁠—
 

+- If the paragraph is preformatted, it is an ordinary paragraph.
+

 - If the paragraph begins with `⁌`, it is a chapter heading
     (`<html:h1>`).
 
 - If the paragraph begins with `⁌`, it is a chapter heading
     (`<html:h1>`).
 


@@ -181,6 +188,11 @@ The remaining characters in a paragraph form its contents.
 Markup within paragraphs is delimited with·out exception by pairs of
   characters, with the following precedence :⁠—
 
 Markup within paragraphs is delimited with·out exception by pairs of
   characters, with the following precedence :⁠—
 

+- The characters `⌦` and `⌫` indicate inline comments.
+  A single character `⌧` may be used to indicate an “empty” comment
+    (consisting of `U+034F COMBINING GRAPHEME JOINER` for X·M·L
+    compatibility).
+

 - The characters `{🔗` and `>}` indicate a hyperlink to a U·R·L
     (`<html:a>`).
   The hyperlink must contain at least one `<`; the content before the
 - The characters `{🔗` and `>}` indicate a hyperlink to a U·R·L
     (`<html:a>`).
   The hyperlink must contain at least one `<`; the content before the


@@ -198,13 +210,12 @@ Markup within paragraphs is delimited with·out exception by pairs of
 - The characters `⸨` and `⸩` indicate parenthetical content
     (`<html:small>`).
 
 - The characters `⸨` and `⸩` indicate parenthetical content
     (`<html:small>`).
 

-- The characters `☞︎` and `☜︎` indicate strong importance
-    (`<html:strong>`).
-
-- The characters `⹐` and `⹑` indicate emphasis (`<html:em>`).
+- The characters `` ` `` and `´` indicate code (`<html:code>`).

 
 - The characters `⟪` and `⟫` indicate titles (`<html:cite>`).
 
 
 - The characters `⟪` and `⟫` indicate titles (`<html:cite>`).
 

+- The characters `⸶` and `⸷` indicate names (`<html:u class="name">`).
+

 - The characters `⟨` and `⟩` indicate offset text (`<html:i>`).
   This may be followed by a `@`, a language tag, and a `$` to provide
     the language of the text.
 - The characters `⟨` and `⟩` indicate offset text (`<html:i>`).
   This may be followed by a `@`, a language tag, and a `$` to provide
     the language of the text.


@@ -212,7 +223,10 @@ Markup within paragraphs is delimited with·out exception by pairs of
 - The characters `⦃` and `⦄` indicate keyword highlighting
     (`<html:b>`).
 
 - The characters `⦃` and `⦄` indicate keyword highlighting
     (`<html:b>`).
 

-- The characters `` ` `` and `´` indicate code (`<html:code>`).
+- The characters `☞︎` and `☜︎` indicate strong importance
+    (`<html:strong>`).
+
+- The characters `⹐` and `⹑` indicate emphasis (`<html:em>`).

 
 Once the tree is built as above, it is remediated into its final form
   by the following steps :⁠—
 
 Once the tree is built as above, it is remediated into its final form
   by the following steps :⁠—


@@ -231,11 +245,13 @@ Once the tree is built as above, it is remediated into its final form
 - Successive list items of the same level and class are joined into
     a single list.
 
 - Successive list items of the same level and class are joined into
     a single list.
 

+- Linebreaks in preformatted paragraphs are replaced with `<html:br>`.
+

 Finally, any character can be escaped by instead providing its Unicode
 Finally, any character can be escaped by instead providing its Unicode

-  codepoint in the form `<U+NNNN>`, where `NNNN` is one or more
+  codepoint in the form `{U+NNNN}`, where `NNNN` is one or more

   hexadecimal digits.
 Multiple codepoints may be provided separated by periods, as in
   hexadecimal digits.
 Multiple codepoints may be provided separated by periods, as in

-  `<U+WWWW.ZZZZ>`
+  `{U+WWWW.ZZZZ}`

 
 ## Usage
 
 
 ## Usage