設定RTF編輯器 configure-the-rich-text-editor

RTF編輯器(RTE)為作者提供了一系列廣泛的功能,以便編輯其文字內容。 提供圖示、選取方塊、工具列和選單,以提供WYSIWYG文字編輯體驗。

若要瞭解如何使用RTE功能進行編寫,請參閱使用RTF編輯器進行編寫。 RTE可以設定為啟用、停用及擴充編寫元件中可用的功能。 下列工作流程說明在Experience Manager中完成RTE設定工作的建議順序。

學習如何設定RTE的步驟順序

圖:瞭解如何設定RTE的步驟順序

瞭解觸控式UI和傳統UI understand-touch-enabled-ui-and-classic-ui

觸控式UI是Experience Manager的標準使用者介面。 Adobe針對製作環境推出觸控式UI搭配回應式設計。 觸控式UI專為觸控和桌上型裝置而設計。 此介面與原始傳統UI有很大差異。

觸控式使用者介面中的 RTF編輯器工具列

圖:觸控式UI中的RTF編輯器工具列

傳統UI中的 RTF編輯器工具列

圖:傳統UI中的RTF編輯器工具列

各種編輯模式 editingmodes

作者可以使用不同的元件模式,在Experience Manager中建立和編輯文字內容。 製作和格式化內容的工具列選項,以及不同編輯模式中RTE啟用元件的使用者體驗,會因RTE設定而異。

編輯模式
編輯區域
建議啟用的功能
觸控式 UI
傳統 UI
內嵌
就地編輯以進行快速、次要的編輯;格式化而不開啟對話方塊
最小化RTE功能
Y
Y
RTE全熒幕
涵蓋整個頁面
所有必要的RTE功能
Y
N
對話方塊
對話方塊位於頁面內容上方,但不涵蓋整個頁面
傳統UI中所有必要的RTE功能;在觸控式UI中謹慎啟用功能
Y
Y
對話方塊全熒幕
與全熒幕模式相同;包含對話方塊的欄位以及RTE
所有必要的RTE功能
Y
N
NOTE
已啟用觸控的UI中,無法以內嵌編輯模式使用來源編輯功能。 您無法在全熒幕模式中拖曳影像。 所有其他功能在所有模式中皆可運作。

內嵌編輯 inline-editing

開啟時(緩慢連按兩下)可在頁面中編輯內容。 將顯示包含非常基本選項的精簡工具列。

在觸控式UI中使用基本工具列進行內嵌編輯

圖:在觸控式UI中使用基本工具列進行內嵌編輯

在傳統UI中,只要在元件上按兩下滑鼠,即可進行內嵌編輯,而橘色外框會反白顯示內容。 如果「內容尋找器」已開啟,視窗頂端會顯示具有可用RTE格式選項的工具列。 如果「內容尋找器」未開啟,則不會顯示格式選項,而且您只能編輯基本文字。

全熒幕編輯 full-screen-editing

Experience Manager元件可在全熒幕檢視中開啟,以隱藏頁面內容並佔用可用熒幕。 請考慮以全熒幕編輯內嵌編輯的詳細版本,因為其提供最豐富的編輯選項。 使用內嵌編輯模式時,可從壓縮工具列按一下 rte_fullscreen 以開啟它。

在對話方塊全熒幕模式以及詳細的RTE工具列中,對話方塊中可用的選項和元件也可使用。 它僅適用於包含RTE以及其他元件的對話方塊。

在觸控式UI中以全熒幕模式編輯時詳細的RTE工具列

圖:在觸控式UI中以全熒幕模式編輯時的詳細RTE工具列

對話方塊編輯 dialog-editing

當元件按兩下時,會開啟對話方塊以編輯內容。 對話方塊會在現有頁面上方開啟。 在某些特定情況下,對話方塊會以快顯視窗開啟。 例如,當文字元件屬於多欄頁面配置中的欄且可用於對話方塊的區域較少時。

觸控式UI中的對話方塊編輯模式

圖:觸控式UI中的對話方塊編輯模式

傳統UI中的對話方塊,其中包含編輯的詳細工具列

圖:傳統UI中的對話方塊,其中包含編輯的詳細工具列

關於RTE外掛程式和相關功能 aboutplugins

此功能透過一系列外掛程式提供,每個外掛程式具有:

  • features屬性:

    • 用來啟用或停用該外掛程式的基本功能
    • 可使用標準化的程式進行設定
  • 適當時,需要專門設定的其他屬性和選項。

RTE的基本功能會由適當外掛程式特定節點上的features屬性值啟用或停用。

下表列出目前的外掛程式,其中顯示:

  • 外掛程式ID及API檔案連結。 啟用外掛程式時,會將ID用作節點名稱。
  • features屬性的允許值。
  • 外掛程式所提供功能的說明。
外掛程式ID
功能
說明
編輯
剪下複製paste-default paste-plaintext paste-wordhtml
剪下、複製和三種貼上模式
findreplace
尋找取代
尋找和取代。
格式
粗斜體底線
基本文字格式
影像
影像
基本影像支援(從內容或內容尋找器拖曳)。 根據瀏覽器的不同,支援對作者有不同的行為
金鑰
若要定義此值,請參閱索引標籤大小
左右對齊
靠左對齊justifycenter靠右
段落對齊方式。
連結
modifylink取消連結錨點
超連結和錨點
清單
已排序的無序縮排凸排
此外掛程式同時控制縮排和清單;包括巢狀清單。
misctools
specialchars sourceedit
其他工具可讓作者輸入特殊字元或編輯HTML來源。 此外,如果您想要定義自己的清單,可以新增整個範圍的特殊字元
引數格式
paraformat
預設的段落格式為段落、標題1、標題2和標題3 (<p><h1><h2><h3>)。 您可以新增更多段落格式或擴充清單。
拼字檢查
核取文字
語言感知拼字檢查程式
樣式
樣式
支援使用CSS類別設定樣式。 如果您想要新增(或擴充)自己的樣式範圍以搭配文字使用,請新增文字樣式
下標
下標上標
基本格式的擴充功能,可新增子指令碼和超級指令碼。
表格
表格removetable insertrow removerow insertcolumn removecolumn cellprops mergecells splitcell selectrow selectcolumns
如果要為整個表格或個別儲存格新增自己的樣式,請參閱設定表格樣式
復原
還原重做
復原與重做作業的歷史記錄大小。
NOTE
對話方塊模式不支援全熒幕外掛程式。 使用dialogFullScreen設定來設定全熒幕模式的工具列。

瞭解設定路徑和位置 understand-the-configuration-paths-and-locations

您提供給作者的RTE編輯模式(和UI)決定您啟動RTE外掛程式時組態詳細資料的位置:

編輯模式
觸控式UI的位置
傳統UI的位置
內嵌
cq:editConfig/cq:inplaceEditing
cq:editConfig/cq:inplaceEditing
全熒幕
cq:editConfig/cq:inplaceEditing
不適用
對話方塊
cq:dialog
dialog
全熒幕對話方塊
cq:dialog
不適用
NOTE
請勿將cq:inplaceEditing下的節點命名為config。 在cq:inplaceEditing節點上,定義下列屬性:
  • 名稱configPath
  • 類型String
  • :包含實際組態的節點路徑
不要將RTE設定節點命名為config。 否則,RTE設定只對管理員生效,對群組content-author中的使用者則不會生效。

設定以下僅適用於Touch UI中對話方塊編輯模式的屬性:

  • useFixedInlineToolbar:將這個RTE節點(具有sling:resourceType= cq/gui/components/authoring/dialog/richtext的節點)上定義的布林值屬性設定為True,以使RTE工具列固定而非浮動。

    此屬性為true時,RTF編輯預設會在「foundation-contentloaded」事件中啟動。

    若要防止此情況,請將屬性customStart設定為True並觸發'rte-start'事件以開始RTE編輯。 當此屬性為「true」時,預設行為(按一下即啟動rte)將無法運作。

  • customStart:將這個RTE節點上定義的布林值屬性設定為True,以透過觸發事件rte-start來控制何時啟動RTE。

  • rte-start:在RTE的contenteditable-div開始編輯RTE時觸發此事件。 只有在customStart設定為true時才有效。

當觸控式對話方塊中使用RTE時,必須將屬性useFixedInlineToolbar設定為true以避免問題。

自訂就地編輯 customizing-in-place-editing

您可以透過設定以下屬性來定義文字編輯器從哪個HTML選擇器開始:

  • editElementQuery — 定義於cq:InplaceEditingConfig,此屬性用於指定將開始內嵌編輯文字元件的HTML元素選取器。 如果未指定,內嵌編輯會直接在文字元件HTML上啟動。
  • textPropertyName — 定義於cq:InplaceEditingConfig,此屬性用於指定將儲存在內容節點上的屬性名稱,其中文字元件的HTML值將在內嵌編輯後持續存在。

對話方塊模式的對應屬性是name

透過啟用外掛程式來啟用RTE功能 enable-rte-functionalities-by-activating-plug-ins

RTE功能可透過一系列外掛程式使用,每個外掛程式都具備功能屬性。 您可以設定功能屬性,以啟用或停用每個外掛程式的各種功能。

如需RTE外掛程式的詳細設定,請參閱如何啟用及設定RTE外掛程式

範例:下載此範例組態,其中說明如何設定RTE。 在此套件中會啟用所有功能。

NOTE
核心元件文字元件可讓範本編輯器在GUI中設定許多RTE外掛程式作為內容原則,而不需要技術設定。 內容原則可搭配使用RTE UI設定,如本檔案所述。
如需詳細資訊,請參閱本檔案的RTE UI設定和內容原則一節,以及建立頁面範本核心元件開發人員檔案
NOTE
為了參考之用,預設Text元件(作為標準安裝的一部分提供)可在以下位置找到:
  • /libs/wcm/foundation/components/text
  • /libs/foundation/components/text
若要建立自己的文字元件,請複製上述元件,而非編輯這些元件。

設定RTE工具列 dialogfullscreen

AEM可讓您針對不同的編輯模式,以不同方式設定RTF編輯器的介面。 預設設定如下。 您可以根據需求覆寫這些預設值。 您只需自訂要提供給作者的工具列功能。 您不需要指定所有工具列設定。

若要設定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)。

一組按鈕之間的分隔符號(|)可以使用-指定。

內嵌或全熒幕模式下的快顯節點包含正在使用的彈出視窗清單。 「彈出視窗」節點下的每個子節點都會以外掛程式(例如格式)命名。 其屬性「items」包含外掛程式的功能清單(例如,format#bold)。

RTE使用者介面設定和內容原則 rtecontentpolicies

管理員可以使用內容原則來控制RTE選項,而不是如上所述進行設定。 當內容原則用作可編輯的範本的一部分時,會定義元件的設計屬性。 例如,如果使用RTE的文字元件搭配可編輯的範本使用,則內容原則可定義粗體選項為可用,而一些段落格式選項為可用。 內容原則可重複使用,並可套用至多個範本。

RTE中可用的選項會從使用者介面設定向下流向內容原則。

  • 使用者介面組態設定會定義哪些選項可供內容原則使用。
  • 如果RTE的使用者介面設定已移除或未啟用專案,則內容原則無法進行設定。
  • 作者只能存取使用者介面設定和內容原則所提供的功能。

例如,您可以看到文字核心元件檔案

自訂工具列圖示和命令之間的對應 iconstoolbar

您可以自訂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>

切換至CoralUI 2 RTF編輯器 switch-to-coralui-rich-text-editor

在頁面上,您可以包含CoralUI 2 RTE clientlib或CoralUI 3 RTE clientlib。 依預設,RTF編輯器包含CoralUI 3 RTE clientlib。 若要切換至CoralUI 2 RTE,請執行下列步驟。

NOTE
Adobe不建議將此作為最佳實務。 最後選擇切換至CoralUI 2 RTE。 如果外掛程式不依賴RTE內部元件(例如類別),CoralUI 2 RTE的自訂外掛程式可搭配CoralUI 3 RTE使用。
如果您使用CoralUI3 RTE的自訂外掛程式,請使用rte.coralui3資料庫。
  1. 覆蓋/apps下的節點/libs/cq/gui/components/authoring/editors/clientlibs/core,並執行下列動作:

    • 將相依性屬性的rte.coralui3取代為rte.coralui2
    • 將內嵌屬性的cq.authoring.editor.core.inlineediting.rte.coralui3取代為cq.authoring.editor.core.inlineediting.rte.coralui2
    • 將內嵌屬性的cq.authoring.rte.coralui3取代為cq.authoring.rte.coralui2
  2. 覆蓋/apps下的節點/libs/cq/gui/components/authoring/dialog/richtext/clientlibs/rte/coralui3/libs/cq/gui/components/authoring/dialog/richtext/clientlibs/rte/coralui2

    /apps/cq/gui/components/authoring/dialog/richtext/clientlibs/rte/coralui3移除類別cq.authoring.dialog並將其新增至/apps/cq/gui/components/authoring/dialog/richtext/clientlibs/rte/coralui2

  3. 將頁面上包含的任何其他相依性從rte.coralui3變更為rte.coralui2。 例如,在/apps下覆蓋節點/libs/mcm/campaign/components/touch-ui/clientlibs/rte之後,將任何依賴它的專案從rte.coralui3變更為rte.coralui2

  4. 覆蓋/apps下的節點cq/ui/widgets。 將節點/apps/cq/ui/widgets的相依性cq.rte取代為cq.coralui2.rte

NOTE
CoralUI 2 RTE將Handlebars範本用於外掛程式對話方塊。 因此,CoralUI 2 RTE clientlib依賴handlebars clientlib。 CoralUI 3 RTE不使用Handlebars範本,且沒有任何相關的相依性。 如果您的自訂外掛程式使用Handlebars範本,請在網頁中加入Handlebars clientlib 。

更多資訊 further-information

如需有關設定RTE的詳細資訊,請參閱AEM Widget API參考。

具體來說,若要檢視外掛程式和可用的相關選項:

  • CQ.form.RichText元件提供表單欄位,用於編輯樣式文字資訊(RTF)。 若要瞭解RTF表單可用的所有引數,請參閱設定選項。

  • RTF元件使用CQ.form.rte.plugins.Plugin下列出的外掛程式,提供各種功能。 對於每個外掛程式:

    • 如需可啟用(或已停用)功能的詳細資訊,請參閱功能
    • 如需適當外掛程式的詳細設定資訊,請參閱設定選項以取得所有可用引數
  • 也提供連結之HTML規則的詳細資訊。

這些可用來擴充及自訂您自己的RTE。 例如,若要在建立連結時列出頁面中可用的錨點,您可以提供自己的LinkPlugin實作。

已知限制 known-limitations

AEM RTE功能有下列限制:

  • 只有AEM元件對話方塊才支援RTE功能。 精靈或Foundation表單(例如頁面屬性支架)不支援觸控式UI上的RTE。

  • AEM無法在混合式裝置上運作。

  • 不要命名RTE設定節點config。 否則,RTE組態只對管理員生效,對群組content-author中的使用者則不會生效。

  • RTE不支援內嵌內容的內嵌框架或iframe。

最佳作法和秘訣 best-practices-and-tips

  • 只啟用外掛程式,而不使用浮動對話方塊的快顯視窗。 沒有快顯視窗的外掛程式尺寸較小,最適合用於浮動對話方塊。
  • 只有在全熒幕對話方塊模式或全熒幕模式中,才可使用較大的快顯視窗來啟用外掛程式,例如Paste外掛程式。 具有大型快顯視窗的外掛程式需要更多熒幕空間,才能提供良好的撰寫體驗。
  • 如果您使用CoralUI3 RTE的自訂外掛程式,請使用rte.coralui3資料庫。

疑難排解RTE的常見問題 troubleshoot-issues-with-aem-rich-text-editor

如何選取多個資料表儲存格?

若要選取表格中的多個儲存格,請按CtrlCmd鍵,然後逐一按一下表格儲存格。

現在對選取範圍執行操作,例如設定選取儲存格的屬性。

使用[設定]按鈕編輯元件時,超連結遺失

使用「設定」按鈕編輯文字元件,以新增超連結。 當您再次編輯超連結並再次驗證超連結時,可能會遺失超連結。

因應措施是在第二次顯示編輯對話方塊時按一下文字元件,然後執行連結驗證。

此問題已在AEM 6.3及更高版本中解決。

在來源編輯模式中新增的​ HTML內容遺失

請勿新增易發XSS的HTML。 AEM而非RTE可能會移除一些HTML內容,以遵守XSS防霧規則。

若要確認已貼上的HTML是否已儲存,請檢查CRXDE中已儲存的內容(在內容節點中)。

如果未儲存,則HTML必須已由RTE移除,因為它不符合RTE的規則。

如果儲存在CRXDE中但未在頁面上轉譯(若要檢查轉譯,請參閱頁面的預覽,則會被AEM XSS規則移除。

多欄位元件未如預期般運作

若要建立多欄位元件,請專門使用CoralUI 3。 請勿使用CoralUI 2元件對話方塊。

此外,請確認您的多欄位實作程式碼和節點結構正確無誤。

系統管理員可用的設定不適用於作者

如果介面組態更新反映在管理員而非作者帳戶中,請確定組態節點未命名為config。 使用configPath屬性

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2