X-Git-Url: https://git.ladys.computer/LesML/blobdiff_plain/608a1404e5b5f27df451d8a4c50c1c356a39a8d5..46b8899e8ef2774c523423ef4b22627968b937f3:/README.markdown diff --git a/README.markdown b/README.markdown index adb7e26..2bfa515 100644 --- a/README.markdown +++ b/README.markdown @@ -28,12 +28,28 @@ It is implemented as an X·S·L·T transformation from a The first line of any 💄📝 Les·M·L document should be the string `#!lesml`. - -Following the shebang, document metadata may be provided in the [Record - Jar][draft-phillips-record-jar-01] format. +A language tag may follow this, beginning with `@` and terminated with + `$`, like so: +`#!lesml@en$`. +Regardless of whether a language tag is present, the shebang line may + be terminated by a space‐separated list of properties of the form + `key=value`. +Only one property is currently permitted: `profile`, whose value should + be a U·R·I and is translated to the `@data-lesml-profile` attribute + on the resulting `` element. + +Following the shebang line, document metadata may be provided in the + [Record Jar][draft-phillips-record-jar-01] format. The body of the document begins after the last line which begins with the string `%%`, or after the shebang line if none exists. +Multiple documents can be catenated into a single file; a new document + is begun on any line which starts with `#!lesml` or `##`. +Documents in the later case inherit the latest preceding `#!lesml` + declaration. +`##` may be followed by other text; this is treated as an interdocument + comment. + Documents are broken into paragraphs by blank lines. Empty paragraphs are ignored. Non·empty paragraphs are classified as follows :⁠— @@ -46,7 +62,6 @@ Non·empty paragraphs are classified as follows :⁠— | Character | Codepoint | Unicode Name | | --------- | --------- | ------------ | - | `#` | `U+0023` | `NUMBER SIGN` | | `*` | `U+002A` | `ASTERISK` | | `-` | `U+002D` | `HYPHEN-MINUS` | | `.` | `U+002E` | `FULL STOP` | @@ -88,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. +- 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 (``). + 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 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 (``). @@ -144,6 +166,10 @@ After this classification, each quoted or unquoted paragraph is further - If the paragraph begins with `⚠︎`, it is a warning note (``). +- 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 (``). Continuation paragraphs may be used to continue a preceding list item @@ -212,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. +- Linebreaks in preformatted paragraphs are replaced with ``. + Finally, any character can be escaped by instead providing its Unicode codepoint in the form ``, where `NNNN` is one or more hexadecimal digits.