diff options
| author | clsr <clsr@clsr.net> | 2017-08-23 10:52:33 +0200 |
|---|---|---|
| committer | clsr <clsr@clsr.net> | 2017-08-23 10:55:20 +0200 |
| commit | d753b91063d7d388be4b9a8cef3e4fef2f4ffe9d (patch) | |
| tree | 2a2b3654633b2455e52b58a50a7d4aa4e9d4101c /cnm-specification.cnm | |
| parent | 48efb319e34c7097cdd7f2ff1b58128bb6409347 (diff) | |
| download | cnm0.3.1.tar.gz cnm0.3.1.zip | |
Add missing info about handling CNPfmt links without textcnm0.3.1
Diffstat (limited to 'cnm-specification.cnm')
| -rw-r--r-- | cnm-specification.cnm | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/cnm-specification.cnm b/cnm-specification.cnm index 3927020..618207f 100644 --- a/cnm-specification.cnm +++ b/cnm-specification.cnm @@ -1,5 +1,5 @@ title - ContNet Markup specification, version 0.3 (2017-08-18) + ContNet Markup specification, version 0.3.1 (2017-08-23) content section Overview @@ -21,7 +21,7 @@ content When whitespace is mentioned in the specification, it refers to the following ASCII whitespace characters: tab (``U+0009``), line feed (``U+000A``), form feed (``U+000C``) and space (``U+0020``) in their raw Unicode character form, not as an escape sequence. All other Unicode whitespace characters stand for themselves and are not collapsed or used to split fields. - An empty line is a line consisting of at most as much indentation as the parent block's contents and nothing else. such lines implicitly belong to the last parsed block regardless of the amount of indentation and act the same as if the indentation depth was the same as the block's contents. + An empty line is a line consisting of at most as much indentation as the parent block's contents and nothing else. Such lines implicitly belong to the last parsed block regardless of the amount of indentation and act the same as if the indentation depth was the same as the block's contents. text fmt //**TL;DR:** Encoded in UTF-8, line-based. LF is line terminator, CR is ignored. Unknown blocks' contents are skipped. @@ -305,7 +305,7 @@ content The block contents are parsed in raw mode. When possible, the contents should be displayed with a monospaced font with all whitespace preserved. - If present the first block argument represents the type of the contents. That should generally be the MIME type of the data or lowercased name of the language/syntax in the contents of the ``raw`` block (for example, ``text/html`` or ``html``, ``text/javascript`` or ``application/javascript`` or ``javascript``). When rendering the block contents, the type may be used to perform syntax highlighting. + If present, the first block argument represents the type of the contents. That should generally be the MIME type of the data or lowercased name of the language/syntax in the contents of the ``raw`` block (for example, ``text/html`` or ``html``, ``text/javascript`` or ``application/javascript`` or ``javascript``). When rendering the block contents, the type may be used to perform syntax highlighting. Note that, as in all other blocks, it's not possible to include leading or trailing blank lines in the ``raw`` block's contents. @@ -374,7 +374,7 @@ content It is parsed the same way as a ``section`` block without a title and can contain arbitrary content blocks. Each child block represents a column header cell. - The ``header`` block represents a row with table headers. It should be displayed in a more emphasized manner and, optionally, allow sorting all follow-up rows by columns until the next header or the end of the table by headings. A table is not required to start with a header nor to include one at all. + The ``header`` block represents a row with table headers. It should be displayed in a more emphasized manner and, optionally, allow sorting all follow-up rows until the next header or the end of the table by columns. A table is not required to start with a header, nor to include one at all. section row @@ -434,7 +434,7 @@ content The second argument is the URL pointing to the embedded content. An embed block without a URL should be ignored. The URL may also be a data URI. - The contents of the block are parsed in simple text mode and represent the description of the embedded content. If present, the description can be displayed as e.g. a caption, mouseover title, placeholder when the content cannot be embedded, etc., but may as well be hidden. + The contents of the block are parsed in simple text mode and represent the description of the embedded content. If present, the description can be displayed as e.g. a caption, mouse-over title, placeholder when the content cannot be embedded, etc., but may as well be hidden. If the content type is unknown or cannot be embedded within the page, the embedded content should be presented as a hyperlink instead. @@ -454,7 +454,7 @@ content text fmt The CNMfmt markup is used within ``text fmt`` content blocks to provide inline formatting of text. - CNMfmt extends the CNM ``text plain`` block by introducing toggles of various format options. These toggles consist of two symbol characters. If the format of the toggle is currently not in effect, the toggle enables it. Otherwise, the format is disabled. Formats do **not** have to be toggled in LIFO order. All formats end with the end of the paragraph. + CNMfmt extends the CNM ``text plain`` block by introducing toggles of various format options. These toggles consist of two symbol characters. If the format of the toggle is currently not in effect, the toggle enables it. Otherwise, the format is disabled. Formats do **not** have to be toggled in LIFO order. All formats are implicitly closed with the end of the paragraph. The following toggles and formats are currently defined: @@ -484,13 +484,13 @@ content section Hyperlink text fmt - The @@cwp://example.com/ \@\@cwp:\/\/example.com\/ hyperlink\@\@@@ format represents an inline hyperlink. It uses two at signs (``\@\@``) as the toggle. + The @@cnp://example.com/ \@\@cnp:\/\/example.com\/ hyperlink\@\@@@ format represents an inline hyperlink. It uses two at signs (``\@\@``) as the toggle. The hyperlink consists of two parts: the URL and the link text. The URL is the first non-whitespace word inside the formatted text. The URL does not contain any CNMfmt toggles excluding ``\@\@``, which ends the entire hyperlink format (for example, the ``\/\/`` inside the URL does not toggle the italic format). Note that the URL can still contain CNM simple text and CNMfmt escape sequences; these can be used to supply Unicode characters and spaces instead of manually percent-encoding the URL. - If the hyperlink format consists of more than one word, the remainder of the content is used as the hyperlink text. It may contain arbitrary CNMfmt formatting. + If the hyperlink format consists of more than one word, the remainder of the content is used as the hyperlink text. It may contain arbitrary CNMfmt formatting. If the link text is blank, the URL is used as link text instead. text fmt |