guide实时协作功能 - 快速入门

本文旨在帮助您在 CKEditor Premium 功能免费试用中使用实时协作(包含跟踪更改和评论)服务。

请按照以下步骤操作

# 订阅 CKEditor Premium 功能免费试用

通过 注册 CKEditor Premium 功能免费试用 创建帐户。注册后,您将可以访问客户仪表盘(CKEditor 生态系统仪表盘)。

CKEditor Premium Features free trial sign-up view.

系统将要求您查看您最感兴趣的功能。

选中这些功能不会影响试用捆绑包的内容 - 无论您选择什么,所有功能都将可用。我们只是想更了解您的需求。

# 登录 CKEditor 生态系统仪表盘

登录 CKEditor 生态系统仪表盘。您将收到一封确认电子邮件,并要求您为您的帐户创建密码。请妥善保管密码。

# 帐户仪表盘

登录后,点击左侧“您的产品”标题下的“CKEditor”。您将看到订阅参数概述以及下面的管理区域。

Your CKEditor trials view in the customer dashboard.

# 创建令牌端点

在您可以使用新激活的 CKEditor Premium 功能免费试用捆绑包之前,您首先需要在您的应用程序中创建一个 安全令牌端点。该端点的作用是安全地授权您的应用程序的最终用户仅在他们应该访问请求的内容或操作的情况下才能使用 CKEditor 云服务。

# 开发令牌端点(快速简便)

如果您刚刚开始使用,可以使用开箱即用的开发令牌端点 URL,无需您进行任何编码。开发令牌端点的 URL 可以通过三个简单的步骤轻松获得

  1. 要使用 CKEditor Premium 功能(如实时协作),您需要创建一个环境。环境允许您创建访问凭据、管理 Webhook、配置功能并连接到 CKEditor 云服务。您可以创建多个环境来服务不同的实例或集成。从环境列表中选择要管理的环境。

    Environments list.

    如有需要,请参考 环境管理指南

  2. 选择环境后,按下“CKEditor 配置”选项卡中“开发令牌 URL”部分的“生成”按钮

    Press the button to generate the development token URL.

    开发令牌 URL 将显示在“开发令牌 URL”部分

    CKEditor configuration with the development token URL.

    开发令牌端点是一个特殊的端点,可以帮助您开始使用 CKEditor 云服务。它提供对服务的无限制、完全访问权限,并在首次使用后 30 天内过期。您不应该在生产环境中使用它。**任何知道此 URL 的人都将对相关环境拥有完全访问权限。**

# 模拟随机用户

开发令牌 URL 默认情况下将生成随机用户名。如果您想指定用户详细信息,可以在查询字符串中使用以下参数传递它们:

  • user.name – 完整姓名。
  • user.id – 您系统中用户的唯一 ID。
  • user.email(可选)– 电子邮件地址。
  • user.avatar(可选)– 头像的 URL。

因此,如果您的令牌 URL 是 https://17717-dev.cke-cs-dev.com/token/dev/XXX,则您可以使用自定义开发令牌 URL https://17717-dev.cke-cs-dev.com/token/dev/XXX?user.name=Jane%20Doe&user.id=13 连接到 CKEditor 云服务,并以 Jane Doe 的身份进行连接,其 ID 为 13。

# 编写您的令牌端点(高级用户)

如果您使用的是开发令牌端点,请跳过此步骤。

要编写您自己的 安全令牌端点,您需要通过转到“访问凭据”选项卡并点击“创建新的访问密钥”按钮来为所选环境创建访问凭据。

创建访问凭据 部分的“环境管理指南”中了解更多信息。

# 在编辑器中启用功能

要配置 CKEditor 安装以使用实时协作,您需要提供您选择的安全令牌端点(**令牌 URL**)。

如果您想使用 Easy Image 功能(它是图像管理的可选方案之一),您还需要使用 **上传 URL**。现在设置此选项将使 Easy Image 功能立即生效,无需进一步配置,从而使您能够轻松地开始使用它。

这两个值都可以在仪表盘中的环境配置部分找到。

CKEditor 5 token and upload URLs.

以下配置选项需要在 CKEditor 5 配置中设置

注意:除了设置上述配置选项之外,请确保您的 CKEditor 5 构建启用了实时协作功能插件。有关更多详细信息,请参阅 实时协作功能集成指南

# 自定义您的协作 WYSIWYG 编辑器体验

实时协作功能提供了各种自定义选项和方法来呈现用户交互。

以下文档部分将帮助您创建自定义用户体验,以满足用户的需求

  • 实时协作中的用户 – 解释用户角色、用户存在列表和主题自定义。
  • 注释显示模式 – 解释如何设置用于评论和建议的窄边栏或宽边栏,或将注释内联显示。
  • 注释自定义 – 解释如何通过自定义主题、创建自定义模板或自定义视图来更改评论、建议和主题的外观。