mirror of
https://github.com/larvit/adf-codec.git
synced 2026-11-18 22:25:44 +01:00
Answer prose round 1: 0 🔴, 3 🟡 (0 misread); say once that mentions and localId-bearing nodes ride the carry
This commit is contained in:
+5
-6
@@ -1473,7 +1473,7 @@ call with `{ lossy: true }`, and over `adfToPortableWiki`, which sounds like the
|
||||
reader who hasn't seen the trap.
|
||||
|
||||
The reader is `jiraWikiToAdf`. The maintainer picked it on 2026-11-17, after the readers split four
|
||||
to three between it and `jiraWikiMarkupToAdf`, short of the five of seven that settle it
|
||||
to three between it and `jiraWikiMarkupToAdf`, short of the five of seven that settle a name
|
||||
(`AGENTS.md` §7).
|
||||
|
||||
## Jira wiki markup spellings the help leaves open are a writer panel's picks
|
||||
@@ -1495,20 +1495,19 @@ lines, before they wrote their own; the last four did not.
|
||||
|
||||
## A plain wiki spelling stands for the attributes Jira's editor writes, and any other attribute rides the carry
|
||||
|
||||
2026-11-16, the implementer of the wiki spec; the maintainer confirmed the carry of `localId` and a
|
||||
mention's `text` on 2026-11-17. Goals 1, 6 and 11.
|
||||
2026-11-16, the implementer of the wiki spec; the maintainer confirmed on 2026-11-17 that `localId` and a
|
||||
mention's `text` ride the carry. Goals 1, 6 and 11.
|
||||
Valid while Jira's editor writes these defaults.
|
||||
|
||||
Real Jira documents hold attributes that wiki markup can't spell: `order` 1 on every ordered list,
|
||||
`accessLevel` `""` on every mention, `isNumberColumnEnabled` `false` and `layout` `default` on
|
||||
every table, `layout` `center` on `mediaSingle`, `language` `""` on a code block. A plain spelling
|
||||
stands for exactly that one value and the reader writes it, so a Jira-authored document writes as
|
||||
stands for exactly that one value and the reader writes it, so most of a Jira-authored document writes as
|
||||
wiki markup, not as JSON. Any other value, an absent attribute, `localId` and a mention's `text`
|
||||
among them, rides the carry, so the plain spelling reads back deep-equal: the lossless writer keeps each attribute (`docs/decisions.md` §Ids stay site-local), and the
|
||||
lossy writer drops it. `[~name]` reads as text, not as a mention with `id` `name`, since Jira Cloud
|
||||
names a user by account id and the writer would otherwise write a different account back.
|
||||
The lossless writer drops no attribute, a mention's `text` and any `localId` included, since it
|
||||
would then no longer be lossless. A real document holding them writes those nodes as `{adf}` JSON.
|
||||
In a real Jira document, each mention and each node holding a `localId` therefore writes as `{adf}` JSON.
|
||||
|
||||
## `htmlToAdf` reads any HTML, with no option and no second call
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ lossless writer does, except where that writer would use the `{adf}` macro.
|
||||
A hand-written reader, as `htmlToAdf` is. Ships with the property that what the lossless writer of
|
||||
item 193 writes reads back deep-equal, and with refusals whose codes come from the closed list.
|
||||
|
||||
The reader is `jiraWikiToAdf`, the maintainer's pick (`docs/decisions.md` §Jira wiki markup's writers
|
||||
The reader is `jiraWikiToAdf` (`docs/decisions.md` §Jira wiki markup's writers
|
||||
are `adfToLosslessJiraWiki` and `adfToLossyJiraWiki`, two calls with no option).
|
||||
|
||||
### 196. Document the wiki calls in the README, with a row comparing them with Atlassian's `WikiMarkupTransformer`.
|
||||
|
||||
Reference in New Issue
Block a user