配置富文本编辑器

富文本编辑器(RTE)为作者提供了各种功能来编辑文本内容。 提供图标、选择框、工具栏和菜单,实现所见即所得的文本编辑体验。 管理员配置RTE以启用、禁用和扩展创作组件中的可用功能。 了解作者如何使用RTE创作 Web内容。

下面列出了RTE配置它所需的概念和步骤。

了解RTE概念 启用所需功能 配置单个功能
了解界面 了解和设置配置位置 配置插件
编辑模式的类型 激活插件 设置功能属性
关于插件 配置RTE工具栏 配置粘贴模式

了解作者可使用的用户界面

RTE接口优惠响应式设计进行创作环境。 该界面设计用于触控和桌面设备。

富文本编辑器工具栏

图:富文本编辑器工具栏,并启用所有可用选项。

工具栏提供了“所见即所得”创作体验的选项。 Experience Manager 管理员可以配置界面工具栏中的可用选项。默认情况下,Experience Manager中提供一整套编辑选项。 开发人员可以自定义Experience Manager以添加更多编辑选项。

各种编辑模式

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

编辑模式 编辑区域 建议启用的功能
内嵌 就地编辑,实现快速、细微的编辑;无需打开对话框即可设置格式。 最低RTE功能。
RTE全屏 涵盖整个页面。 所有必需的RTE功能。
对话框 对话框,但不涵盖整个页面。 明智地启用功能。
全屏对话框 与全屏模式相同;包含对话框的RTE旁边的字段。 所有必需的RTE功能。
NOTE

源代码编辑功能在内联编辑模式下不可用。 无法在全屏模式下拖动图像。 所有其他功能在所有模式下都有效。

内联编辑

要编辑页面内的内容,请慢速单击多次以打开内容。 会显示一个包含基本选项的紧凑工具栏。

使用工具栏中的基本选项进行内联编辑

图:使用工具栏中的基本选项进行内联编辑。

全屏编辑

Experience Manager 组件可以以全屏视图打开,从而隐藏页面内容并占据可用屏幕。考虑对内联编辑的详细版本进行全屏编辑,因为它优惠的编辑选项最多。 在使用内联编辑模式时,可以通过单击图标以从压缩工具栏中全屏打开RTE。

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

以全屏模式进行编辑时的详细RTE工具栏

图:在全屏模式下进行编辑时显示的详细RTE工具栏。

对话框编辑

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

对话框编辑模式

图:对话框编辑模式。

关于RTE插件和相关功能

该功能通过一系列插件提供,每个插件都具有:

  • features属性,即,

    • 用于激活或取消激活该插件的基本功能。
    • 使用标准化过程进行配置。
  • 如果适用,需要进行专门配置的属性和选项会更多。

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

下表列表了当前插件,如下所示:

  • 带有指向API文档的链接的插件ID。 当激活插件时,ID用作节点名称。
  • 允许的features属性值。
  • 插件提供的功能描述。
插件ID 特征 描述
编辑 cut, copy, paste-default, paste-plaintext paste-wordhtml 剪切、复制和,三种粘贴模式
findreplace find, replace 查找和替换。
format bold, italic underline 基本文本格式
图像 image 基本图像支持(从内容或内容查找器中拖动)。 根据浏览器的不同,支持对作者具有不同的行为
按键 - 要定义此值,请参阅选项卡大小
证明 justifyleft, justifycenter justifyright 段落对齐。
链接 modifylink, unlink anchor 超链接和锚点
列表 ordered, unordered, indent outdent 此插件同时控制缩进和列表;包括嵌套列表。
错误工具 specialchars, sourceedit 其他工具允许作者输入特殊字符或编辑HTML源。 此外,如果要定义自己的列表,还可以添加范围的特殊字符
参数格式 paraformat 默认段落格式为段落、标题1、标题2和标题3(<p><h1><h2><h3>)。 您可以添加更多段落格式或扩展列表。
拼写检查 checktext 语言识别拼写检查器
样式 styles 支持使用CSS类设置样式。 如果要添加( 或扩展)您自己的样式范围以用于文本,请添加新的文本样式。
上标 subscript, superscript 基本格式的扩展,添加子脚本和超级脚本。
table, removetable, insertrow, removerow, insertcolumn, removecolumn, cellprops, mergecells, splitcell, selectrow, selectcolumns 请参阅配置表样式,为整个表或单个单元格添加您自己的样式。
撤消 undo, redo 撤消和重做操作的历史记录大小。
NOTE

对话框模式不支持全屏插件。 使用dialogFullScreen设置将工具栏配置为全屏模式。

了解配置路径和位置

当您激活RTE插件时,RTE编辑的模式和您为作者提供的接口决定配置详细信息的位置。 位置包括:

  • 内联模式:cq:editConfig/cq:inplaceEditing
  • 全屏模式: cq:editConfig/cq:inplaceEditing.
  • 对话框模式:cq:dialog
  • 全屏对话框模式:cq:dialog
NOTE

请勿将cq:inplaceEditing下的节点命名为config。 在cq:inplaceEditing节点上,定义以下属性:

  • 名称: configPath
  • 类型: String
  • :包含实际配置的节点的路径

请勿将RTE配置节点命名为config。 否则,RTE配置只对管理员有效,对组content-author中的用户无效。

配置在对话框编辑模式下应用的以下属性:

  • useFixedInlineToolbar:您可以修复RTE工具栏而不是浮动工具栏。将在RTE节点上定义的sling:resourceType= cq/gui/components/authoring/dialog/richtext的布尔属性设置为True。 当此属性设置为True时,将在foundation-contentloaded事件上启动富文本编辑。 要防止出现这种情况,请将属性customStart设置为True并触发rte-start事件以开始RTE编辑。 当此属性为true时,RTE不会开始单击,这是默认行为。

  • customStart:将在RTE节点上定义的此布尔属 True性设置为,通过触发开始控制何时事件RTE rte-start

  • rte-start:在RTE上触发此 contenteditable-div 事件,何时开始编辑RTE。仅当customStart已设置为true时,它才起作用。

在触屏启用对话框中使用RTE时,将属性useFixedInlineToolbar设置为true以避免出现问题。

通过激活插件启用RTE功能

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

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

核心组件文本组件允许模板编辑器使用用户界面作为内容策略来配置许多RTE插件,从而无需进行技术配置。 内容策略可以如本文档所述使用RTE UI配置。 有关详细信息,请参阅创建页面模板核心组件开发人员文档

为便于参考,默认文本组件(作为标准安装的一部分提供)可在以下位置找到:

  • /libs/wcm/foundation/components/text
  • /libs/foundation/components/text

要创建您自己的文本组件,请复制上述组件,而不是编辑这些组件。

配置RTE工具栏

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

要为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>

内联模式和全屏模式使用不同的用户界面设置。 工具栏属性指定工具栏的选项。

例如,如果选项本身是功能(例如Bold),则它被指定为PluginName#FeatureName(例如links#modifylink)。

如果选项是弹出窗口(包含插件的某些功能),则指定为#PluginName(例如#format)。

可以使用-指定一组选项之间的分隔符(|)。

内嵌模式或全屏模式下的弹出节点包含正在使用的弹出画板的列表。 popovers节点下的每个子节点都以插件命名(例如,格式)。 它有一个属性“items”,其中包含插件功能的列表(例如,format#bold)。

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

管理员可以使用内容策略控制RTE选项,例如,不要按照上述说明进行配置。 当内容策略用作可编辑模板的一部分时,内容策略定义组件的设计属性。 例如,如果将使用RTE的文本组件与可编辑的模板一起使用,内容策略可以定义粗体选项可用,并提供一些段落格式选项。 内容策略可重复使用,并可以跨多个模板应用。

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

  • 用户界面配置设置定义了内容策略可用的选项。
  • 如果删除或未启用RTE的用户界面配置,则内容策略无法配置它。
  • 作者只能访问用户界面配置和内容策略提供的功能。

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

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

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

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

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

  3. 在每个单独的图标节点上,指定Coral图标和映射到该图标的命令。

下面是将命令Bold映射到名为textItalic的Coral图标的示例代码片断。

<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>

已知限制

Experience Manager RTE功能有以下限制:

  • RTE功能仅在Experience Manager组件对话框中受支持。 向导或基础表单不支持RTE。

  • Experience Manager 在混合设备上不工作。

  • 请勿命名RTE配置节点config。 否则,RTE配置仅对管理员有效,对组content-author中的用户无效。

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

最佳实践和提示

  • 对于浮动对话框,请仅启用不带弹出对话框的插件。 没有弹出窗口的插件尺寸较小,最适合浮动对话框。
  • 仅在全屏对话框模式或全屏模式下,才能启用弹出窗口较大(如Paste插件)的插件。 具有大弹出窗口的插件需要更多屏幕空间来提供良好的创作体验。
  • 如果您正在为CoralUI3 RTE使用自定义插件,请使用rte.coralui3库。

在此页面上