Skip to content

Inline comments #185

Description

@monsieurhannes

This post summarises the current state of the discussion in this ticket and the plans to implement (original report at the bottom):

Motivation

Comments are useful in many situation. They allow adding information that directly relates to parts of the document without adding it directly to the document content.

Comments can be particularly helpful when drafting documents and during a review process.

Scope of comments

In a first iteration, we add support for point anchor comments, not range anchor comments. This means that each comment has an anchor point in the document, the anchor cannot span over a range of document content. If people want to comment on a range, they can use a comment in combination with the text highlight feature we already have. One reason to only support point anchor comments is that comments spawning a range would need a custom Markdown syntax, see below.

Each comment is attributed to a user (or guest with a name) and has a timestamp.

We support stacked comments (i.e. replies to comments), so that a comment anchor can reference a discussion of comments. Nested comments (i.e. comments on a specific comment) will not be supported.

It will be possible to edit all comments, also those from other users. This will be possible by editing the Markdown file anyway, so we don't hide this in the user interface. For reference, this is possible in Collabora Online as well.

User interface

A small chat icon button as anchor in the text will highlight the position of the comment.

The comments are displayed in popover boxes that spawn from the right side of the editor (where the table of contents outline lives). One bubble contains all comments on that anchor and has an input field at the bottom to allow adding additional comments.

When enough whitespace is available, the comments popover will be displayed open per default. On narrow screens without enough whitespace and on mobile, the popover can be opened by clicking a comments icon on the right side of the screen or by clicking the comments icon at the position of the comment.

We'll use Notion as reference for how comment boxes behave regarding responsive design and alignment:

Image

Adding new comments is possible via toolbar button and via keyboard shortcut (to be decided).

When the document contains comments, it's possible to hide all comments in the editor toolbar to allow distraction-free reading.

Markdown representation

Comments will be persisted to Markdown using the footnote syntax that is defined in several Markdown extensions. See MultiMarkdown and Markdown Guide for details:

The major advantage over a custom syntax is that existing Markdown editors with footnote support (e.g. Obsidian and Ghostwriter) render footnote comments and make them accessible.

In order to allow adding footnote support to Text later, we extend the footnote syntax and let each footnote comment start with [comment]. To allow discussions of comments within one comment anchor, we use a bullet list.

This is how the Markdown syntax will look like:

The quick[^comment-1] brown fox.

[^comment-1]:
    - @[jane](mention://user/jane)*(2026-05-21T10:30Z)*
      Is "quick" the right word here?
    - @[bob](mention://user/bob)*(2026-05-21T12:45Z)*
      I think "fast" is more accurate.
    - @[jane](mention://user/jane)*(2026-05-21T16:12Z)*
      Or how about "swift"?

Activity

  1. added this to the milestone on Jul 23, 2019
  2. jancborchardt commented on Jul 23, 2019

    @jancborchardt
    Member

    @monsieurhannes yes, this would be very useful. Could you show screenshots from how Google Docs, Word and others do it as examples?

  3. juliusknorr commented on Jul 23, 2019

    @juliusknorr
    Member

    Besides the frontend we of course need to think of a proper way how we represent the comments in markdown.

  4. tiotrom commented on Sep 9, 2019

    @tiotrom
  5. juliusknorr commented on Sep 10, 2019

    @juliusknorr
  6. joshp23 commented on Oct 6, 2019

    @joshp23

    Markdown footnotes would be a possibility to represent in MD

  7. removed this from the milestone on Jan 16, 2020
  8. jtoloe commented on Jan 14, 2021

    @jtoloe

    HackMD has this functionality. See https://hackmd.io/s/how-to-use-comments for examples. I do not think that the comments are stored in the markdown file.

  9. juliusknorr commented on Jan 14, 2021

    @juliusknorr
    Member

    The issue with not storing it in the markdown file would be that we then loose the comments as soon as someone changes the file from outside (e.g. with a editor synced by the desktop client)

  10. juliusknorr commented on Jan 14, 2021

    @juliusknorr
    Member

    Footnotes would be a possible way, but they limit comments to one cursor position in the text rather than having the possibility to mark a range of text and comment on that.

  11. jnnkB commented on Apr 28, 2021

    @jnnkB

    Maybe Critic Markup would be an option: http://criticmarkup.com/users-guide.php

  12. monsieurhannes commented on Jun 10, 2022

    @monsieurhannes
    Author

    Any development on this front?
    It seems like it gets mentioned more often recently. I guess Text is in a bit of competition with the big office suites which provide that feature already and maybe it's an overkill for Text. But at the same time Text is much more lightweight and accessible on all platforms.
    I'd be happy to help in any way - more in the UI than the programming part. 😆

  13. 57 remaining items

  14. moved this from 🧭 Planning evaluation / ideas to 🏗️ At engineering in 🖍 Design teamon Jun 1, 2026
  15. changed the title [-]Comments[/-] [+]Inline comments[/+] on Jun 3, 2026
  16. moved this from 🏗️ In progress to 📄 To do (~10 entries) in 📝 Productivity teamon Jun 26, 2026
  17. moved this from 📄 To do (~10 entries) to 🏗️ In progress in 📝 Productivity teamon Jul 16, 2026
  18. moved this from 🏗️ In progress to 👀 In review in 📝 Productivity teamon Jul 30, 2026
  19. removed their assignment
    on Jul 30, 2026
  20. moved this from 👀 In review to 🏗️ In progress in 📝 Productivity teamon Jul 30, 2026
  21. moved this from 🏗️ In progress to 👀 In review in 📝 Productivity teamon Aug 6, 2026
  22. moved this from 🏗️ At engineering to 🎉 Done in 🖍 Design teamon Aug 10, 2026
  23. moved this from 👀 In review to ☑️ Done in 📝 Productivity teamon Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions