networkteam/contentcomments

一个Neos扩展包,用于向任何节点添加内容评论(作为沟通介质)

安装: 16,295

依赖项: 2

建议者: 0

安全: 0

星标: 1

关注者: 7

分支: 2

类型:neos-package


README

最初由Sandstorm Media于2015年创建。2018年由networkteam更新和分支,以适应新的NeosUI

此包为Neos添加内容评论/便签。您可以在任意节点上进行评论。

支持的Neos版本(《neos/neos》)

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

用法

  • 使用composer require networkteam/contentcomments安装包
  • 使用检查器中的新“评论”选项卡
  • 使用设置ShowInFrontend在前端显示评论
    • Networkteam.ContentComments.ShowInFrontend: true
    • 在您的CSS渲染中使用scss部分"contentComment"来以美观的提示显示评论
    • 后端仅显示图标

内部工作

  • 将“评论”选项卡添加到所有节点类型,并附带属性comments。(API)
  • comments属性是一个JSON编码的数组,包含评论对象,并由自定义的Comments编辑器进行操作。(API)
  • 一个WorkspaceAspect负责在发布时合并评论(非API)

为什么我们选择这种实现方式?

通常有几种存储评论的方法

  • 我们可以将它们添加到节点本身,作为节点属性(当前的做法)
  • 我们可以将它们添加到节点本身,使用特殊的数据库列
  • 我们可以将它们作为额外的节点存储并相互链接
  • 我们可以将它们作为额外的域对象存储并相互链接。

作为第一步,我们希望与正常内容的发布行为完全相同,即内容注释应出现在特定内容所在的工作区/内容维度中。此外,我们认为如果用户创建了完全新的内容,留下了待办事项注释给自己,但尚未发布,那么其他人已经可以在他们的工作区中看到注释,这将非常奇怪。我认为这种行为并不合理——这就是为什么我们现在以与正常内容相同的方式处理注释,使用所有的相同的工作区和透明逻辑。

待办事项

此版本目前为beta质量;预期会发现错误。仍然有效。

许可

GNU GPLv3或更高版本。