协作概述
CKEditor 5 架构旨在提供协作编辑功能,让多个作者可以共同编辑同一个富文本文档。
# 演示
使用以下演示中的协作功能集:打开跟踪更改
,添加评论 ,查看评论存档 ,并跟踪文档的修订历史记录 。此演示只提供了一组有限的功能。访问功能丰富的编辑器示例,查看更多实际操作。
# 可用的协作功能
协作功能由三个易于集成的插件提供,分别提供不同的功能:评论、跟踪更改和修订历史记录。您可以在专门的指南中找到有关每个功能的更多信息。阅读这些指南后,您也可以在CKEditor 5 中的协作写作博客文章中查看一些有趣的细节和示例。
您可以根据用户的需求单独使用这些功能,也可以将它们组合使用。协作也可以实时或异步。
# 评论
得益于评论功能,用户可以向文档的标记片段添加侧边注释,包括文本和块元素(如图像)。它还允许用户在主题中进行讨论,并在讨论结束后删除评论。
您可以定义要存储评论数据的存放位置。要加载和保存它,您还需要创建与您的数据库的适当集成。如果您想在用户之间自动同步评论讨论,您也可以将评论用作实时协作的一部分。
您可以在侧边栏或内联显示评论主题
此外,您可以解决评论主题,这将把它们移至存档。请注意,评论存档默认启用,无法关闭。
请参阅评论指南以获取更多信息。
# 跟踪更改
跟踪更改功能在您更改文档时会自动标记建议。在编辑文档时,用户可以切换到跟踪更改模式。他们所有的更改都会创建建议,他们可以接受或拒绝这些建议。
您可以定义要存储建议数据的存放位置。要加载和保存它,您还需要创建与您的数据库的适当集成。如果您想在用户之间自动同步建议,您也可以将跟踪更改用作实时协作的一部分。
您可以在侧边栏或内联显示建议注释
请参阅跟踪更改指南以获取更多信息。
# 修订历史记录
修订历史记录功能是一个文档版本控制工具。它允许 CKEditor 5 用户创建和查看其内容的按时间顺序排列的修订历史记录。这些版本列在侧边面板中。预览模式允许轻松查看修订之间内容的开发情况。您可以随时重命名、比较和恢复旧版本。
请参阅修订历史记录指南以获取更多信息。
# 实时与异步协作
CKEditor 5 中有两种可用的协作模式:实时协作(通常称为 RTC)和异步协作。两种协作工作流程都允许您的用户在一个应用程序内进行协作,无需使用第三方工具。他们可以异步协作处理文档,或者使用实时编辑器在实时模式下编写、审查和评论内容。您可以在这两种模式下使用所有可用的 CKEditor 5 协作插件。
异步与实时协作比较 | ||
协作类型 | 异步 | 实时 |
工作流程 | 顺序 | 同时 |
包含的功能 | 修订历史记录、跟踪更改和评论。 | 修订历史记录、跟踪更改和评论在实时工作。 |
后端 | 客户提供的自定义后端。 | CKEditor 在本地和 SaaS 模式下提供后端。 |
冲突解决 | 未实现。 | 如果用户同时进行更改,会自动解决所有冲突。 |
系统开发人员的集成任务 | 编写后端终结点以保存和加载数据。 编写前端适配器以将数据传递给后端终结点。 |
只需为 SaaS 版本配置令牌。 对于本地版本,还需要设置基础设施。 |
# 异步协作
异步协作非常适合线性工作流程,用户可以按顺序创建、审核和编辑内容,无需同时进行。它适用于在商业交易、法律文件、学术研究论文、合同管理等更多用例中工作的专业环境。
在此模式下,单个作者可以处理文档,使用修订历史记录、跟踪更改和评论功能与之前和之后的编辑进行交互。所有工作都按顺序完成。
异步方法可以更具成本效益,并且需要更少的专用基础设施。它还让您完全控制您的数据。由于您完全负责加载、保存和存储数据,因此默认情况下它是本地版本。另一方面,这种方法要求您维护前端和后端集成代码,即使在编辑器功能更新的情况下也是如此。
# 实时协作
另一方面,在实时协作中,许多用户可以同时处理同一个文档,即使是在同一个部分,也不会锁定内容。评论和跟踪更改在用户之间自动同步,随时随地。它自动解决用户同时进行更改时可能发生的任何冲突。编辑器还会列出当前参与编辑过程的所有用户。
因此,协作用户不仅能够同时编辑富文本文档,还能够在评论中实时讨论流程。他们也可以保存修订。这非常适合快节奏的内容创建情况,并且在单用户模式下仍然可以证明有用,就像异步解决方案一样。
实时协作提供了一个现成的前端集成和一个后端解决方案。您可以将其用作 CKEditor 云服务提供的 SaaS,也可以安装在您的机器上作为本地版本。
CKEditor 提供了这两种功能,因此无需复杂的集成。导入插件,填写编辑器配置,并提供令牌配置。本地解决方案需要一些额外的最小设置。
您仍然可以控制您的数据。REST API 允许您复制您存储在我们服务器上的任何数据以及更多内容!
有关更多信息,请参阅 实时协作 指南。
仍然不确定哪种集成方法最适合您?随时 联系我们!
我们每天都在努力使我们的文档保持完整。您是否发现过时的信息?是否有遗漏?请通过我们的 问题跟踪器 报告。
随着 42.0.0 版本的发布,我们重新编写了大部分文档以反映新的导入路径和功能。我们感谢您的反馈,以帮助我们确保其准确性和完整性。