Konfigurieren des Rich-Text-Editors configure-the-rich-text-editor
Der Rich-Text-Editor (RTE) bietet Autoren eine große Bandbreite an Funktionen zum Bearbeiten von Textinhalten. Symbole, Auswahlfelder, Symbolleiste und Menüs werden für eine WYSIWYG-Textbearbeitung bereitgestellt. Administratoren können den RTE konfigurieren, um die in den Authoring-Komponenten verfügbaren Funktionen zu aktivieren, zu deaktivieren und zu erweitern. Erfahren Sie, wie Autoren RTE zum Erstellen von Web-Inhalten verwenden.
Die RTE-Konzepte und -Schritte, die zur Konfiguration erforderlich sind, sind unten aufgeführt.
Grundlegendes zur Benutzeroberfläche, die Autoren zur Verfügung steht understand-rte-ui
Die RTE-Benutzeroberfläche bietet ein responsives Design für die Authoring-Umgebung. Die Benutzeroberfläche wurde für die Verwendung auf Touch- und Desktop-Geräten entwickelt.
Abbildung: Rich-Text-Editor-Symbolleiste mit allen verfügbaren Optionen aktiviert.
Die Symbolleiste enthält die Optionen für das WYSIWYG-Authoring-Erlebnis. Experience Manager-Administratoren können die in der Symbolleiste auf der Benutzeroberfläche verfügbaren Optionen konfigurieren. In Experience Manager stehen standardmäßig umfassende Bearbeitungsoptionen zur Verfügung. Entwickler können Experience Manager anpassen, um weitere Bearbeitungsoptionen hinzuzufügen.
Verschiedene Bearbeitungsmodi editingmodes
Autoren können in Experience Manager Textinhalte mithilfe der verschiedenen Komponentenmodi erstellen und bearbeiten. Die Symbolleistenoptionen für das Erstellen und Formatieren von Inhalten und das Anwendererlebnis von RTE-aktivierten Komponenten in verschiedenen Bearbeitungsmodi variieren je nach RTE-Konfiguration.
Inline-Bearbeitung inline-editing
Um den Inhalt auf einer Seite zu bearbeiten, öffnen Sie den Inhalt mit einem langsamen doppelten Klick. Eine kompakte Symbolleiste mit grundlegenden Optionen erscheint.
Abbildung: Inline-Bearbeitung mit den grundlegenden Optionen in der Symbolleiste
Bearbeitung im Vollbildmodus full-screen-editing
Experience Manager-Komponenten können im Vollbildmodus geöffnet werden. Dabei wird der Seiteninhalt ausgeblendet und der gesamte Bildschirm ausgefüllt. Die Bearbeitung im Vollbildmodus ist eine detaillierte Version der Inline-Bearbeitung, da sie die meisten Bearbeitungsmöglichkeiten bietet. Wenn Sie sich im Inline-Bearbeitungsmodus befinden, kann sie durch Klicken auf das Symbol in der kompakten Symbolleiste geöffnet werden.
Im Dialogfeld-Vollbildmodus stehen neben einer detaillierten RTE-Symbolleiste auch die in einem Dialogfeld verfügbaren Optionen und Komponenten zur Verfügung. Dies gilt nur für ein Dialogfeld, das neben anderen Komponenten einen RTE enthält.
Abbildung: Die detaillierte RTE-Symbolleiste beim Bearbeiten im Vollbildmodus.
Bearbeitung in einem Dialogfeld dialog-editing
Wenn Sie auf eine Komponente doppelklicken, wird ein Dialogfeld zur Bearbeitung des Inhalts geöffnet. Das Dialogfeld wird über der vorhandenen Seite geöffnet. In bestimmten Fällen kann dieses Dialogfeld auch als Popup-Fenster geöffnet werden. Dies ist beispielsweise der Fall, wenn eine Textkomponente Teil einer Spalte in einem mehrspaltigen Seiten-Layout ist und zu wenig Platz für die Anzeige des Dialogfelds vorhanden ist.
Abbildung: Dialogfeldbearbeitungsmodus.
Wissenswertes über RTE-Plug-ins und die zugehörigen Funktionen aboutplugins
Die Funktionen werden über eine Reihe von Plug-ins zur Verfügung gestellt, jeweils mit:
-
einer
features
-Eigenschaft, die- zur Aktivierung oder Deaktivierung der grundlegenden Funktionalität des jeweiligen Plug-ins verwendet werden kann.
- mit einem standardisierten Verfahren konfiguriert wurde.
-
Gegebenenfalls weitere Eigenschaften und Optionen, die eine spezielle Konfiguration erfordern.
Die grundlegenden RTE-Funktionen werden durch den Wert der Eigenschaft features
in einem Knoten aktiviert oder deaktiviert, der spezifisch für das entsprechende Plug-in ist.
In der folgenden Tabelle sind die derzeit verfügbaren Plug-ins aufgelistet, mit Angabe von:
- Plug-in-IDs mit einem Link zur API-Dokumentation. Die ID wird beim Aktivieren eines Plug-ins als Knotenname verwendet.
- Zulässige Werte für die Eigenschaft
features
. - Eine Beschreibung der vom Plug-in bereitgestellten Funktion.
cut
, copy
, paste-default
, paste-plaintext
, paste-wordhtml
find
, replace
image
justifyleft
, justifycenter
, justifyright
ordered
, unordered
, indent
, outdent
specialchars
, sourceedit
paraformat
<p>
, <h1>
, <h2>
und <h3>
). Sie können weitere Absatzformate hinzufügen oder die Liste erweitern.styles
subscript
, superscript
table
, removetable
, insertrow
, removerow
, insertcolumn
, removecolumn
, cellprops
, mergecells
, splitcell
, selectrow
, selectcolumns
dialogFullScreen
.Grundlegendes zu den Konfigurationspfaden und -speicherorten understand-the-configuration-paths-and-locations
Der RTE-Bearbeitungsmodus (und die Benutzeroberfläche), den Sie Ihren Autoren bereitstellen, legt den Speicherort für die Konfigurationsdetails fest, wenn Sie die RTE-Plug-ins aktivieren. Die Speicherorte sind:
- Inline-Modus:
cq:editConfig/cq:inplaceEditing
. - Vollbildmodus:
cq:editConfig/cq:inplaceEditing
. - Dialogfeldmodus:
cq:dialog
. - Vollbildschirm-Dialogfeldmodus:
cq:dialog
.
cq:inplaceEditing
nicht mit config
. Definieren Sie unter dem Knoten cq:inplaceEditing
die folgenden Eigenschaften:- Name:
configPath
- Typ:
String
- Wert: Pfad des Knotens, der die tatsächliche Konfiguration enthält
config
. Andernfalls treten die RTE-Konfigurationen nur für die Administratoren und nicht für die Benutzer in der Gruppe content-author
in Kraft.Konfigurieren Sie die folgenden Eigenschaften, die nur im Dialogfeldbearbeitungsmodus verfügbar sind:
-
useFixedInlineToolbar
: Sie können die RTE-Symbolleiste fixieren, anstatt sie frei beweglich zu machen. Legen Sie diese auf dem RTE-Knoten definierte boolesche Eigenschaft mit sling:resourceType=cq/gui/components/authoring/dialog/richtext
aufTrue
fest. Wenn diese Eigenschaft aufTrue
festgelegt ist, wird die Bearbeitung von Rich-Text beim Ereignisfoundation-contentloaded
gestartet. Um dies zu verhindern, setzen Sie die EigenschaftcustomStart
aufTrue
und lösen Sie das Ereignisrte-start
zum Starten der RTE-Bearbeitung aus. Wenn diese Eigenschafttrue
ist, startet RTE nicht durch Klicken, und dies ist das Standardverhalten. -
customStart
: Setzen Sie diese boolesche Eigenschaft, die im RTE-Knoten definiert ist, aufTrue
, um den RTE-Startzeitpunkt zu steuern, indem Sie das Ereignisrte-start
auslösen. -
rte-start
: Lösen Sie dieses Ereignis beicontenteditable-div
des RTE aus, wenn die RTE-Bearbeitung gestartet werden soll. Dies funktioniert nur, wenncustomStart
auftrue
gesetzt ist.
Wenn der RTE im Touch-optimierten Dialogfeld verwendet wird, muss die Eigenschaft useFixedInlineToolbar
auf true
gesetzt werden, um Probleme zu vermeiden.
Aktivieren von RTE-Funktionen durch Aktivieren von Plug-ins enable-rte-functionalities-by-activating-plug-ins
RTE-Funktionen werden über eine Reihe von Plug-ins mit jeweils einer Funktionseigenschaft bereitgestellt. Sie können die Funktionen so konfigurieren, dass die verschiedenen Funktionen der einzelnen Plug-ins aktiviert oder deaktiviert werden.
Ausführliche Konfigurationen des RTE-Plug-ins finden Sie unter Aktivieren und Konfigurieren von RTE-Plug-ins.
Die Text-Kernkomponente ermöglicht es den Bearbeitern von Vorlagen, viele RTE-Plug-ins in der Benutzeroberfläche als Content-Richtlinien zu konfigurieren, sodass keine technische Konfiguration mehr erforderlich ist. Content-Richtlinien können mit RTE-Benutzeroberflächenkonfigurationen verwendet werden, wie in diesem Dokument beschrieben ist. Weitere Informationen finden Sie in Erstellen von Seitenvorlagen und in der Entwickler-Dokumentation zu Kernkomponenten.
Zu Referenzzwecken finden Sie die standardmäßigen Textkomponenten (bereitgestellt im Rahmen einer Standardinstallation) unter:
/libs/wcm/foundation/components/text
/libs/foundation/components/text
Um eine eigene Textkomponente zu erstellen, kopieren Sie die oben stehende Komponente, anstatt diese Komponenten zu bearbeiten.
RTE-Symbolleiste konfigurieren dialogfullscreen
Mit Experience Manager können Sie die Benutzeroberfläche für den Rich-Text-Editor für die verschiedenen Bearbeitungsmodi unterschiedlich konfigurieren. Die Standardeinstellungen finden Sie unten. Sie können diese Standardwerte entsprechend Ihren Anforderungen überschreiben. Sie passen nur die Symbolleisteneigenschaften an, die Sie Ihren Autoren zur Verfügung stellen möchten. Sie brauchen nicht alle Symbolleistenkonfigurationen anzugeben.
Um die Symbolleiste für dialogFullScreen
zu konfigurieren, verwenden Sie die folgende Beispielkonfiguration.
<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>
Für den Inline-Modus und den Vollbildmodus werden verschiedene Benutzeroberflächeneinstellungen verwendet. Die Eigenschaft „toolbar“ gibt die Option der Symbolleiste an.
Wenn die Option selbst eine Funktion aufweist (z. B. Bold
), ist sie in folgender Form anzugeben: PluginName#FeatureName
(z. B. links#modifylink
).
Wenn es sich bei der Option um ein Popover handelt (sie also einige Funktionen eines Plug-ins aufweist), ist sie in folgender Form anzugeben: #PluginName
(z. B. #format
).
Trennzeichen (|
) zwischen einer Gruppe von Optionen können mit -
angegeben werden.
Der Knoten „pop-up“ im Inline- oder Vollbildmodus enthält eine Liste der verwendeten Popovers. Jeder untergeordnete Knoten unter dem Knoten popovers
wird nach dem Plug-in benannt (z. B. „format“). Er verfügt über eine Eigenschaft „items“, die eine Liste der Funktionen des Plug-ins beinhaltet (z. B. „format#bold“).
Einstellungen für die RTE-Benutzeroberfläche und Content-Richtlinien rtecontentpolicies
Administratoren können die RTE-Optionen mithilfe von Content-Richtlinien steuern, anstatt die Konfiguration wie oben beschrieben durchzuführen. Inhaltsrichtlinien definieren die Designeigenschaften einer Komponente, wenn sie als Teil einer bearbeitbaren Vorlage verwendet wird. Wenn zum Beispiel eine Textkomponente, die den RTE verwendet, mit einer bearbeitbaren Vorlage verwendet wird, kann die Content-Richtlinie definieren, dass die fettgedruckte Option und einige Absatzformatierungsoptionen verfügbar sind. Inhaltsrichtlinien sind wiederverwendbar und können auf mehrere Vorlagen angewendet werden.
Die verfügbaren Optionen im RTE werden von der Benutzeroberflächenkonfiguration abwärts zu den Content-Richtlinien übertragen.
- Die Benutzeroberflächen-Konfigurationseinstellungen definieren, welche Optionen für die Content-Richtlinien verfügbar sind.
- Wenn die Benutzeroberflächen-Konfiguration des RTE entfernt oder ein Element nicht aktiviert wird, kann die Inhaltsrichtlinie sie nicht konfigurieren.
- Ein Autor hat nur auf die Funktionen Zugriff, die durch die Benutzeroberflächen-Konfigurationen und Content-Richtlinien zur Verfügung gestellt werden.
Beispielsweise können Sie die Dokumentation zur Text-Kernkomponente sehen.
Anpassen der Zuordnung zwischen Symbolleistenelementen und Befehlen iconstoolbar
Sie können die Zuordnung zwischen in der RTE-Symbolleiste angezeigten Coral-Symbolen und den verfügbaren Befehlen anpassen. Sie können keine anderen Symbole als Coral-Symbole verwenden.
-
Erstellen Sie einen Knoten namens
icons
unteruiSettings/cui
. -
Erstellen Sie Knoten für die einzelnen Symbole darunter.
-
Geben Sie in jedem Knoten ein Coral-Symbol sowie einen Befehl an, den Sie dem Symbol zuordnen möchten.
Unten finden Sie einen Beispielausschnitt zur Zuordnung des Befehls Bold
zum Coral-Symbol mit dem Namen 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>
Bekannte Einschränkungen known-limitations
Experience ManagerFür die RTE-Funktion gelten folgende Einschränkungen:
-
RTE-Funktionen werden nur in Komponenten-Dialogfeldern von Experience Manager unterstützt. RTE wird nicht in Assistenten oder Foundation-Formularen unterstützt.
-
Experience Manager funktioniert nicht auf Hybrid-Geräten.
-
Benennen Sie den RTE-Konfigurationsknoten nicht mit
config
. Andernfalls treten die RTE-Konfigurationen nur für die Administratoren und nicht für die Benutzer in der Gruppecontent-author
in Kraft. -
RTE unterstützt nicht das Einbetten von Inhalten in Inline-Frames oder iFrames.
Best Practices und Tipps best-practices-and-tips
- Aktivieren Sie für unverankerte Dialogfelder nur Plug-ins ohne Popup-Fenster. Plug-ins ohne Popup-Fenster sind kleiner und eignen sich am besten für unverankerte Dialogfelder.
- Aktivieren Sie die Plug-ins mit einem größeren Popup-Fenster, beispielsweise das
Paste
-Plug-in, nur im Vollbildschirm-Dialogfeldmodus oder im Vollbildmodus. Plug-ins mit einem größeren Popup-Fenster beanspruchen mehr Platz auf dem Bildschirm, um ein gutes Authoring-Erlebnis zu ermöglichen. - Wenn Sie benutzerdefinierte Plug-ins für den RTE von CoralUI3 nutzen, verwenden Sie die Bibliothek
rte.coralui3
.