This project is not covered by Drupal’s security advisory policy.

Stores comment threads attached to a part of a piece of content, such as a paragraph or a sentence, for review conversations between editors. It provides the storage and a JSON API. The editor that shows the comments is up to your application.

Features

  • Threaded messages anchored to a region of an entity, stored per entity translation.
  • One JSON endpoint, /api/inline-comments: GET reads, PUT stores the current set, DELETE removes all.
  • Append-only message log: stored messages are never rewritten.
  • Application-specific data (resolved state, quotes, labels) is kept in an open data map, so it needs no schema change.
  • Threads assigned to a user are indexed, so a user's open assignments can be listed.

Post-Installation

  1. List the entity types that can be commented on in inline_comment.settings:entity_types (for example with drush config:set).
  2. Grant the permission use inline comments api. A caller also needs update access to the commented entity.
  3. Call the endpoint from your editor or frontend.

Additional Requirements

Drupal core only (Drupal 10.3 or 11).

Similar projects

  • Moderation Note also lets editors comment on selected text and assign notes to users. It ships its own editing UI, rendered by the Drupal theme, and works on the latest revision of content under Content Moderation. Inline Comment has no UI: it is storage plus a JSON API for a decoupled editor, works on any configured entity type without a workflow, and keeps one message log per entity translation with an open data map for application-specific fields.
  • Drupal core's Comment module attaches comments to a whole entity for site visitors. Inline Comment anchors threads to a region of the content and is meant for editorial review.

Developed as part of OpenKnowledgebase and released on its own so that other Drupal sites can use it without OpenKB.

Status: the code currently ships inside OpenKnowledgebase and will be moved here before the first release.

Supporting organizations: 

Project information

Releases