quarto-dev / quarto-dev/q2

syntax review: block-level editorial marks?

Open
#56 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement readers-writers
Dominant language
Rust
Stars
255
Forks
17
Avg merge
6h 20m
Merged PRs (30d)
109

Description

(cc @vezwork)

We would like block-level editorial markings:

[>> this is where you're wrong:

- a gish
- gallop
- of points]

But this runs afoul of a design principle we're trying to enforce. Unlike the Pandoc Markdown situation with footnotes, we don't support inline nodes that can contain blocks. qmd has, instead:

  • footnote references
  • footnote definitions in both inline and block form

That suggests that we could promote "footnote definitions" to be "ancillary definitions" that can serve as footnotes, or as the contents of editorial markings.

In hindsight, I think it's a bit unfortuante that we're avoiding blocks-within-inlines, because there's clear ergonomic value in having editorial marks that work at the block level as well. Specifically, it is a good thing to be able to select a bunch of blocks and a "suggest deletion" action that minimally changes the document lexically (for the purposes of automerge ergonomics)

Ok, so how about custom syntax support for block-level editorial marks?

::: >>

This is a long comment

:::

::: --

Delete all of.

These many, many paragraphs.

:::

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. First resolve the syntax and design question around promoting ancillary definitions versus custom ::: block-level editorial marks, using the examples in the issue; done means an agreed syntax and implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
content
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.