networkteam/contentcomments

A Neos package to add content comments to any node (as communication medium)

2.1.0 2023-02-02 09:27 UTC

Requires

• neos/neos: ~4.0 || ~5.0 || ~7.0 || ~8.0
• neos/neos-ui: *

GPL-3.0+

• Sebastian Kurfürst
• Sebastian Flor
• Sören Rohweder

• comment
• communication
• Neos
• StickyNotes
• neoscms
• notes

README

Created originally by Sandstorm Media in 2015. Updated and forked for new NeosUI by networkteam in 2018

This Package Adds Content Comments / Sticky Notes to Neos. You can comment on arbitrary nodes.

Supported Neos versions (neos/neos):

• 4.3.*
• 5.*
• 7.*

Neos Version	Package Version
>= 4.3	2.x
>= 3.3, < 5.0	1.x

Usage

• install the package with composer require networkteam/contentcomments
• use the new "Comments" Tab in the Inspector
• use the setting ShowInFrontend to render comments in frontend
  • Networkteam.ContentComments.ShowInFrontend: true`
  • use the scss partial "contentComment" in your css rendering to show comments in a nice tooltip
  • there's only a icon rendered in the backend

Internal Working

• the "comments" tab is added to all node types, alongside with the property comments. (API)
• The comments property is a JSON-encoded array with comment objects which is manipulated by a custom Comments editor. (API)
• A WorkspaceAspect takes care of merging comments together on publishing (non-API)

Why did we choose this implementation?

There generally are multiple ways of storing comments:

• we can add them to the nodes themselves, as node property (the way it is done currently)
• we can add them to the nodes themselves, using a special database column
• we can store them as extra nodes and somehow link them together
• we can store them as extra domain objects and somehow link them together.

As a first step, we wanted the exact same publishing behavior than with normal content, i.e. a content note should appear exactly in the workspace/content dimension where the specific content is located. Furthermore, we thought it would be very strange if the user created completely new content, leaves TODO notes for himself, but does not publish yet -- and still notes would already be visible to other people in their workspaces. I think that behavior does not really make sense -- that's why we handle the notes currently in the same manner as normal content, with all the same workspace and shine-through logic.

TODOs

This is currently beta quality; expect to find bugs. Still valid.

License

GNU GPLv3 or later.