diff --git a/docs/errors/markdown/Q-2-19.qmd b/docs/errors/markdown/Q-2-19.qmd index 06519ad63d..915a1523a6 100644 --- a/docs/errors/markdown/Q-2-19.qmd +++ b/docs/errors/markdown/Q-2-19.qmd @@ -18,8 +18,8 @@ categories: Quarto markdown supports an editorial-markup family for tracked changes: `[++inserted text]` for insertions, `[--deleted text]` -for deletions, `[>>highlighted]` for highlights, and -`[!!comment]` for editorial comments. This error fires when the +for deletions, `[!!highlighted]` for highlights, and +`[>>comment]` for editorial comments. This error fires when the insert form `[++ ...` is opened but never closed. ## Why this happens @@ -43,5 +43,5 @@ opening bracket: `\[++text]`. ## Related - [`Q-2-20`](Q-2-20.qmd) — unclosed editorial delete (`[--`). -- [`Q-2-21`](Q-2-21.qmd) — unclosed editorial comment (`[!!`). -- [`Q-2-22`](Q-2-22.qmd) — unclosed editorial highlight (`[>>`). +- [`Q-2-21`](Q-2-21.qmd) — unclosed editorial comment (`[>>`). +- [`Q-2-22`](Q-2-22.qmd) — unclosed editorial highlight (`[!!`). diff --git a/docs/errors/markdown/Q-2-20.qmd b/docs/errors/markdown/Q-2-20.qmd index 9565382ef0..07123410ce 100644 --- a/docs/errors/markdown/Q-2-20.qmd +++ b/docs/errors/markdown/Q-2-20.qmd @@ -39,5 +39,5 @@ editorial mark, escape the bracket: `\[--text]`. ## Related - [`Q-2-19`](Q-2-19.qmd) — unclosed editorial insert (`[++`). -- [`Q-2-21`](Q-2-21.qmd) — unclosed editorial comment (`[!!`). -- [`Q-2-22`](Q-2-22.qmd) — unclosed editorial highlight (`[>>`). +- [`Q-2-21`](Q-2-21.qmd) — unclosed editorial comment (`[>>`). +- [`Q-2-22`](Q-2-22.qmd) — unclosed editorial highlight (`[!!`). diff --git a/docs/errors/markdown/Q-2-21.qmd b/docs/errors/markdown/Q-2-21.qmd index 2022d37f2a..967df1452d 100644 --- a/docs/errors/markdown/Q-2-21.qmd +++ b/docs/errors/markdown/Q-2-21.qmd @@ -1,6 +1,6 @@ --- title: "Unclosed Editorial Comment" -description: "An editorial-comment span opens with `[!!` but no closing `]` appears before the end of the block." +description: "An editorial-comment span opens with `[>>` but no closing `]` appears before the end of the block." code: Q-2-21 subsystem: markdown status: stub @@ -11,32 +11,32 @@ categories: # `Q-2-21` — Unclosed Editorial Comment -> An editorial-comment span opens with `[!!` but no closing `]` +> An editorial-comment span opens with `[>>` but no closing `]` > appears before the end of the block. ## What this means -The editorial-comment form `[!!a remark]` attaches a non-output -side note to text. This error fires when the opener `[!!` has no +The editorial-comment form `[>>a remark]` attaches a non-output +side note to text. This error fires when the opener `[>>` has no matching close. ## Why this happens -A deleted closing bracket, or a literal `[!!` taken as an +A deleted closing bracket, or a literal `[>>` taken as an editorial opener. ## How to fix -Add the closing `]`, or escape the opening bracket: `\[!!text]`. +Add the closing `]`, or escape the opening bracket: `\[>>text]`. ## Example ```markdown -[!! +[>> ``` ## Related - [`Q-2-19`](Q-2-19.qmd) — unclosed editorial insert (`[++`). - [`Q-2-20`](Q-2-20.qmd) — unclosed editorial delete (`[--`). -- [`Q-2-22`](Q-2-22.qmd) — unclosed editorial highlight (`[>>`). +- [`Q-2-22`](Q-2-22.qmd) — unclosed editorial highlight (`[!!`). diff --git a/docs/errors/markdown/Q-2-22.qmd b/docs/errors/markdown/Q-2-22.qmd index 017cf77601..c0ddbd0ff1 100644 --- a/docs/errors/markdown/Q-2-22.qmd +++ b/docs/errors/markdown/Q-2-22.qmd @@ -1,6 +1,6 @@ --- title: "Unclosed Editorial Highlight" -description: "An editorial-highlight span opens with `[>>` but no closing `]` appears before the end of the block." +description: "An editorial-highlight span opens with `[!!` but no closing `]` appears before the end of the block." code: Q-2-22 subsystem: markdown status: stub @@ -11,32 +11,32 @@ categories: # `Q-2-22` — Unclosed Editorial Highlight -> An editorial-highlight span opens with `[>>` but no closing `]` +> An editorial-highlight span opens with `[!!` but no closing `]` > appears before the end of the block. ## What this means -The editorial-highlight form `[>>marked text]` flags text for +The editorial-highlight form `[!!marked text]` flags text for visual emphasis without otherwise changing it. This error fires -when the opener `[>>` has no matching close. +when the opener `[!!` has no matching close. ## Why this happens -A deleted closing bracket, or a literal `[>>` taken as an +A deleted closing bracket, or a literal `[!!` taken as an editorial opener. ## How to fix -Add the closing `]`, or escape the opening bracket: `\[>>text]`. +Add the closing `]`, or escape the opening bracket: `\[!!text]`. ## Example ```markdown -[>> +[!! ``` ## Related - [`Q-2-19`](Q-2-19.qmd) — unclosed editorial insert (`[++`). - [`Q-2-20`](Q-2-20.qmd) — unclosed editorial delete (`[--`). -- [`Q-2-21`](Q-2-21.qmd) — unclosed editorial comment (`[!!`). +- [`Q-2-21`](Q-2-21.qmd) — unclosed editorial comment (`[>>`). diff --git a/docs/errors/writer/Q-3-33.qmd b/docs/errors/writer/Q-3-33.qmd index 94a670ec4d..d6606231b3 100644 --- a/docs/errors/writer/Q-3-33.qmd +++ b/docs/errors/writer/Q-3-33.qmd @@ -1,6 +1,6 @@ --- title: "Unprocessed Insert Markup" -description: !str "Insert editorial markup ({++ ...}) was not desugared to a Span during postprocessing." +description: !str "Insert editorial markup ([++ ...]) was not desugared to a Span during postprocessing." code: Q-3-33 subsystem: writer status: stub @@ -11,17 +11,17 @@ categories: # `Q-3-33` — Unprocessed Insert Markup -> Insert editorial markup `{++ ...}` was not desugared to a +> Insert editorial markup `[++ ...]` was not desugared to a > Span during postprocessing. ## What this means Quarto supports a small family of editorial-markup constructs -inspired by CriticMarkup: insertions `{++ ...}`, deletions -`{-- ...}`, highlights `{== ...}`, and comments -`{>> ...}`. The parser emits each as its own AST node type; +inspired by CriticMarkup: insertions `[++ ...]`, deletions +`[-- ...]`, highlights `[!! ...]`, and comments +`[>> ...]`. The parser emits each as its own AST node type; postprocessing rewrites those nodes into `Span` nodes with the -right classes (`.ins`, `.del`, etc.) before the writer runs. +right classes (`.quarto-insert`, `.quarto-delete`, etc.) before the writer runs. This error fires when an `Insert` node survives the postprocessing pass. The writer does not know how to render the diff --git a/docs/errors/writer/Q-3-34.qmd b/docs/errors/writer/Q-3-34.qmd index 4c776f9f47..2863de2805 100644 --- a/docs/errors/writer/Q-3-34.qmd +++ b/docs/errors/writer/Q-3-34.qmd @@ -1,6 +1,6 @@ --- title: "Unprocessed Delete Markup" -description: !str "Delete editorial markup ({-- ...}) was not desugared to a Span during postprocessing." +description: !str "Delete editorial markup ([-- ...]) was not desugared to a Span during postprocessing." code: Q-3-34 subsystem: writer status: stub @@ -11,14 +11,14 @@ categories: # `Q-3-34` — Unprocessed Delete Markup -> Delete editorial markup `{-- ...}` was not desugared to a +> Delete editorial markup `[-- ...]` was not desugared to a > Span during postprocessing. ## What this means -Quarto's CriticMarkup-inspired deletion construct `{-- ...}` +Quarto's CriticMarkup-inspired deletion construct `[-- ...]` is parsed as a `Delete` AST node. Postprocessing rewrites it -as a `Span` with the `.del` class before the writer runs. +as a `Span` with the `.quarto-delete` class before the writer runs. This error fires when a raw `Delete` node reaches the writer. This is a defensive guard. The condition is a pipeline bug, not diff --git a/docs/errors/writer/Q-3-35.qmd b/docs/errors/writer/Q-3-35.qmd index 6a58c123c2..dc64045ba5 100644 --- a/docs/errors/writer/Q-3-35.qmd +++ b/docs/errors/writer/Q-3-35.qmd @@ -1,6 +1,6 @@ --- title: "Unprocessed Highlight Markup" -description: !str "Highlight editorial markup ({== ...}) was not desugared to a Span during postprocessing." +description: !str "Highlight editorial markup ([!! ...]) was not desugared to a Span during postprocessing." code: Q-3-35 subsystem: writer status: stub @@ -11,14 +11,14 @@ categories: # `Q-3-35` — Unprocessed Highlight Markup -> Highlight editorial markup `{== ...}` was not desugared to a +> Highlight editorial markup `[!! ...]` was not desugared to a > Span during postprocessing. ## What this means -Quarto's CriticMarkup-inspired highlight construct `{== ...}` +Quarto's CriticMarkup-inspired highlight construct `[!! ...]` is parsed as a `Highlight` AST node. Postprocessing rewrites -it as a `Span` with the `.mark` class before the writer runs. +it as a `Span` with the `.quarto-highlight` class before the writer runs. This error fires when a raw `Highlight` node reaches the writer. diff --git a/docs/errors/writer/Q-3-36.qmd b/docs/errors/writer/Q-3-36.qmd index fc9b3b50b1..6c432e80d0 100644 --- a/docs/errors/writer/Q-3-36.qmd +++ b/docs/errors/writer/Q-3-36.qmd @@ -1,6 +1,6 @@ --- title: "Unprocessed EditComment Markup" -description: !str "EditComment editorial markup ({>> ...}) was not desugared to a Span during postprocessing." +description: !str "EditComment editorial markup ([>> ...]) was not desugared to a Span during postprocessing." code: Q-3-36 subsystem: writer status: stub @@ -11,15 +11,15 @@ categories: # `Q-3-36` — Unprocessed EditComment Markup -> EditComment editorial markup `{>> ...}` was not desugared to +> EditComment editorial markup `[>> ...]` was not desugared to > a Span during postprocessing. ## What this means -Quarto's CriticMarkup-inspired comment construct `{>> ...}` is +Quarto's CriticMarkup-inspired comment construct `[>> ...]` is parsed as an `EditComment` AST node — an editorial aside from one collaborator to another, not intended for the final reader. -Postprocessing rewrites it as a `Span` with the `.comment` +Postprocessing rewrites it as a `Span` with the `.quarto-edit-comment` class before the writer runs. This error fires when a raw `EditComment` node reaches the writer.