配置富文本编辑器插件 configure-the-rich-text-editor-plug-ins
RTE功能通过一系列插件提供,每个插件都具有功能属性。 您可以配置features属性以启用或禁用一个或多个RTE功能。 本文介绍了如何专门配置RTE插件。
有关其他RTE配置的详细信息,请参阅配置富文本编辑器。
激活插件并配置功能属性 activateplugin
要激活插件,请执行以下步骤。 只有在首次配置插件时才需要执行某些步骤,因为不存在相应的节点。
默认情况下,format
、link
、list
、justify
和control
插件及其所有功能已在RTE中启用。
rtePlugins
节点称为<rtePlugins-node>
,以避免本文中出现重复。-
使用CRXDE Lite,找到项目的文本组件。
-
在配置任何RTE插件之前,创建
<rtePlugins-node>
的父节点(如果存在):-
根据您的组件,父节点包括:
config: .../text/cq:editConfig/cq:inplaceEditing/config
- 替代配置节点:
.../text/cq:editConfig/cq:inplaceEditing/inplaceEditingTextConfig
text: .../text/dialog/items/tab1/items/text
-
类型为: jcr:primaryType
cq:Widget
-
两者都具有以下属性:
- 名称
name
- 类型
String
- 值
./text
- 名称
-
-
根据您配置的接口,创建一个节点
<rtePlugins-node>
(如果它不存在):- 名称
rtePlugins
- 类型
nt:unstructured
- 名称
-
在此路径下,为要激活的每个插件创建一个节点:
- 类型
nt:unstructured
- 名称 需要此插件的插件ID
- 类型
激活插件后,请按照以下准则配置features
属性。
*
(星号)了解findreplace插件 findreplace
findreplace
插件不需要任何配置。 开箱即用。
在使用替换功能时,要替换的替换字符串应与查找字符串同时输入。不过,您仍可以在替换字符串之前单击“查找”来搜索它。如果在单击“查找”后输入替换字符串,则搜索将重置到文本的开头。
在单击“查找”时,“查找和替换”对话框变为透明;在单击“替换”时,此对话框变为不透明。这允许作者查看自己替换的文本。 如果用户单击“全部替换” ,对话框将关闭并显示所做的替换次数。
配置粘贴模式 paste-modes
使用RTE时,作者可以通过以下三种模式之一粘贴内容:
-
浏览器模式:使用浏览器的默认粘贴实现粘贴文本。 不建议使用此方法,因为它可能会引入不需要的标记。
-
纯文本模式:将剪贴板内容粘贴为纯文本。 在Experience Manager组件中插入之前,它会从复制的内容中删除所有样式和格式元素。
-
MS® Word模式:从MS® Word复制时,粘贴包含格式设置的文本(包括表格)。 不支持从其他源(如网页或MS® Excel)复制和粘贴文本,并且仅保留部分格式。
配置RTE工具栏上可用的粘贴选项 configure-paste-options-available-on-the-rte-toolbar
您可以在RTE工具栏中为作者提供以下三个图标中的部分、全部或不提供:
-
粘贴(Ctrl+V):可以预配置为与上述三种粘贴模式之一相对应。
-
粘贴为文本:提供纯文本模式功能。
-
从Word 粘贴 提供MS® Word模式功能。
要配置RTE以显示所需的图标,请执行以下步骤。
- 导航到您的组件,例如
/apps/<myProject>/components/text
。 - 导航到节点
rtePlugins/edit
。 如果节点不存在,请参阅激活插件。 - 在
edit
节点上创建features
属性并添加一个或多个功能。 保存所有更改。
配置粘贴(Ctrl+V)图标和快捷键的行为 configure-the-behavior-of-the-paste-ctrl-v-icon-and-shortcut
可以使用以下步骤预配置 粘贴(Ctrl+V) 图标的行为。 此配置还定义了作者用于粘贴内容的键盘快捷键Ctrl+V的行为。
该配置允许使用以下三种类型的用例:
-
使用浏览器的默认粘贴实施粘贴文本。 不建议使用此方法,因为它可能会引入不需要的标记。 使用下面的
browser
进行配置。 -
以纯文本形式粘贴剪贴板内容。 在AEM组件中插入之前,它会从复制的内容中剥离所有样式和格式元素。 使用下面的
plaintext
进行配置。 -
从MS® Word复制时,粘贴包含格式设置的文本(包括表格)。 不支持从其他源(如网页或MS® Excel)复制和粘贴文本,并且仅保留部分格式。 使用下面的
wordhtml
进行配置。
-
在组件中,导航到
<rtePlugins-node>/edit
节点。 如果节点不存在,请创建节点。 有关详细信息,请参阅激活插件。 -
在
edit
节点中,使用以下详细信息创建属性:- 名称
defaultPasteMode
- 类型
String
- 值 所需的粘贴模式
browser
、plaintext
或wordhtml
之一。
- 名称
配置粘贴内容时允许的格式 pasteformats
可进一步配置paste-as-Microsoft-Word (paste-wordhtml
)模式,以便您明确定义在从其他程序(如Microsoft® Word)粘贴AEM时允许使用的样式。
例如,如果在AEM中粘贴时只允许使用粗体格式和列表,则可以筛选掉其他格式。 这称为可配置的粘贴筛选,可同时为以下两项执行该操作:
对于链接,您还可以定义自动接受的协议。
要配置在将文本从其他程序粘贴到AEM时允许的格式,请执行以下操作:
-
在组件中,导航到节点
<rtePlugins-node>/edit
。 如果节点不存在,请创建节点。 有关详细信息,请参阅激活插件。 -
在
edit
节点下创建一个节点,以便您可以保存HTML粘贴规则:- 名称
htmlPasteRules
- 类型
nt:unstructured
- 名称
-
在
htmlPasteRules
下创建一个节点,以便您可以保存允许的基本格式的详细信息:- 名称
allowBasics
- 类型
nt:unstructured
- 名称
-
要控制接受的各个格式,请在
allowBasics
节点上创建以下一个或多个属性:- 名称
bold
- 名称
italic
- 名称
underline
- 名称
anchor
(对于链接和命名锚点) - 名称
image
所有属性都是 类型
Boolean
,因此在适当的 值 中,您可以选择或删除复选标记以启用或禁用该功能。note note NOTE 如果未明确定义,则使用默认值true ,并且格式可接受。 - 名称
-
其他格式也可以使用同样应用于
htmlPasteRules
节点的一系列其他属性或节点来定义。 保存所有更改。
您可以为htmlPasteRules
使用以下属性。
allowBlockTags
定义允许的块标记列表。 一些可能的块标记包括:
- 标题(h1、h2、h3)
- 第(p)款
- 列表(ol, ul)
- 表(table)
fallbackBlockTag
allowBlockTags
中的块标记的任何块。 p
通常就足够了。定义粘贴表时的行为。 此节点必须具有属性allow
(类型Boolean)才能定义是否允许粘贴表。 如果allow设置为false
,则必须指定属性ignoreMode
(类型String)以定义如何处理粘贴的表内容。 ignoreMode
的有效值为:
remove
:删除表内容。paragraph
:将表格单元格转换为段落。
定义粘贴列表时的行为。 必须具有属性allow
(类型Boolean)以定义是否允许粘贴列表。 如果allow
设置为false
,则必须指定属性ignoreMode
(类型字符串)以定义如何处理粘贴的任何列表内容。 ignoreMode
的有效值为:
remove
:删除列表内容。paragraph
:将列表项转换为段落。
以下是有效htmlPasteRules
结构的示例。
"htmlPasteRules": {
"allowBasics": {
"italic": true,
"link": true
},
"allowBlockTags": [
"p", "h1", "h2", "h3"
],
"list": {
"allow": false,
"ignoreMode": "paragraph"
},
"table": {
"allow": true,
"ignoreMode": "paragraph"
}
}
配置文本样式 textstyles
作者可以应用样式来更改部分文本的外观。 样式基于您在CSS样式表中预定义的CSS类。 使用class
属性将样式化内容包含在span
标记中,以引用CSS类。 例如:<span class=monospaced>Monospaced Text Here</span>
。
首次启用样式插件时,没有默认样式可用。 弹出列表为空。 要向作者提供样式,请执行以下操作:
- 启用样式下拉选择器。
- 指定样式表的位置。
- 指定可从“样式”下拉列表中选择的单个样式。
对于以后的配置,如要添加更多样式,请仅按照说明引用新的样式表并指定其他样式。
启用样式下拉选择器列表 styleselectorlist
启用样式插件可完成此操作。
-
在组件中,导航到节点
<rtePlugins-node>/styles
。 如果节点不存在,请创建节点。 有关详细信息,请参阅激活插件。 -
在
styles
节点上创建features
属性:- 名称
features
- 类型
String
- 值
*
(星号)
- 名称
-
保存所有更改。
指定样式表位置 locationofstylesheet
然后,指定要引用的样式表的位置:
-
导航到文本组件的根节点,例如
/apps/<myProject>/components/text
。 -
将属性
externalStyleSheets
添加到<rtePlugins-node>
的父节点:- 名称
externalStyleSheets
- Type
String[]
(多字符串;单击CRXDE中的 Multi) - 值 要包含的每个样式表的路径和文件名。 使用存储库路径。
note note NOTE 以后可随时向其它样式表添加参照。 - 名称
-
保存所有更改。
CQrte
的容器DOM元素,该元素可用于提供不同的样式进行查看和编辑:#CQ td {
// defines the style for viewing }
#CQrte td {
// defines the style for editing }
在弹出列表中指定可用的样式 stylesindropdown
-
在组件定义中,导航到节点
<rtePlugins-node>/styles
,如启用样式下拉选择器中所创建。 -
在节点
styles
下,创建一个节点(也称为styles
)来保存正在提供的列表:- 名称
styles
- 类型
cq:WidgetCollection
- 名称
-
在
styles
节点下创建一个节点,以便您可以表示单个样式:- 名称,您可以指定名称,但它应该适合样式
- 类型
nt:unstructured
-
将属性
cssName
添加到此节点,以便您可以引用CSS类:- 名称
cssName
- 类型
String
- 值 CSS类的名称(不带前缀“。”;例如,
cssClass
而不是.cssClass
)
- 名称
-
将属性
text
添加到同一节点;这将定义选择框中显示的文本:- 名称
text
- 类型
String
- 值 样式的描述;显示在“样式”下拉选择框中。
- 名称
-
保存更改。
对每个所需的样式重复上述步骤。
配置RTE以优化日语断字 jpwordwrap
使用AEM创作日语内容的作者可以将样式应用于字符,以避免在不需要换行符的情况下出现换行符。 这允许作者在所需位置处断句。 此功能的样式基于CSS样式表中预定义的CSS类。
要创建作者可以应用于日语文本的样式,请执行以下步骤:
-
在“样式”节点下创建一个节点。 请参阅指定新样式。
- 名称:
jpn-word-wrap
- 类型:
nt:unstructure
- 名称:
-
将属性
cssName
添加到节点,以便您可以引用CSS类。 此类名称是日语自动换行功能的保留名称。- 名称:
cssName
- 类型:
String
- 值:
jpn-word-wrap
(没有前一个.
)
- 名称:
-
将属性文本添加到同一节点。 值是作者在选择样式时看到的样式名称。
- 名称:
text
*类型:String
- 值:
Japanese word-wrap
- 名称:
-
创建样式表并指定其路径。 请参阅指定样式表的位置。 将以下内容添加到样式表中。 根据需要更改背景颜色。
code language-css .text span.jpn-word-wrap { display:inline-block; } .is-edited span.jpn-word-wrap { background-color: #ffddff; }
配置段落格式 paraformats
在RTE中创作的任何文本都放置在块标记中,默认值为<p>
。 通过启用paraformat
插件,您可以使用下拉选择列表指定可分配给段落的其他块标记。 段落格式通过指定正确的块标记来确定段落类型。 作者可以使用“格式”选择器选择和分配格式。 示例块标记包括标准段落<p>和标题<h1>、<h2>等。
首次启用段落格式插件时,没有默认的段落格式可用。 弹出列表为空。 要向作者提供段落格式,请执行以下操作:
- 启用格式下拉选择器列表。
- 指定可从下拉列表中选择作为段落格式的块标记。
对于以后的配置或重新配置(如要添加更多格式),请仅遵循说明的相关部分。
启用格式下拉选择器 formatselectorlist
首先启用paraformat插件:
-
在组件中,导航到节点
<rtePlugins-node>/paraformat
。 如果节点不存在,请创建节点。 有关详细信息,请参阅激活插件。 -
在
paraformat
节点上创建features
属性:- 名称
features
- 类型
String
- 值
*
(星号)
- 名称
- 段落(
<p>
) - 标题1 (
<h1>
) - 标题2 (
<h2>
) - 标题3 (
<h3>
)
<p>
标记,那么即使配置了其他格式,内容作者也无法选择 段落格式 选项。指定可用的段落格式 paraformatsindropdown
可以通过以下方式使段落格式可供选择:
-
在组件定义中,导航到节点
<rtePlugins-node>/paraformat
,如启用格式下拉选择器中所创建。 -
在
paraformat
节点下,创建一个保存格式列表的节点:- 名称
formats
- 类型
cq:WidgetCollection
- 名称
-
在
formats
节点下创建一个节点,这将保存单个格式的详细信息:- 名称,您可以指定名称,但它应该适合格式(例如,myparagraph、myheading1)。
- 类型
nt:unstructured
-
在此节点中,添加属性以定义使用的块标记:
-
名称
tag
-
类型
String
-
值 格式的块标记;例如:p、h1、h2。
您无需输入分隔尖括号。
-
-
要添加到同一节点,请添加另一个属性,以便在下拉列表中显示描述性文本:
- 名称
description
- 类型
String
- 值 此格式的描述性文本;例如,段落,标题1,标题2。 此文本显示在“格式”选择列表中。
- 名称
-
保存更改。
对每个所需的格式重复这些步骤。
<p>
、<h1>
、<h2>
和<h3>
)。 重新创建<p>
格式,因为它是默认格式。配置特殊字符 spchar
在标准AEM安装中,当针对特殊字符(specialchars
)启用misctools
插件时,默认选择将立即可用;例如,版权和商标符号。
您可以配置RTE以使您自己的字符选择可用;通过定义不同的字符或整个序列。
定义单个字符 definesinglechar
-
在组件中,导航到节点
<rtePlugins-node>/misctools
。 如果节点不存在,请创建节点。 有关详细信息,请参阅激活插件。 -
在
misctools
节点上创建features
属性:-
名称
features
-
类型
String[]
-
值
specialchars
(或者
String / *
(如果为此插件应用了所有功能)
-
-
在
misctools
下,创建一个节点以保存特殊字符配置:- 名称
specialCharsConfig
- 类型
nt:unstructured
- 名称
-
在
specialCharsConfig
下,创建另一个节点来保存字符列表:- 名称
chars
- 类型
nt:unstructured
- 名称
-
在
chars
下,添加一个节点以保存单个字符定义:- 名称 您可以指定名称,但应反映该字符;例如,一半。
- 类型
nt:unstructured
-
在此节点中,添加以下属性:
- 名称
entity
- 类型
String
- 值 所需字符的HTML表示形式;例如,
&189;
表示小数的一半。
- 名称
-
保存更改。
在CRXDE中,保存属性后,将显示表示的字符。 请参阅下面的示例中一半内容。 重复上述步骤,以便您能够为作者提供更多特殊字符。
定义字符范围 definerangechar
-
在
chars
下,添加一个节点以保存字符范围的定义:- 名称 您可以指定名称,但它应反映字符范围;例如,铅笔。
- 类型
nt:unstructured
-
在此节点下(根据特殊字符范围命名)添加以下两个属性:
-
保存更改。
例如,定义一个范围9998 - 10000为您提供了以下字符。
图:在CRXDE中,定义在RTE 中可用的字符范围
配置表样式 tablestyles
样式通常应用于文本,但也可以对表或几个表单元格应用单独的样式集。 作者可以在“单元格属性”或“表属性”对话框的“样式选择器”框中找到此类样式。 在文本组件(或派生项)中编辑表时样式可用,在标准表组件中则不可用。
-
在组件中,导航到节点
<rtePlugins-node>/table
。 如果节点不存在,请创建节点。 有关详细信息,请参阅激活插件。 -
在
table
节点上创建features
属性:- 名称
features
- 类型
String
- 值
*
(星号)
note note NOTE 如果不希望启用所有表功能,可以按如下方式创建 features
属性:-
类型
String[]
-
值,根据需要使用以下一项或两项:
-
table
以允许编辑表属性;包括样式。 -
cellprops
以允许编辑单元格属性,包括样式。
- 名称
-
定义CSS样式表的位置,以便您可以引用这些样式表。 请参阅指定样式表的位置,因为这与为文本定义样式的位置相同。 如果定义了其他样式,则可以定义位置。
-
在
table
节点下,根据需要创建以下新节点:-
要为整个表定义样式(可在 表属性 下使用):
- 名称
tableStyles
- 类型
cq:WidgetCollection
- 名称
-
要为单个单元格定义样式(可在 单元格属性 下使用):
- 名称
cellStyles
- 类型
cq:WidgetCollection
- 名称
-
-
创建一个节点(视情况在
tableStyles
或cellStyles
节点下),以便您可以表示单个样式:- 名称 您可以指定名称,但它应反映样式。
- 类型
nt:unstructured
-
在此节点上,创建属性:
-
定义要引用的CSS样式
- 名称
cssName
- 类型
String
- 值 CSS类的名称(不带前缀
.
,例如cssClass
而不是.cssClass
)
- 名称
-
定义要在下拉选择器中显示的描述性文本
- 名称
text
- 类型
String
- 值 要显示在选择列表中的文本
- 名称
-
-
保存所有更改。
对每个所需的样式重复上述步骤。
为辅助功能配置表中的隐藏标头 hiddenheader
有时,您可以创建没有可视文本的数据表,但前提是列标题的用途隐含在列与其他列的视觉关系中。 在这种情况下,必须在标题单元格的单元格中提供隐藏的内部文本。 这样,屏幕阅读器和其他辅助技术即可帮助有各种需求的阅读器了解此列的用途。
为了在这种情况下增强辅助功能,RTE支持隐藏的标题单元格。 此外,它还提供与表中隐藏标头相关的配置设置。 这些设置允许您在编辑和预览模式下对隐藏的标题应用CSS样式。 为帮助作者在编辑模式下识别隐藏的标头,请在代码中包含以下参数:
hiddenHeaderEditingCSS
:指定编辑RTE时应用于hidden-header单元格的CSS类的名称。hiddenHeaderEditingStyle
:指定编辑RTE时应用于hidden-header单元格的Style字符串。
如果在代码中同时指定CSS和Style字符串,则CSS类将优先于样式字符串,并可能覆盖样式字符串所做的任何配置更改。
为帮助作者在预览模式下对隐藏的标题应用CSS,您可以在代码中包含以下参数:
hiddenHeaderClassName
:指定在预览模式下应用于隐藏标题单元格的CSS类的名称。hiddenHeaderStyle
:指定在预览模式下应用于hidden-header单元格的样式字符串。
如果在代码中同时指定CSS和Style字符串,则CSS类将优先于样式字符串,并可能覆盖样式字符串所做的任何配置更改。
为拼写检查器添加词典 adddict
当激活spellcheck插件时,RTE会为每种相应的语言使用词典。 然后,通过获取子树的语言属性或者从URL中提取语言来根据网站的语言选择这些语言。 例如,/en/
分支被检查为英文,/de/
分支被检查为德文。
Spell checking failed
。 标准字典位于/libs/cq/spellchecker/dictionaries
,以及相应的自述文件。 请勿修改文件。标准AEM安装包括美式英语(en_us
)和英式英语(en_gb
)的字典。 要添加更多词典,请按照以下步骤操作。
-
执行以下操作之一,查找您选择的语言的词典:
- 搜索您选择的语言的词典。 在词典页面上,找到指向原始源或作者网页的链接。 在此类页面上找到v2.x的字典文件。
- 在https://wiki.openoffice.org/wiki/User:Khirano/Dictionaries处搜索v2.x词典文件。
-
下载包含拼写定义的档案。 提取文件系统中存档文件的内容。
note caution CAUTION 仅支持OpenOffice.org v2.0.1或更低版本中采用 MySpell
格式的词典。 由于字典现在是存档文件,因此建议您在下载后验证存档。 -
找到
.aff
和.dic
文件。 请将文件名保留为小写。 例如,de_de.aff
和de_de.dic
。 -
在
/apps/cq/spellchecker/dictionaries
的存储库中加载.aff
和.dic
文件。
配置撤消和重做操作的历史记录大小 undohistory
RTE允许作者撤消或重做前几次编辑。 默认情况下,历史中存储50次编辑。 您可以根据需要配置此值。
-
在组件中,导航到节点
<rtePlugins-node>/undo
。 创建这些节点(如果这些节点不存在)。 有关详细信息,请参阅激活插件。 -
在
undo
节点上,创建属性:- 名称
maxUndoSteps
- 类型
Long
- 值 要保存在历史记录中的撤消步骤数。 默认值为50。 使用
0
可完全禁用撤消/重做。
- 名称
-
保存更改。
配置选项卡大小 tabsize
当在任意文本中按制表符字符时,会插入预定义的空格数;默认情况下,这是三个不间断的空格和一个空格。
要定义选项卡大小,请执行以下操作:
-
在组件中,导航到节点
<rtePlugins-node>/keys
。 如果节点不存在,请创建节点。 有关详细信息,请参阅激活插件。 -
在
keys
节点上,创建属性:- 名称
tabSize
- 类型
String
- 值 用于制表器的空格字符数
- 名称
-
保存更改。
设置缩进边距 indentmargin
启用缩进(默认)后,您可以定义缩进的大小:
-
在组件中,导航到节点
<rtePlugins-node>/lists
。 创建这些节点(如果这些节点不存在)。 有关详细信息,请参阅激活插件。 -
在
lists
节点上,创建indentSize
参数:- 名称:
indentSize
- 类型:
Long
- 值:缩进边距所需的像素数。
- 名称:
配置可编辑空间的高度 editablespace
您可以定义组件对话框中显示的可编辑空间的高度:
-
在组件的对话框定义中的
../items/text
节点上,创建一个属性:- 名称
height
- 类型
Long
- 值 编辑画布的高度(像素)。
note note NOTE 这不会更改对话框窗口的高度。 - 名称
-
保存更改。
为链接配置样式和协议 linkstyles
在AEM中添加链接时,您可以定义:
- 要使用的CSS样式
- 自动接受的协议
要配置如何将链接从其他程序添加到AEM中,请定义HTML规则。
-
使用CRXDE Lite,找到项目的文本组件。
-
在与
<rtePlugins-node>
相同的级别上创建一个节点,即在<rtePlugins-node>
的父节点下创建该节点:- 名称
htmlRules
- 类型
nt:unstructured
note note NOTE ../items/text
节点具有属性:- 名称
xtype
- 类型
String
- 值
richtext
../items/text
节点的位置可能因对话框的结构而异;两个示例为/apps/myProject>/components/text/dialog/items/text
和/apps/<myProject>/components/text/dialog/items/panel/items/text
。 - 名称
-
在
htmlRules
下,创建一个节点。- 名称
links
- 类型
nt:unstructured
- 名称
-
在
links
节点下,根据需要定义属性:-
内部链接的CSS样式:
- 名称
cssInternal
- 类型
String
- 值 CSS类的名称(不带前缀“。”;例如,
cssClass
而不是.cssClass
)
- 名称
-
外部链接的CSS样式
- 名称
cssExternal
- 类型
String
- 值 CSS类的名称(不带前缀“。”;例如,
cssClass
而不是.cssClass
)
- 名称
-
有效 协议 的数组。 支持的协议为
http://
、https://
、file://
和mailto:
。- 名称
protocols
- 类型
String[]
- 值 一个或多个协议
- 名称
-
defaultProtocol (类型为 字符串 的属性):用户未明确指定协议时要使用的协议。
- 名称
defaultProtocol
- 类型
String
- 值 一个或多个默认协议
- 名称
-
有关如何处理链接的目标属性的定义。 创建节点:
- 名称
targetConfig
- 类型
nt:unstructured
在节点
targetConfig
上,定义所需的属性:-
指定目标模式:
-
名称
mode
-
类型
String
-
值
-
auto
:表示选择了自动目标(由外部链接的
targetExternal
属性或内部链接的targetInternal
指定)。 -
manual
:在此上下文中不适用 -
blank
:在此上下文中不适用
-
-
-
内部链接的目标:
- 名称
targetInternal
- 类型
String
- 值 内部链接的目标(仅在模式为
auto
时使用)
- 名称
-
外部链接的目标:
- 名称
targetExternal
- 类型
String
- 值 外部链接的目标(仅在模式为
auto
时使用)。
- 名称
- 名称
-
-
保存所有更改。