larvit/adf-codec
3
0
Fork 0
Code Pull Requests 1 Actions Activity

Goal 5's omission-note sentence moves to the plain flavour's spellings decision #151

Merged
lilleman merged 3 commits from goal-5-notes into main 2026-09-30 22:57:38 +02:00
Conversation 0 Commits 3 Files Changed 2
+5 -5
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 1df58cf33e - Show all commits
README.md
+3 -5
View File
@@ -40,11 +40,9 @@ In priority order.
flavour's directive form carries only what CommonMark cannot hold. flavour's directive form carries only what CommonMark cannot hold.
5. **Lossy conversion keeps the content.** `adfToPlainMarkdown` and `plainMarkdownToAdf` drop what 5. **Lossy conversion keeps the content.** `adfToPlainMarkdown` and `plainMarkdownToAdf` drop what
plain markdown cannot hold — format, design, structure — never content: what a reader of the plain markdown cannot hold — format, design, structure — never content: what a reader of the
rendered document sees or follows, its text, images and link targets. Content the document only rendered document sees or follows, its text, images and link targets. The lossy pair creates and
references is marked where it stood, by a note that reads as the converter's and names what was exports; it never saves back over the document it read — a document's identity (task, mention,
left out. The lossy pair creates and exports; it never saves back over the document it read — media ids) survives a round trip only through the lossless pair.
a document's identity (task, mention, media ids) survives a round trip only through the lossless
pair.
6. **What happens is what the audience expects.** Where the goals leave a choice, a conversion 6. **What happens is what the audience expects.** Where the goals leave a choice, a conversion
takes the one its audience would predict, reading the input as written. takes the one its audience would predict, reading the input as written.
7. **Failures are values.** Nothing throws, and `code` is a closed list — as much a contract as 7. **Failures are values.** Nothing throws, and `code` is a closed list — as much a contract as
docs/decisions.md
+2
View File
@@ -158,6 +158,8 @@ renderer confirming each shape. Reader panels settled `error` as an error panel,
delimiter, so `は==日本語==で` (3 of 3), `==한국어==에서만` and `iPhone==専用==` (6 of 7) highlight, delimiter, so `は==日本語==で` (3 of 3), `==한국어==에서만` and `iPhone==専用==` (6 of 7) highlight,
the external image's two forms (6 of 7), the omission notes and a rule opening a list item the external image's two forms (6 of 7), the omission notes and a rule opening a list item
dropping (3 of 3), and a list's numbering overflowing into bullets (3 of 3, 5 of 7). dropping (3 of 3), and a list's numbering overflowing into bullets (3 of 3, 5 of 7).
Content the document only references is marked where it stood, by a note that reads as the
converter's and names what was left out.
Reading takes other tools' spellings, since it reads their output and writes none of them. Reading takes other tools' spellings, since it reads their output and writes none of them.
Rejected: `~sub~` and `^sup^` (`~2~` is a strike on GitHub, so `subsup` drops), underline and colour Rejected: `~sub~` and `^sup^` (`~2~` is a strike on GitHub, so `subsup` drops), underline and colour
spellings, raw HTML (`<details>`, `<mark>`), MkDocs `!!!` and the `:::` admonition family, spellings, raw HTML (`<details>`, `<mark>`), MkDocs `!!!` and the `:::` admonition family,