配置富文本编辑器

富文本编辑器(RTE)为作者提供了一系列广泛的功能来编辑文本内容。 为所见即所得文本编辑体验提供了图标、选择框、工具栏和菜单。 管理员配置RTE以启用、禁用和扩展创作组件中可用的功能。 了解作者如何操作 使用RTE进行创作 网站内容。

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

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

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

RTE界面提供 响应式设计 (创作环境)。 该界面专为触控设备和桌面设备而设计。

富文本编辑器工具栏

图:已启用所有可用选项的“富文本编辑器”工具栏。

工具栏提供了WYSIWYG创作体验的选项。 Experience Manager 管理员可以在界面上的工具栏中配置可用选项。 默认情况下,有一组完整的编辑选项在以下位置提供: Experience Manager. 开发人员可以自定义 Experience Manager 以添加更多编辑选项。

各种编辑模式

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

编辑模式 编辑区域 建议启用的功能
内嵌 就地编辑以进行快速、次要的编辑;格式化而不打开对话框。 最小的RTE功能。
RTE全屏 涵盖整个页面。 所有必需的RTE功能。
对话框 对话框覆盖整个页面。 谨慎地启用功能。
全屏对话框 与全屏模式相同;包含对话框的字段以及RTE。 所有必需的RTE功能。
注意

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

内联编辑

要编辑页面中的内容,请通过缓慢双击打开内容。 显示了一个包含基本选项的紧凑工具栏。

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

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

全屏编辑

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

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

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

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

对话框编辑

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

对话框编辑模式

图:对话框编辑模式。

关于RTE插件和相关功能

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

  • A features 属性,即,

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

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

下表列出了当前的插件,其中显示:

  • 包含指向API文档链接的插件ID。 在以下情况下,ID用作节点名称 激活插件.
  • 允许的值 features 属性。
  • 插件提供的功能描述。
插件Id 功能 描述
编辑 cut, copy, paste-default, paste-plaintext, paste-wordhtml 剪切、复制和三种粘贴模式.
findreplace findreplace 查找并替换.
格式 bolditalicunderline 基本文本格式.
图像 image 基本图像支持(从内容或内容查找器拖动)。 根据浏览器的不同,对作者的支持有不同的行为
- 要定义此值,请参阅 制表符大小.
两端对齐 justifyleftjustifycenterjustifyright 段落对齐方式。
链接 modifylinkunlinkanchor 超链接和锚点.
列表 ordered, unordered, indent, outdent 此插件会同时控制两者 缩进和列表;包括嵌套列表。
misctools specialcharssourceedit 其他工具允许作者输入 特殊字符 或编辑HTML源。 此外,您还可以添加 特殊字符的范围 如果您想要定义自己的列表。
参数格式 paraformat 默认段落格式为段落、标题1、标题2和标题3 (<p><h1><h2>、和 <h3>)。 您可以 添加更多段落格式 或者扩展列表。
拼写检查 checktext 语言感知拼写检查器.
样式 styles 支持使用CSS类进行样式。 添加新文本样式 如果要添加(或扩展)自己的样式范围以用于文本。
下标 subscriptsuperscript 基本格式的扩展,可添加子脚本和超级脚本。
table, removetable, insertrow, removerow, insertcolumn, removecolumn, cellprops, mergecells, splitcell, selectrow, selectcolumns 参见 配置表样式 为整个表或单个单元格添加自己的样式。
撤消 undoredo 历史记录大小 撤消和重做 操作。
注意

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

了解配置路径和位置

RTE编辑模式和界面 由您为作者提供的位置来确定配置详细信息的位置, 激活RTE插件. 这些位置包括:

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

不要将节点命名为 cq:inplaceEditing 作为 config. 日期 cq:inplaceEditing 节点,定义以下属性:

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

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

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

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

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

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

在启用了触控的对话框中使用RTE时,设置属性 useFixedInlineToolbartrue 以避免出现问题。

通过激活插件启用RTE功能

RTE功能通过一系列插件提供,每个插件都具有功能属性。 您可以配置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 节点以插件命名(例如,format)。 它具有包含插件功能列表(例如,format#bold)的“items”属性。

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

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

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

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

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

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

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

  1. 创建名为的节点 iconsuiSettings/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>

已知限制

Experience Manager RTE功能具有以下限制:

  • 仅支持RTE功能 Experience Manager 组件对话框。 向导或Foundation-forms不支持RTE。

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

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

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

最佳实践和提示

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

在此页面上