Support preformatted text

[LesML] / README.markdown

diff --git a/README.markdown b/README.markdown
index 406f611f07d5ed3ddcde89b0e904b936d7b8960f..2bfa515283882215a19e576e040b1476277bd468 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -103,11 +103,18 @@ 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
 - 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 to be recognized) :⁠—
+   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>`).


@@ -159,6 +166,10 @@ After this classification, each quoted or unquoted paragraph is further
 - If the paragraph begins with `⚠︎`, it is a warning note
     (`<html:div role="note" class="warn">`).
 
 - If the paragraph begins with `⚠︎`, it is a warning note
     (`<html:div role="note" class="warn">`).
 

+- If the paragraph begins with `#`, it is a comment.
+  Comments produce X·M·L comment nodes and can be used to break up list
+    items into separate lists.
+

 - If the paragraph begins with `⋯`, it is a continuation paragraph
     (`<html:div class="continuation">`).
   Continuation paragraphs may be used to continue a preceding list item
 - If the paragraph begins with `⋯`, it is a continuation paragraph
     (`<html:div class="continuation">`).
   Continuation paragraphs may be used to continue a preceding list item


@@ -227,6 +238,8 @@ 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
   codepoint in the form `<U+NNNN>`, where `NNNN` is one or more
   hexadecimal digits.
 Finally, any character can be escaped by instead providing its Unicode
   codepoint in the form `<U+NNNN>`, where `NNNN` is one or more
   hexadecimal digits.