# The HTML dialect The HTML `adfToHtml` writes and `htmlToAdf` reads: semantic elements for the nodes and marks below, and the carry element for every other node (`docs/decisions.md` §The HTML dialect). The written form is contract (`docs/decisions.md` §The formats are API). ## Blocks Blocks are separated by a line feed, and a document holding any ends with one. A document whose `content` is an empty array is the empty string. | ADF | HTML | | --- | --- | | `blockquote` | `
`, a line feed, its blocks, a line feed, `` | | `bulletList` | `
…`, the language one token holding no ASCII whitespace (a tab, line feed, form feed, carriage return or space); no `class` where it holds no `language` |
| `heading`, `level` 1 to 6 | `` element where it holds an attribute, `
Bolt
…
` | | `rule` | ``. A code
block's `data-*` attributes stand on its ``.
## Inline
| ADF | HTML |
| --- | --- |
| `em`, `strong`, `code` | ``, ``, `` around the text |
| `hardBreak` | `
` |
| `link`, holding `href` and an optional `title` | `` around the text |
| `text` | its text, escaped |
A text node's marks nest in the order its `marks` array lists them, the first outermost:
`manual`. Each text node writes its own elements, so two text nodes a link
marks are two `` elements.
## Escaping
Text and attribute values escape `&`, `<`, `>` and `"` as `&`, `<`, `>` and `"`.
Attribute values are double-quoted. Every URL is written as the ADF holds it, whatever its scheme
(`docs/decisions.md` §HTML writes a URL as the ADF holds it, whatever its scheme): a link's `href`,
an image's `src`, and the `href` of each link a carry element shows.
HTML text and attribute values cannot hold these (WHATWG HTML §13.1.3): any control but a tab, line
feed or form feed, so a carriage return too, which a parser reads as a line feed; a noncharacter;
and a lone surrogate, which UTF-8 cannot encode. A node holding one in a value its element writes
rides the carry.
## The carry element
A node the sections above cannot write where it stands is the carry element: `` in block
position, `` inline, of class `adf-carry`, holding the node's JSON in `data-adf` and showing
its content. A carry element may hold a node the sections above write, as the markdown carry may:
it reads back as the node it holds, so HTML stored while a node rode the carry reads the same once a
later release writes it as its own element.
```html
Read the CommonMark spec first.
Then import.
Ask @Mikael
```
- `data-adf` holds the node's JSON compact, keys sorted, as `!adf:carry` does in markdown, its type
included, each character HTML cannot hold spelled as a JSON escape, `\u0085`. A document holding
no `content` key is the block carry of `{"type":"doc","version":1}`.
- The content shown is every text node's text below the node, and what a node holding no text shows
in its place: a mention's text, else `@` and its id where it has one; an emoji's text, else its
`shortName`; a status's text; a date as `2026-09-13` in UTC; a card's URL, else its name, else the
URL its data holds; media's `alt`, else an external one's URL; an extension's text; an expand's
title.
- In a ``, each block's content is a ``, and a code block's is
`
…
`, keeping its line feeds and spaces. The ``
takes the class the code block's own element takes, and none where the language is not one
token free of ASCII whitespace. In a ``, a `
` parts each block's content from the
next.
- A hard break is `
`, and so is a line feed in text outside a ``'s code block.
- Text a link marks is `` around it, or the text alone where HTML cannot
hold the link's `href` or `title`; a `title` that is no string is left out. A card is a link to
the target of a link marking it, else to its URL.
- An external image with no link to another target is a link to its URL. An image marked by a
link to another target shows as portable markdown writes it inline. First comes the link,
around the image's `alt`, else the link's target, else the image's URL. Then comes ` (image)`,
the word `image` linking to the image:
`The moon (image)`.
- A node referencing what it cannot show is a note naming it, `(image)`: `image` for
media with no `alt` or URL, `link card` for a card with neither URL nor name, an extension's
key, else `extension`, for an extension with no text, and `synced block` for a `syncBlock`. A
link marking the node goes around the note: `(image)`.
- Characters HTML cannot hold are dropped.
- A node rides the carry where it holds a mark or a key its element does not write, an attribute
its type does not hold as that kind, an empty `attrs`, `content` or `marks`, or a value its
element cannot hold:
- text holding no character, or a character HTML cannot hold; text holding a mark twice, or a
mark with attributes besides a link's `href` and `title`;
- an unmarked text node straight after one written as plain text, which would read back as one;
- a link whose `href` or `title` holds a character HTML cannot hold, and an image whose `url` or
`alt` holds one or whose link's `href` or `title` does;
- an image holding an attribute besides its `center` layout and its media's `type`, `url` and
non-empty `alt`;
- a heading whose `level` is not 1 to 6, and an ordered list whose `order` is not a safe integer
or is `-0`;
- a code block holding more than one text node, a marked one, or a language holding ASCII
whitespace;
- a rule or hard break holding `content`, and a hard break holding an attribute;
- a list holding a node that is no `listItem`, or an item holding a mark, text, an empty key or
an attribute its type does not hold: the whole list rides the carry;
- a `listItem` outside a list, an inline node in block position and a block node inline.
- A block carry's JSON nests at most 500 levels less the depth it stands at, an inline carry's at
most 500, as in markdown.
## Reading
`htmlToAdf` reads the HTML above, so `htmlToAdf(adfToHtml(doc))` deep-equals `doc`. Wherever the HTML
above holds a spelling in the table's left column, `htmlToAdf` also reads the right one, as a browser
serializes HTML (WHATWG HTML §13.3) or a form post sends it, in a carry element's `data-adf` and in
what it shows too:
| The HTML above writes | Also read |
| --- | --- |
| `"` in text | a raw `"` |
| a no-break space | ` ` |
| `<` and `>` in an attribute value | a raw `<` and `>`, as older browsers write them |
| a line feed | `\r\n` |
A refusal's position counts the HTML as handed in. `htmlToAdf` reads a carry element's node from its
`data-adf`, and what the element shows, through its closing tag, must be what `adfToHtml` shows for
that node in either spelling: an edit there would be lost, so it is `unmappable-html`.
- Any other HTML is `unmappable-html`: another element, attribute or escape, attributes in another
order, a block on the line of another, a carriage return not followed by a line feed, or
non-empty HTML not ending in a line feed.
- A `data-*` attribute that its element does not take, such as `data-level` on ``, or that holds
a value outside its attribute's kind or not written as compact JSON, is `unsupported-node-shape`.
- A carry element's `data-adf` holding invalid JSON is `unmappable-html`. JSON that is no ADF node,
is not compact with its keys sorted, or holds a number JSON cannot spell is
`unsupported-node-shape`, and so is the document's own carry element beside another block.
- Blocks nest at most 500 levels, and a carried node's JSON at most as many as its position leaves,
as in writing; past that is `unsupported-nesting-depth`.