配置富文本编辑器

富文本编辑器(RTE)为作者提供了一系列广泛的功能来编辑其文本内容。 为所见即所得文本编辑体验提供了图标、选择框、工具栏和菜单。

要了解如何使用RTE功能进行创作，请参阅 使用富文本编辑器进行创作. 可以将RTE配置为启用、禁用和扩展创作组件中可用的功能。 以下工作流说明了在Experience Manager中完成RTE配置任务的建议顺序。

图：了解如何配置RTE的步骤顺序

了解触屏优化UI和经典UI

触屏优化UI是Experience Manager的标准用户界面。 Adobe引入了触屏优化UI 响应式设计 （创作环境）。 触屏优化UI专为触控设备和桌面设备而设计。 该界面与原始经典UI有很大区别。

图：触屏UI中的富文本编辑器工具栏

图：经典UI中的富文本编辑器工具栏

各种编辑模式

作者可以使用各种组件模式在Experience Manager中创建和编辑文本内容。 在不同编辑模式下，用于创作内容和设置内容格式的工具栏选项以及启用RTE的组件的用户体验因RTE配置而异。

内联编辑

打开时（缓慢双击/单击），可以在页面中编辑内容。 此时会显示一个包含非常基本选项的紧凑工具栏。

图：在触屏UI中使用基本工具栏的内联编辑

在经典UI中，通过缓慢双击组件，可以内联编辑，并且橙色轮廓会突出显示内容。 如果“内容查找器”处于打开状态，则窗口顶部会显示一个包含可用RTE格式选项的工具栏。 如果“内容查找器”未打开，则格式选项不会显示，并且您只能进行基本的文本编辑。

全屏编辑

Experience Manager组件能够以全屏视图打开，该视图会隐藏页面内容并占据可用屏幕。 请考虑全屏编辑内联编辑的详细版本，因为它提供了最多的编辑选项。 可以通过单击将其打开 ，使用内联编辑模式时，从压缩工具栏删除。

在对话框的全屏模式以及详细的RTE工具栏中，对话框中可用的选项和组件也可用。 它仅适用于包含RTE以及其他组件的对话框。

图：在触屏UI中以全屏模式编辑时的详细RTE工具栏

对话框编辑

双击组件时，将打开一个对话框以编辑内容。 对话框将在现有页面的顶部打开。 在某些特定情况下，对话框会作为弹出窗口打开。 例如，当文本组件属于多列页面布局中的列的一部分并且可用于对话框的区域较少时。

图：触控式UI中的对话框编辑模式

图：经典UI中包含用于编辑的详细工具栏的对话框

关于RTE插件和相关功能

该功能可通过一系列插件提供，每个插件均具有：

• A features 属性：

  • 用于激活或取消激活该插件的基本功能
  • 可使用标准化的过程配置该属性

• 适当时，需要专门配置的其他属性和选项。

RTE的基本功能由的值激活或停用 features 属性的特定于相应插件的节点。

下表列出了当前的插件，其中显示：

• 包含指向API文档链接的插件ID。 在以下情况下，ID用作节点名称 激活插件.
• 允许的值 features 属性。
• 插件提供的功能描述。

了解配置路径和位置

此 RTE编辑模式（和UI） 由您为作者提供的位置来确定配置详细信息的位置， 激活RTE插件：

配置以下属性，这些属性仅适用于Touch UI中的对话框编辑模式：

• useFixedInlineToolbar：设置在RTE节点（具有sling：resourceType=的节点）上定义的此Boolean属性 cq/gui/components/authoring/dialog/richtext)至 True，以固定RTE工具栏而不是浮动工具栏。

  当此属性为true时，默认情况下，RTF编辑在“foundation-contentloaded”事件中启动。

  要防止出现这种情况，请设置属性 customStart 到 True和触发“rte-start”事件以开始RTE编辑。 当此属性为“true”时，默认行为（单击时启动rte）不起作用。

• customStart：将此RTE节点上定义的布尔属性设置为 True，以通过触发事件来控制何时启动RTE rte-start.

• rte-start：在上触发此事件 contenteditable-div ，则表示何时开始编辑RTE。 仅当满足以下条件时，此项才有效 customStart 已设置为true。

在启用了触屏的对话框中使用RTE时，设置属性 useFixedInlineToolbar 设置为true是避免出现问题的必选项。

自定义就地编辑

通过配置以下HTML，您可以定义文本编辑器从哪个属性选择器开始：

• editElementQuery — 定义于 cq:InplaceEditingConfig，此属性用于指定启动文本组件的内联编辑的HTML元素选择器。 如果未指定，则会在文本组件HTML上直接开始内联编辑。
• textPropertyName — 定义于 cq:InplaceEditingConfig，此属性用于指定将保存在内容节点上的属性的名称，其中文本组件的HTML值将在内联编辑后保留。

对话框模式的相应属性为 name.

通过激活插件启用RTE功能

RTE功能通过一系列插件提供，每个插件都具有功能属性。 您可以配置features属性以启用或禁用每个插件的各种功能。

有关RTE插件的详细配置，请参阅 如何激活和配置RTE插件.

示例：下载 此示例配置 说明了如何配置RTE。 在此程序包中，所有功能均已启用。

配置RTE工具栏

AEM允许您针对不同的编辑模式以不同的方式配置富文本编辑器的界面。 默认设置如下所示。 您可以根据自己的要求覆盖这些默认值。 您只需自定义要提供给作者的工具栏功能。 您无需指定所有工具栏配置。

要配置工具栏，请执行以下操作 dialogFullScreen，请使用以下示例配置。

<uiSettings jcr:primaryType="nt:unstructured">
  <cui jcr:primaryType="nt:unstructured">
    <inline
      jcr:primaryType="nt:unstructured"
      toolbar="[format#bold,format#italic,format#underline,#justify,#lists,links#modifylink,links#unlink,#paraformat]">
      <popovers jcr:primaryType="nt:unstructured">
        <justify
          jcr:primaryType="nt:unstructured"
          items="[justify#justifyleft,justify#justifycenter,justify#justifyright,justify#justifyjustify]"
          ref="justify"/>
        <lists
          jcr:primaryType="nt:unstructured"
          items="[lists#unordered,lists#ordered,lists#outdent,lists#indent]"
          ref="lists"/>
        <paraformat
          jcr:primaryType="nt:unstructured"
          items="paraformat:getFormats:paraformat-pulldown"
          ref="paraformat"/>
      </popovers>
    </inline>
    <dialogFullScreen
      jcr:primaryType="nt:unstructured"
      toolbar="[format#bold,format#italic,format#underline,justify#justifyleft,justify#justifycenter,justify#justifyright,justify#justifyjustify,lists#unordered,lists#ordered,lists#outdent,lists#indent,links#modifylink,links#unlink,table#createoredit,#paraformat,image#imageProps]">
      <popovers jcr:primaryType="nt:unstructured">
        <paraformat
          jcr:primaryType="nt:unstructured"
          items="paraformat:getFormats:paraformat-pulldown"
          ref="paraformat"/>
      </popovers>
    </dialogFullScreen>
    <tableEditOptions
      jcr:primaryType="nt:unstructured"
      toolbar="[table#insertcolumn-before,table#insertcolumn-after,table#removecolumn,-,table#insertrow-before,table#insertrow-after,table#removerow,-,table#mergecells-right,table#mergecells-down,table#mergecells,table#splitcell-horizontal,table#splitcell-vertical,-,table#selectrow,table#selectcolumn,-,table#ensureparagraph,-,table#modifytableandcell,table#removetable,-,undo#undo,undo#redo,-,table#exitTableEditing,-]">
    </tableEditOptions>
  </cui>
</uiSettings>

内联模式和全屏模式使用不同的UI设置。 toolbar属性用于指定工具栏的按钮。

例如，如果按钮本身是功能(例如， Bold)，则指定为 PluginName#FeatureName (例如， links#modifylink)。

如果按钮是弹出框（包含插件的某些功能），则将其指定为 #PluginName (例如， #format)。

分隔符(|)之间，可以使用以下方式指定多个按钮： -.

内联或全屏模式下的弹出节点包含正在使用的弹出框列表。 “弹出框”节点下的每个子节点均以插件的名称（例如，格式）命名。 它具有包含插件功能列表（例如，format#bold）的“items”属性。

RTE用户界面设置和内容策略

管理员可以使用内容策略来控制RTE选项，而不是执行上述配置。 内容策略在用作组件的一部分时定义组件的设计属性 可编辑模板. 例如，如果将使用RTE的文本组件与可编辑模板一起使用，则内容策略可以定义粗体选项可用，并且一些段落格式选项可用。 内容策略可重用，并且可以跨多个模板应用。

RTE中的可用选项会从用户界面配置下游流向内容策略。

• 用户界面配置设置定义哪些选项可用于内容策略。
• 如果RTE的用户界面配置已删除或未启用某个项目，则内容策略无法对其进行配置。
• 作者只能访问由用户界面配置和内容策略提供的功能。

例如，您可以看到 文本核心组件文档.

自定义工具栏图标和命令之间的映射

您可以自定义RTE工具栏上显示的Coral图标与可用命令之间的映射。 除了Coral图标之外，您无法使用任何其他图标。

1. 创建名为的节点 icons 下 uiSettings/cui.

2. 为下面的各个图标创建节点。

3. 在每个图标节点上，指定一个Coral图标和一个要映射到图标的命令。

以下是将命令Bold映射到名为的Coral图标的示例代码片段 textItalic.

<text jcr:primaryType="nt:unstructured" sling:resourceType="cq/gui/components/authoring/dialog/richtext" name="./text" useFixedInlineToolbar="{Boolean}true">
    <rtePlugins jcr:primaryType="nt:unstructured">
        <format jcr:primaryType="nt:unstructured" features="bold,italic"/>
    </rtePlugins>
    <uiSettings jcr:primaryType="nt:unstructured">
        <cui jcr:primaryType="nt:unstructured">
            <inline jcr:primaryType="nt:unstructured"
                toolbar="[format#bold,format#italic,format#underline,links#modifylink,links#unlink]">
            </inline>
            <icons jcr:primaryType="nt:unstructured">
                <bold jcr:primaryType="nt:unstructured"
                    command="format#bold"
                    icon="textItalic"/>
            </icons>
        </cui>
    </uiSettings>
</text>

切换到CoralUI 2富文本编辑器

在页面上，您可以包含CoralUI 2 RTE clientlib或CoralUI 3 RTE clientlib。 默认情况下，富文本编辑器包含CoralUI 3 RTE clientlib。 要切换到CoralUI 2 RTE，请执行以下步骤。

1. 覆盖节点 /libs/cq/gui/components/authoring/editors/clientlibs/core 下 /apps，并执行以下操作：

   • Replace rte.coralui3 替换为 rte.coralui2 依赖关系属性。
   • Replace cq.authoring.editor.core.inlineediting.rte.coralui3 替换为 cq.authoring.editor.core.inlineediting.rte.coralui2 （对于嵌入属性）。
   • Replace cq.authoring.rte.coralui3 替换为 cq.authoring.rte.coralui2 （对于嵌入属性）。

2. 覆盖节点 /libs/cq/gui/components/authoring/dialog/richtext/clientlibs/rte/coralui3 和 /libs/cq/gui/components/authoring/dialog/richtext/clientlibs/rte/coralui2 下 /apps.

   删除类别 cq.authoring.dialog 起始日期 /apps/cq/gui/components/authoring/dialog/richtext/clientlibs/rte/coralui3 并将其添加到 /apps/cq/gui/components/authoring/dialog/richtext/clientlibs/rte/coralui2.

3. 将页面上包含的任何其他依赖项从 rte.coralui3 到 rte.coralui2. 例如，覆盖节点后 /libs/mcm/campaign/components/touch-ui/clientlibs/rte 下 /apps，更改对它的任何依赖关系从 rte.coralui3 到 rte.coralui2.

4. 覆盖节点 cq/ui/widgets 下 /apps. 替换依赖项 cq.rte 在节点上 /apps/cq/ui/widgets 替换为 cq.coralui2.rte.

更多信息

有关配置RTE的更多信息，请参阅 AEM小组件API 引用。

具体来说，要查看可用的插件和相关选项，请执行以下操作：

• 此 CQ.form.RichText 组件提供了一个表单字段，用于编辑样式化文本信息（富文本）。 要了解富文本表单的所有可用参数，请参阅配置选项。

• 富文本组件使用下面列出的插件提供多种功能 CQ.form.rte.plugins.Plugin. 对于每个插件：

  • 有关可以启用（或禁用）的功能的详细信息，请参阅功能
  • 有关相应插件的详细配置，请参阅所有可用参数的配置选项

• 此外，还提供了有关链接的HTML规则的更多信息。

这些资源可用于扩展和自定义您自己的RTE。 例如，要在创建链接时列出页面中可用的锚点，您可以提供自己的实施 LinkPlugin.

已知限制

AEM RTE功能具有以下限制：

• 仅在AEM组件对话框中支持RTE功能。 向导或类似的基础表单不支持RTE 页面属性 和 基架 触屏UI上。

• AEM不适用于 混合设备.

• 不要命名RTE配置节点 config. 否则，RTE配置仅对管理员生效，对组中的用户无效 content-author.

• RTE不支持将内联框架或iframe嵌入内容。

最佳实践和提示

• 仅启用插件，而不显示浮动对话框的弹出窗口。 没有弹出窗口的插件尺寸较小，最适合用于浮动对话框。
• 通过较大的弹出窗口启用插件，例如 Paste 插件，但仅限于全屏对话框模式或全屏模式。 具有大型弹出窗口的插件需要更多的屏幕空间才能提供良好的创作体验。
• 如果要使用CoralUI3 RTE的自定义插件，请使用 rte.coralui3 库。

解决RTE的常见问题

如何选择多个表单元格？

要选择表格中的多个单元格，请按 Ctrl 或 Cmd 键，然后逐一单击表单元格。

现在，对选定内容执行操作，例如设置选定单元格的属性。

使用“配置”按钮编辑组件时，超链接丢失

通过使用“配置”按钮编辑文本组件，在文本组件中添加超链接。 再次编辑超链接并再次验证超链接时，可能会丢失该超链接。

解决方法是第二次显示“编辑”对话框时单击文本组件，然后运行链接验证。

此问题可在AEM 6.3及更高版本中解决。

在源编辑模式下添加的HTML内容将丢失

不要添加易受XSS影响的HTML。 AEM而非RTE，可能会删除一些HTML内容以遵守XSS反精神病规则。

要验证粘贴的HTML是否已保存，请检查CRXDE中保存的内容（在“内容”节点中）。

如果未保存，则必须由RTE删除HTML，因为它不符合RTE规则。

如果保存在CRXDE中但未在页面上渲染(要检查渲染，请参阅页面的 预览，则会被AEM XSS规则删除。

多字段组件未按预期工作

要创建多字段组件，请专门使用CoralUI 3。 请勿使用CoralUI 2组件对话框。

此外，请验证多字段实施代码和节点结构是否正确。

管理员可用的配置不可用于作者

如果界面配置更新反映在管理员而非作者帐户中，请确保配置节点未命名 config. 使用 configPath 属性.

Business.Adobe.com 资源

Ecommerce Integrations Targeted Content Asset Collections Web Content Management Digital Rights Management Content Management System